fileOperations that performs all file operations on the master processor. Requires the calls to be parallel synchronised! More...

Inheritance diagram for masterUncollatedFileOperation:

[legend]

Collaboration diagram for masterUncollatedFileOperation:

[legend]

Classes
class	chModOp

class	cpOp

class	existsOp

class	fileOrNullOp

class	fileSizeOp

class	highResLastModifiedOp

class	isDirOp

class	isFileOp

class	lastModifiedOp

class	lnOp

class	mkDirOp

class	modeOp

class	mvBakOp

class	mvOp

class	readDirOp

class	rmDirOp

class	rmOp

class	typeOp

Public Member Functions
	TypeName ("masterUncollated")
	Runtime type information. More...

	masterUncollatedFileOperation (bool verbose=false)
	Default construct. More...

	masterUncollatedFileOperation (const Tuple2< label, labelList > &commAndIORanks, const bool distributedRoots, bool verbose=false)
	Construct from communicator with specified io-ranks. More...

virtual	~masterUncollatedFileOperation ()
	Destructor. More...

virtual void	storeComm () const
	Transfer ownership of communicator to this fileOperation. Use with caution. More...

virtual bool	mkDir (const fileName &, mode_t=0777) const
	Make directory. More...

virtual bool	chMod (const fileName &, const mode_t) const
	Set the file mode. More...

virtual mode_t	mode (const fileName &, const bool followLink=true) const
	Return the file mode. More...

virtual fileName::Type	type (const fileName &, const bool followLink=true) const
	Return the file type: DIRECTORY, FILE or SYMLINK. More...

virtual bool	exists (const fileName &, const bool checkGzip=true, const bool followLink=true) const
	Does the name exist (as DIRECTORY or FILE) in the file system? More...

virtual bool	isDir (const fileName &, const bool followLink=true) const
	Does the name exist as a DIRECTORY in the file system? More...

virtual bool	isFile (const fileName &, const bool checkGzip=true, const bool followLink=true) const
	Does the name exist as a FILE in the file system? More...

virtual off_t	fileSize (const fileName &, const bool followLink=true) const
	Return size of file. More...

virtual time_t	lastModified (const fileName &, const bool followLink=true) const
	Return time of last file modification. More...

virtual double	highResLastModified (const fileName &, const bool followLink=true) const
	Return time of last file modification. More...

virtual fileNameList	readDir (const fileName &, const fileName::Type=fileName::FILE, const bool filtergz=true, const bool followLink=true) const
	Read a directory and return the entries as a string list. More...

virtual bool	cp (const fileName &src, const fileName &dst, const bool followLink=true) const
	Copy, recursively if necessary, the source to the destination. More...

virtual bool	ln (const fileName &src, const fileName &dst) const
	Create a softlink. dst should not exist. Returns true if. More...

virtual bool	mv (const fileName &src, const fileName &dst, const bool followLink=false) const
	Rename src to dst. More...

virtual bool	mvBak (const fileName &, const std::string &ext="bak") const
	Rename to a corresponding backup file. More...

virtual bool	rm (const fileName &) const
	Remove a file, returning true if successful otherwise false. More...

virtual bool	rmDir (const fileName &dir, const bool silent=false, const bool emptyOnly=false) const
	Remove a directory and its contents. More...

virtual fileName	filePath (const bool checkGlobal, const IOobject &io, const word &typeName, const bool search) const
	Search for an object. checkGlobal : also check undecomposed case. More...

virtual fileName	dirPath (const bool checkGlobal, const IOobject &io, const bool search) const
	Search for a directory. checkGlobal : also check undecomposed. More...

virtual fileNameList	readObjects (const objectRegistry &db, const fileName &instance, const fileName &local, word &newInstance) const
	Search directory for objects. Used in IOobjectList. More...

virtual bool	readHeader (IOobject &, const fileName &, const word &typeName) const
	Read object header from supplied file. More...

virtual autoPtr< ISstream >	readStream (regIOobject &, const fileName &, const word &typeName, const bool readOnProc=true) const
	Reads header for regIOobject and returns an ISstream to read the contents. More...

virtual bool	read (regIOobject &, const bool masterOnly, const IOstreamOption::streamFormat format, const word &typeName) const
	Top-level read. More...

virtual bool	writeObject (const regIOobject &io, IOstreamOption streamOpt=IOstreamOption(), const bool writeOnProc=true) const
	Writes a regIOobject (so header, contents and divider). More...

virtual autoPtr< ISstream >	NewIFstream (const fileName &) const
	Generate an ISstream that reads a file. More...

virtual autoPtr< OSstream >	NewOFstream (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), const bool writeOnProc=true) const
	Generate an OSstream that writes a file. More...

virtual autoPtr< OSstream >	NewOFstream (IOstreamOption::atomicType atomic, const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), const bool writeOnProc=true) const
	Generate an OSstream that writes a file. More...

virtual label	addWatch (const fileName &) const
	Add watching of a file. Returns handle. More...

virtual bool	removeWatch (const label) const
	Remove watch on a file (using handle) More...

virtual label	findWatch (const labelList &watchIndices, const fileName &) const
	Find index (or -1) of file in list of handles. More...

virtual void	addWatches (regIOobject &, const fileNameList &) const
	Helper: add watches for list of regIOobjects. More...

virtual fileName	getFile (const label) const
	Get name of file being watched (using handle) More...

virtual void	updateStates (const bool masterOnly, const bool syncPar) const
	Update state of all files. More...

virtual fileMonitor::fileState	getState (const label) const
	Get current state of file (using handle) More...

virtual void	setUnmodified (const label) const
	Set current state of file (using handle) to unmodified. More...

virtual instantList	findTimes (const fileName &, const word &) const
	Get sorted list of times. More...

virtual IOobject	findInstance (const IOobject &io, const scalar startValue, const word &stopInstance) const
	Find instance where IOobject is. More...

virtual void	setTime (const Time &) const
	Callback for time change. More...

virtual void	flush () const
	Forcibly wait until all output done. Flush any cached data. More...

virtual void	sync ()
	Forcibly parallel sync. More...

const HashPtrTable< DynamicList< instant > > &	times () const noexcept
	Return cached times. More...

Public Member Functions inherited from fileOperation
	TypeName ("fileOperation")
	Runtime type information. More...

	fileOperation (const label comm, const labelUList &ioRanks=labelUList::null(), const bool distributedRoots=false)
	Construct from communicator, optionally with specified io-ranks and/or distributed roots. More...

	fileOperation (const Tuple2< label, labelList > &commAndIORanks, const bool distributedRoots=false)
	Construct from communicator with specified io-ranks. More...

	declareRunTimeSelectionTable (autoPtr, fileOperation, word,(bool verbose),(verbose))

	declareRunTimeSelectionTable (autoPtr, fileOperation, comm,(const Tuple2< label, labelList > &commAndIORanks, const bool distributedRoots, bool verbose),(commAndIORanks, distributedRoots, verbose))

virtual	~fileOperation ()=default
	Destructor. More...

label	comm () const noexcept
	Communicator to use. More...

label	comm (label communicator) const noexcept
	Set communicator to use [mutable]. Negative values are a no-op. More...

bool	distributed () const noexcept
	Distributed roots (parallel run) More...

bool	distributed (bool on) const noexcept
	Set distributed roots on/off [mutable]. More...

const labelList &	ioRanks () const noexcept
	The list of IO ranks (global ranks) More...

InfoProxy< fileOperation >	info () const noexcept
	Return info proxy, used to print information to a stream. More...

virtual bool	good () const
	True if the fileOperation can be considered valid. At the moment, primarily used to detect the dummy fileOperation. More...

virtual bool	broadcastCopy (const label comm, const bool writeOnProc, const fileName &src, const fileName &dst) const
	Read dir/file (recursively if necessary) on master of the communicator, send and write contents to all 'writeOnProc' processors with local file name. More...

virtual fileName	objectPath (const IOobject &io, const word &typeName) const
	Generate disk file name for object. Opposite of filePath. More...

virtual fileName	filePath (const fileName &, const bool checkGzip=true, const bool followLink=true) const
	Search for a file or directory. Use IOobject version in preference. More...

virtual word	processorsDir (const IOobject &io) const
	Actual name of processors dir (for use in mode PROCOBJECT, PROCINSTANCE) More...

virtual word	processorsDir (const fileName &) const
	Actual name of processors dir (for use in mode PROCOBJECT, PROCINSTANCE) More...

label	nProcs () const noexcept
	Overall number of processors, from UPstream::nProcs() or detected from directories/results. More...

label	nProcs (const label numProcs) noexcept
	Set number of processor directories/results. More...

virtual label	nProcs (const fileName &dir, const fileName &local="", const label wantedNProcs=0) const
	Get number of processor directories/results. More...

fileName	processorsCasePath (const IOobject &io, const word &procDir) const
	Generate path (like io.path) from root+casename with any. More...

fileName	processorsPath (const IOobject &io, const word &instance, const word &procDir) const
	Generate path (like io.path) with provided instance and any. More...

fileName	processorsPath (const fileName &, const word &procDir) const
	Operating on fileName: replace processorXXX with procDir. More...

label	setNProcs (label numProcs)
	Same as nProcs. More...

Static Public Attributes
static float	maxMasterFileBufferSize
	Max size of parallel communications. Switches from non-blocking. More...

Static Public Attributes inherited from fileOperation
static const Enum< pathType >	pathTypeNames_

static word	processorsBaseDir = "processors"
	Return the processors directory name (usually "processors") More...

static word	defaultFileHandler
	Name of the default fileHandler. More...

static refPtr< fileOperation >	fileHandlerPtr_
	The currently active file handler. Avoid accessing directly. More...

Protected Member Functions
template<class Type >
Type	scatterList (const UList< Type > &, const int, const label comm) const

template<class Type , class FileOp >
Type	masterOp (const fileName &fName, const FileOp &fop, const int tag, const label comm) const

template<class Type , class FileOp >
Type	masterOp (const fileName &src, const fileName &dest, const FileOp &fop, const int tag, const label comm) const

virtual fileName	filePathInfo (const bool checkGlobal, const bool isFile, const IOobject &io, const dirIndexList &pDirs, const bool search, pathType &searchType, word &processorsDir, word &instance) const
	Search (locally!) for object; return info on how it was found. More...

fileName	localObjectPath (const IOobject &, const pathType &searchType, const word &processorsDir, const word &instancePath) const
	Construct filePath. More...

bool	exists (const dirIndexList &, IOobject &io) const
	Helper: check IO for local existence. Like filePathInfo but. More...

Protected Member Functions inherited from fileOperation
fileMonitor &	monitor () const
	Get or create fileMonitor singleton. More...

refPtr< dirIndexList >	lookupAndCacheProcessorsPath (const fileName &objectPath, const bool syncPar) const
	Lookup name of processorsDDD using cache. More...

virtual refPtr< dirIndexList >	lookupProcessorsPath (const fileName &objectPath) const
	Lookup name of processorsDDD using cache. More...

bool	exists (IOobject &io) const
	Does IOobject exist? Is either a directory (empty name()) or a file. More...

bool	isIOrank (const label proci) const
	Is proci a master rank in the communicator (in parallel) or a master rank in the IO ranks (non-parallel) More...

void	printRanks () const
	Helper: output which ranks are IO. More...

Static Protected Member Functions
static word	findInstancePath (const instantList &timeDirs, const instant &t)
	Equivalent of Time::findInstance. More...

static void	readAndSend (const fileName &filePath, const labelUList &recvProcs, PstreamBuffers &pBufs)
	Read file contents and send to processors. More...

static autoPtr< ISstream >	read (IOobject &io, const label comm, const bool uniform, const fileNameList &filePaths, const boolUList &readOnProcs)
	Read files on comms master. More...

Static Protected Member Functions inherited from fileOperation
static void	mergeTimes (const instantList &extraTimes, const word &constantName, instantList &times)
	Merge two times. More...

static bool	isFileOrDir (const bool isFile, const fileName &)
	Helper: check for file (isFile) or directory (!isFile) More...

static label	getManagedComm (const label communicator)
	Construction helper: check for locally allocated communicator. More...

Protected Attributes
HashPtrTable< DynamicList< instant > >	times_
	Cached times for a given directory. More...

Protected Attributes inherited from fileOperation
label	comm_
	Communicator to use. More...

label	nProcs_
	Overall number of processors. More...

bool	distributed_
	Distributed roots (parallel run) More...

const labelList	ioRanks_
	The list of IO ranks (global ranks) More...

HashTable< dirIndexList >	procsDirs_
	Detected processors directories. More...

std::unique_ptr< fileMonitor >	monitorPtr_
	File-change monitor for all registered files. More...

Additional Inherited Members
Public Types inherited from fileOperation
enum	pathType : int { NOTFOUND = 0, ABSOLUTE, OBJECT, WRITEOBJECT, PROCUNCOLLATED, PROCBASEOBJECT = PROCUNCOLLATED + 1, PROCOBJECT = PROCBASEOBJECT + 1, PARENTOBJECT, FINDINSTANCE, PROCUNCOLLATEDINSTANCE, PROCBASEINSTANCE, PROCINSTANCE }
	Enumeration for the location of an IOobject. More...

typedef Tuple2< fileName, Tuple2< pathType, int > >	dirIndex
	Augment fileName with pathType and local offset. More...

typedef List< dirIndex >	dirIndexList

typedef IntRange< int >	procRangeType
	For addressing a range of processors, identical to UPstream::rangeType. More...

Static Public Member Functions inherited from fileOperation
static refPtr< fileOperation >	null ()
	Reference to a dummy file handler. More...

static autoPtr< fileOperation >	New (const word &handlerType, bool verbose=false)
	Select fileHandler-type. Uses defaultFileHandler if the handlerType is empty. More...

static autoPtr< fileOperation >	New (const word &handlerType, const Tuple2< label, labelList > &commAndIORanks, const bool distributedRoots, bool verbose=false)
	Select fileHandler-type. Uses defaultFileHandler if the handlerType is empty. More...

static autoPtr< fileOperation >	New (const fileOperation &origHandler, const boolUList &useProc, bool verbose=false)
	Replicate the given fileHandler properties with a subset of (global) ranks. More...

static autoPtr< fileOperation >	New (const fileOperation &origHandler, const bitSet &useProc, bool verbose=false)
	Replicate the given fileHandler properties with a subset of (global) ranks. More...

static autoPtr< fileOperation >	NewUncollated ()
	The commonly used uncollatedFileOperation. More...

static const fileOperation &	fileHandler ()
	Return the current file handler. Will create the default file handler if necessary. More...

static refPtr< fileOperation >	fileHandler (std::nullptr_t)
	Delete current file handler. More...

static refPtr< fileOperation >	fileHandler (refPtr< fileOperation > &newHandler)
	Replace the current file handler. More...

static refPtr< fileOperation >	fileHandler (refPtr< fileOperation > &&newHandler)
	Replace the current file handler. More...

static refPtr< fileOperation >	fileHandler (autoPtr< fileOperation > &&newHandler)
	Replace the current file handler. More...

static int	cacheLevel () noexcept
	Return cache level. More...

static int	cacheLevel (int level) noexcept
	Set cache level (0 = off). More...

static int	nProcsFilter () noexcept
	Return collated 'processorsDDD' filtering. More...

static int	nProcsFilter (int level) noexcept
	Set collated 'processorsDDD' filtering (0 = off). More...

static instantList	sortTimes (const fileNameList &dirEntries, const word &constantName="constant")
	Sort directory entries according to time value,. More...

static bool	uniformFile (const fileNameList &names)
	True if the file names are identical. False on an empty list. More...

static bool	uniformFile (const label comm, const fileName &name)
	True if the file name is identical on all ranks. More...

static label	splitProcessorPath (const fileName &objectPath, fileName &path, fileName &procDir, fileName &local, procRangeType &group, label &nProcs)
	Split objectPath into part before 'processor' and part after. More...

static label	detectProcessorPath (const fileName &objPath)
	Detect processor number from '/aa/bb/processorDDD/cc'. More...

static labelRange	subRanks (const labelUList &mainIOranks)
	Get (contiguous) range/bounds of ranks addressed within the given main io-ranks. More...

static labelList	getGlobalHostIORanks ()
	Get list of global IO master ranks based on the hostname. It is assumed that each host range is contiguous. More...

static labelList	getGlobalIORanks ()
	Get list of global IO ranks from FOAM_IORANKS env variable. If set, these correspond to the IO master ranks. More...

Static Protected Attributes inherited from fileOperation
static int	cacheLevel_
	Cache level (eg, for caching time directories). Default: 1. More...

Detailed Description

fileOperations that performs all file operations on the master processor. Requires the calls to be parallel synchronised!

Limitations

no /processor in filename
no /uniform/ in the filename

The main logic is in ::filePath which returns a

same path on all processors. This can either be a global file (system/controlDict, processorXXX/0/uniform/) or a collated file (processors/0/p)
same path on all processors of the local communicator (processors4_0-1/0/p)
different path on all processors (processor0/0/p)

system/controlDict: filePath worldmaster: <globalRoot>/system/controlDict localmaster: ,, slave : ,,

processor0/uniform/time filePath worldmaster: <globalRoot>/processorXXX/uniform/time localmaster: ,, slave : ,,

processors0/0/p processors10/0/p processors10_2-4/0/p

Definition at line 78 of file masterUncollatedFileOperation.H.

Constructor & Destructor Documentation

◆ masterUncollatedFileOperation() [1/2]

masterUncollatedFileOperation ( bool verbose = false )

explicit

Default construct.

Definition at line 784 of file masterUncollatedFileOperation.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, UPstream::myProcNo(), and UPstream::nProcs().

Here is the call graph for this function:

◆ masterUncollatedFileOperation() [2/2]

masterUncollatedFileOperation	(	const Tuple2< label, labelList > &	commAndIORanks,
		const bool	distributedRoots,
		bool	verbose = `false`
	)

explicit

Construct from communicator with specified io-ranks.

Definition at line 817 of file masterUncollatedFileOperation.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, UPstream::myProcNo(), and UPstream::nProcs().

Here is the call graph for this function:

◆ ~masterUncollatedFileOperation()

~masterUncollatedFileOperation ( )

virtual

Destructor.

Definition at line 857 of file masterUncollatedFileOperation.C.

References UPstream::freeCommunicator().

Here is the call graph for this function:

Member Function Documentation

◆ scatterList()

Type scatterList	(	const UList< Type > &	allValues,
		const int	tag,
		const label	comm
	)		const

protected

Definition at line 29 of file masterUncollatedFileOperationTemplates.C.

References PstreamBuffers::finishedScatters(), and os().

Here is the call graph for this function:

◆ masterOp() [1/2]

Type masterOp	(	const fileName &	fName,
		const FileOp &	fop,
		const int	tag,
		const label	comm
	)		const

protected

Definition at line 64 of file masterUncollatedFileOperationTemplates.C.

References Foam::ensightOutput::debug, Foam::endl(), Foam::name(), Foam::Pout, and UList< T >::size().

Here is the call graph for this function:

◆ masterOp() [2/2]

Type masterOp	(	const fileName &	src,
		const fileName &	dest,
		const FileOp &	fop,
		const int	tag,
		const label	comm
	)		const

protected

Definition at line 107 of file masterUncollatedFileOperationTemplates.C.

References Foam::ensightOutput::debug, Foam::endl(), Foam::Pout, and UList< T >::size().

Here is the call graph for this function:

◆ findInstancePath()

Foam::word findInstancePath	(	const instantList &	timeDirs,
		const instant &	t
	)

staticprotected

Equivalent of Time::findInstance.

Definition at line 178 of file masterUncollatedFileOperation.C.

References Instant< T >::equal(), and forAllReverse.

Here is the call graph for this function:

◆ filePathInfo()

Foam::fileName filePathInfo	(	const bool	checkGlobal,
		const bool	isFile,
		const IOobject &	io,
		const dirIndexList &	pDirs,
		const bool	search,
		pathType &	searchType,
		word &	processorsDir,
		word &	instance
	)		const

protectedvirtual

Search (locally!) for object; return info on how it was found.

Does not do any parallel communication. checkGlobal : also check undecomposed case isFile : true:check for file false:check for directory searchType : how was found processorsDir : name of processor directory instance : instance

Definition at line 203 of file masterUncollatedFileOperation.C.

References io(), Foam::isFile(), and Foam::search().

Here is the call graph for this function:

◆ localObjectPath()

Foam::fileName localObjectPath	(	const IOobject &	io,
		const pathType &	searchType,
		const word &	processorsDir,
		const word &	instancePath
	)		const

protected

Construct filePath.

Definition at line 375 of file masterUncollatedFileOperation.C.

References io(), Foam::name(), and NotImplemented.

Referenced by collatedFileOperation::objectPath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readAndSend()

void readAndSend	(	const fileName &	filePath,
		const labelUList &	recvProcs,
		PstreamBuffers &	pBufs
	)

staticprotected

Read file contents and send to processors.

Handles compressed or uncompressed files

Definition at line 517 of file masterUncollatedFileOperation.C.

References UList< T >::cdata_bytes(), IOstreamOption::compression(), Foam::ensightOutput::debug, UList< T >::empty(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, IOstream::good(), Foam::Info, os(), UList< T >::size(), UList< T >::size_bytes(), and Foam::slurpFile().

Here is the call graph for this function:

◆ read() [1/2]

Foam::autoPtr< Foam::ISstream > read	(	IOobject &	io,
		const label	comm,
		const bool	uniform,
		const fileNameList &	filePaths,
		const boolUList &	readOnProcs
	)

staticprotected

Read files on comms master.

Definition at line 563 of file masterUncollatedFileOperation.C.

References Foam::ensightOutput::debug, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, PstreamBuffers::finishedScatters(), io(), Foam::Pout, DynamicList< T, SizeMin >::push_back(), UIPstream::read(), PstreamBuffers::recvDataCount(), and autoPtr< T >::reset().

Here is the call graph for this function:

◆ exists() [1/2]

bool exists	(	const dirIndexList &	pDirs,
		IOobject &	io
	)		const

protected

Helper: check IO for local existence. Like filePathInfo but.

without parent searchign and instance searching

Definition at line 1468 of file masterUncollatedFileOperation.C.

References io(), Foam::isFile(), and word::null.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "masterUncollated" )

Runtime type information.

◆ storeComm()

void storeComm ( ) const

virtual

Transfer ownership of communicator to this fileOperation. Use with caution.

Implements fileOperation.

Reimplemented in collatedFileOperation, hostCollatedFileOperation, and hostUncollatedFileOperation.

Definition at line 847 of file masterUncollatedFileOperation.C.

◆ mkDir()

bool mkDir	(	const fileName &	dir,
		mode_t	mode = `0777`
	)		const

virtual

Make directory.

Implements fileOperation.

Definition at line 866 of file masterUncollatedFileOperation.C.

References Foam::mode(), and UPstream::msgType().

Here is the call graph for this function:

◆ chMod()

bool chMod	(	const fileName &	fName,
		const mode_t	mode
	)		const

virtual

Set the file mode.

Implements fileOperation.

Definition at line 882 of file masterUncollatedFileOperation.C.

References Foam::mode(), and UPstream::msgType().

Here is the call graph for this function:

◆ mode()

mode_t mode	(	const fileName &	fName,
		const bool	followLink = `true`
	)		const

virtual

Return the file mode.

Implements fileOperation.

Definition at line 898 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

Here is the call graph for this function:

◆ type()

Foam::fileName::Type type	(	const fileName &	fName,
		const bool	followLink = `true`
	)		const

virtual

Return the file type: DIRECTORY, FILE or SYMLINK.

Implements fileOperation.

Definition at line 914 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

Here is the call graph for this function:

◆ exists() [2/2]

bool exists	(	const fileName &	fName,
		const bool	checkGzip = `true`,
		const bool	followLink = `true`
	)		const

virtual

Does the name exist (as DIRECTORY or FILE) in the file system?

Optionally enable/disable check for gzip file.

Implements fileOperation.

Definition at line 933 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

Here is the call graph for this function:

◆ isDir()

bool isDir	(	const fileName &	fName,
		const bool	followLink = `true`
	)		const

virtual

Does the name exist as a DIRECTORY in the file system?

Implements fileOperation.

Definition at line 950 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

Here is the call graph for this function:

◆ isFile()

bool isFile	(	const fileName &	fName,
		const bool	checkGzip = `true`,
		const bool	followLink = `true`
	)		const

virtual

Does the name exist as a FILE in the file system?

Optionally enable/disable check for gzip file.

Implements fileOperation.

Definition at line 966 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

Here is the call graph for this function:

◆ fileSize()

off_t fileSize	(	const fileName &	fName,
		const bool	followLink = `true`
	)		const

virtual

Return size of file.

Implements fileOperation.

Definition at line 983 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

Here is the call graph for this function:

◆ lastModified()

time_t lastModified	(	const fileName &	fName,
		const bool	followLink = `true`
	)		const

virtual

Return time of last file modification.

Implements fileOperation.

Definition at line 999 of file masterUncollatedFileOperation.C.

References UPstream::msgType(), and UPstream::worldComm.

Here is the call graph for this function:

◆ highResLastModified()

double highResLastModified	(	const fileName &	fName,
		const bool	followLink = `true`
	)		const

virtual

Return time of last file modification.

Implements fileOperation.

Definition at line 1015 of file masterUncollatedFileOperation.C.

References UPstream::msgType(), and UPstream::worldComm.

Here is the call graph for this function:

◆ readDir()

Foam::fileNameList readDir	(	const fileName &	dir,
		const fileName::Type	type = `fileName::FILE`,
		const bool	filtergz = `true`,
		const bool	followLink = `true`
	)		const

virtual

Read a directory and return the entries as a string list.

Implements fileOperation.

Definition at line 1079 of file masterUncollatedFileOperation.C.

References UPstream::msgType(), and Foam::type().

Here is the call graph for this function:

◆ cp()

bool cp	(	const fileName &	src,
		const fileName &	dst,
		const bool	followLink = `true`
	)		const

virtual

Copy, recursively if necessary, the source to the destination.

Implements fileOperation.

Definition at line 1097 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

Here is the call graph for this function:

◆ ln()

bool ln	(	const fileName &	src,
		const fileName &	dst
	)		const

virtual

Create a softlink. dst should not exist. Returns true if.

successful.

Implements fileOperation.

Definition at line 1115 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

Here is the call graph for this function:

◆ mv()

bool mv	(	const fileName &	src,
		const fileName &	dst,
		const bool	followLink = `false`
	)		const

virtual

Rename src to dst.

Implements fileOperation.

Definition at line 1132 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

Here is the call graph for this function:

◆ mvBak()

bool mvBak	(	const fileName &	fName,
		const std::string &	ext = `"bak"`
	)		const

virtual

Rename to a corresponding backup file.

If the backup file already exists, attempt with "01" .. "99" suffix

Implements fileOperation.

Definition at line 1031 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

Here is the call graph for this function:

◆ rm()

bool rm ( const fileName & fName ) const

virtual

Remove a file, returning true if successful otherwise false.

Implements fileOperation.

Definition at line 1047 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

Here is the call graph for this function:

◆ rmDir()

bool rmDir	(	const fileName &	dir,
		const bool	silent = `false`,
		const bool	emptyOnly = `false`
	)		const

virtual

Remove a directory and its contents.

Parameters

dir	the directory to remove
silent	do not report missing directory
emptyOnly	only remove empty directories (recursive)

Implements fileOperation.

Definition at line 1062 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

Here is the call graph for this function:

◆ filePath()

Foam::fileName filePath	(	const bool	checkGlobal,
		const IOobject &	io,
		const word &	typeName,
		const bool	search
	)		const

virtual

Search for an object. checkGlobal : also check undecomposed case.

Implements fileOperation.

Definition at line 1152 of file masterUncollatedFileOperation.C.

References fileOperation::ABSOLUTE, Pstream::broadcast(), Pstream::broadcasts(), fileOperation::cacheLevel(), Foam::ensightOutput::debug, Foam::endl(), fileOperation::FINDINSTANCE, io(), UPstream::master(), UPstream::msgType(), fileOperation::NOTFOUND, fileOperation::nProcs(), fileOperation::OBJECT, fileOperation::PARENTOBJECT, UPstream::parRun(), fileOperation::pathTypeNames_, Foam::Pout, fileOperation::PROCBASEINSTANCE, fileOperation::PROCBASEOBJECT, fileOperation::PROCINSTANCE, fileOperation::PROCOBJECT, fileOperation::PROCUNCOLLATED, fileOperation::PROCUNCOLLATEDINSTANCE, Foam::search(), UPstream::worldComm, and fileOperation::WRITEOBJECT.

Here is the call graph for this function:

◆ dirPath()

Foam::fileName dirPath	(	const bool	checkGlobal,
		const IOobject &	io,
		const bool	search
	)		const

virtual

Search for a directory. checkGlobal : also check undecomposed.

case

Implements fileOperation.

Definition at line 1310 of file masterUncollatedFileOperation.C.

References fileOperation::ABSOLUTE, Pstream::broadcast(), Pstream::broadcasts(), fileOperation::cacheLevel(), Foam::ensightOutput::debug, Foam::endl(), fileOperation::FINDINSTANCE, io(), UPstream::master(), UPstream::msgType(), fileOperation::NOTFOUND, fileOperation::nProcs(), fileOperation::OBJECT, fileOperation::PARENTOBJECT, UPstream::parRun(), fileOperation::pathTypeNames_, Foam::Pout, fileOperation::PROCBASEINSTANCE, fileOperation::PROCBASEOBJECT, fileOperation::PROCINSTANCE, fileOperation::PROCOBJECT, fileOperation::PROCUNCOLLATED, fileOperation::PROCUNCOLLATEDINSTANCE, Foam::search(), UPstream::worldComm, and fileOperation::WRITEOBJECT.

Here is the call graph for this function:

◆ readObjects()

Foam::fileNameList readObjects	(	const objectRegistry &	db,
		const fileName &	instance,
		const fileName &	local,
		word &	newInstance
	)		const

virtual

Search directory for objects. Used in IOobjectList.

Use non-time searching version

Reimplemented from fileOperation.

Definition at line 1753 of file masterUncollatedFileOperation.C.

References Pstream::broadcasts(), fileOperation::cacheLevel(), TimePaths::constant(), Foam::ensightOutput::debug, Foam::endl(), Instant< T >::equal(), fileOperation::findTimes(), forAllReverse, local, UPstream::master(), Foam::name(), fileOperation::nProcs(), IOobject::objectPath(), UPstream::parRun(), Time::path(), Foam::Pout, fileOperation::readObjects(), objectRegistry::time(), and UPstream::worldComm.

Here is the call graph for this function:

◆ readHeader()

bool readHeader	(	IOobject &	io,
		const fileName &	fName,
		const word &	typeName
	)		const

virtual

Read object header from supplied file.

Implements fileOperation.

Definition at line 1844 of file masterUncollatedFileOperation.C.

References Pstream::broadcast(), Pstream::broadcasts(), Foam::ensightOutput::debug, Foam::endl(), PstreamBuffers::finishedScatters(), forAll, Pstream::gatherList(), IOstream::good(), io(), UPstream::master(), UPstream::masterNo(), UPstream::msgType(), UPstream::myProcNo(), UPstream::nonBlocking, UPstream::nProcs(), os(), Foam::Pout, decomposedBlockData::readHeader(), List< T >::resize(), PstreamBuffers::subProcs(), fileOperation::uniformFile(), and UPstream::worldComm.

Here is the call graph for this function:

◆ readStream()

Foam::autoPtr< Foam::ISstream > readStream	(	regIOobject &	io,
		const fileName &	fName,
		const word &	typeName,
		const bool	readOnProc = `true`
	)		const

virtual

Reads header for regIOobject and returns an ISstream to read the contents.

Implements fileOperation.

Definition at line 1989 of file masterUncollatedFileOperation.C.

References Pstream::broadcast(), autoPtr< T >::clear(), Foam::ensightOutput::debug, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::fileSize(), Foam::flatOutput(), Pstream::gatherList(), autoPtr< T >::good(), Foam::constant::atomic::group, io(), decomposedBlockData::isCollatedType(), local, UPstream::master(), UPstream::msgType(), UPstream::myProcNo(), UPstream::nonBlocking, UPstream::nProcs(), UPstream::parRun(), path(), Foam::Pout, Foam::read(), decomposedBlockData::readBlock(), decomposedBlockData::readBlocks(), IOobject::readHeader(), UPstream::reduceOr(), autoPtr< T >::reset(), List< T >::resize(), UPstream::scheduled, fileOperation::uniformFile(), and UPstream::worldComm.

Here is the call graph for this function:

◆ read() [2/2]

bool read	(	regIOobject &	io,
		const bool	masterOnly,
		const IOstreamOption::streamFormat	format,
		const word &	typeName
	)		const

virtual

Top-level read.

Implements fileOperation.

Definition at line 2246 of file masterUncollatedFileOperation.C.

References Pstream::broadcasts(), fileOperation::cacheLevel(), Foam::ensightOutput::debug, Foam::endl(), format(), io(), UPstream::master(), UPstream::masterNo(), UPstream::myProcNo(), fileOperation::nProcs(), UPstream::parRun(), Foam::Pout, and UPstream::worldComm.

Here is the call graph for this function:

◆ writeObject()

bool writeObject	(	const regIOobject &	io,
		IOstreamOption	streamOpt = `IOstreamOption()`,
		const bool	writeOnProc = `true`
	)		const

virtual

Writes a regIOobject (so header, contents and divider).

Returns success state.

Reimplemented from fileOperation.

Reimplemented in collatedFileOperation.

Definition at line 2344 of file masterUncollatedFileOperation.C.

References Foam::ensightOutput::debug, Foam::endl(), io(), os(), Foam::Pout, setTime(), and IOobject::writeEndDivider().

Here is the call graph for this function:

◆ NewIFstream()

Foam::autoPtr< Foam::ISstream > NewIFstream ( const fileName & filePath ) const

virtual

Generate an ISstream that reads a file.

Implements fileOperation.

Definition at line 2514 of file masterUncollatedFileOperation.C.

References Foam::ensightOutput::debug, Foam::endl(), PstreamBuffers::finishedSends(), Pstream::gatherList(), Foam::identity(), UPstream::master(), UPstream::masterNo(), UPstream::msgType(), UPstream::myProcNo(), UPstream::nonBlocking, UPstream::nProcs(), UPstream::parRun(), Foam::Pout, UIPstream::read(), PstreamBuffers::recvDataCount(), autoPtr< T >::reset(), UPstream::subProcs(), and fileOperation::uniformFile().

Here is the call graph for this function:

◆ NewOFstream() [1/2]

Foam::autoPtr< Foam::OSstream > NewOFstream	(	const fileName &	pathname,
		IOstreamOption	streamOpt = `IOstreamOption()`,
		const bool	writeOnProc = `true`
	)		const

virtual

Generate an OSstream that writes a file.

Implements fileOperation.

Definition at line 2625 of file masterUncollatedFileOperation.C.

References IOstreamOption::NON_APPEND.

◆ NewOFstream() [2/2]

Foam::autoPtr< Foam::OSstream > NewOFstream	(	IOstreamOption::atomicType	atomic,
		const fileName &	pathname,
		IOstreamOption	streamOpt = `IOstreamOption()`,
		const bool	writeOnProc = `true`
	)		const

virtual

Generate an OSstream that writes a file.

Implements fileOperation.

Definition at line 2647 of file masterUncollatedFileOperation.C.

References IOstreamOption::NON_APPEND.

◆ addWatch()

Foam::label addWatch ( const fileName & fName ) const

virtual

Add watching of a file. Returns handle.

Reimplemented from fileOperation.

Definition at line 2752 of file masterUncollatedFileOperation.C.

References Pstream::broadcast(), UPstream::master(), UPstream::parRun(), and UPstream::worldComm.

Here is the call graph for this function:

◆ removeWatch()

bool removeWatch ( const label watchIndex ) const

virtual

Remove watch on a file (using handle)

Reimplemented from fileOperation.

Definition at line 2768 of file masterUncollatedFileOperation.C.

References Pstream::broadcast(), UPstream::master(), UPstream::parRun(), and UPstream::worldComm.

Here is the call graph for this function:

◆ findWatch()

Foam::label findWatch	(	const labelList &	watchIndices,
		const fileName &	fName
	)		const

virtual

Find index (or -1) of file in list of handles.

Reimplemented from fileOperation.

Definition at line 2784 of file masterUncollatedFileOperation.C.

References Pstream::broadcast(), forAll, UPstream::master(), UPstream::parRun(), and UPstream::worldComm.

Here is the call graph for this function:

◆ addWatches()

void addWatches	(	regIOobject &	rio,
		const fileNameList &	files
	)		const

virtual

Helper: add watches for list of regIOobjects.

Reimplemented from fileOperation.

Definition at line 2809 of file masterUncollatedFileOperation.C.

References Pstream::broadcast(), fileOperation::cacheLevel(), HashTable< T, Key, Hash >::erase(), f(), UPstream::master(), fileOperation::nProcs(), UPstream::parRun(), DynamicList< T, SizeMin >::push_back(), and regIOobject::watchIndices().

Here is the call graph for this function:

◆ getFile()

Foam::fileName getFile ( const label watchIndex ) const

virtual

Get name of file being watched (using handle)

Reimplemented from fileOperation.

Definition at line 2862 of file masterUncollatedFileOperation.C.

References Pstream::broadcast(), UPstream::master(), UPstream::parRun(), and UPstream::worldComm.

Here is the call graph for this function:

◆ updateStates()

void updateStates	(	const bool	masterOnly,
		const bool	syncPar
	)		const

virtual

Update state of all files.

Reimplemented from fileOperation.

Definition at line 2878 of file masterUncollatedFileOperation.C.

References UPstream::master(), UPstream::parRun(), and UPstream::worldComm.

Here is the call graph for this function:

◆ getState()

Foam::fileMonitor::fileState getState ( const label watchFd ) const

virtual

Get current state of file (using handle)

Reimplemented from fileOperation.

Definition at line 2892 of file masterUncollatedFileOperation.C.

References Pstream::broadcast(), UPstream::master(), UPstream::parRun(), fileMonitor::UNMODIFIED, and UPstream::worldComm.

Here is the call graph for this function:

◆ setUnmodified()

void setUnmodified ( const label watchFd ) const

virtual

Set current state of file (using handle) to unmodified.

Reimplemented from fileOperation.

Definition at line 2908 of file masterUncollatedFileOperation.C.

References UPstream::master(), UPstream::parRun(), and UPstream::worldComm.

Here is the call graph for this function:

◆ findTimes()

Foam::instantList findTimes	(	const fileName &	directory,
		const word &	constantName
	)		const

virtual

Get sorted list of times.

Reimplemented from fileOperation.

Definition at line 2386 of file masterUncollatedFileOperation.C.

References Pstream::broadcast(), fileOperation::cacheLevel(), Foam::ensightOutput::debug, Foam::endl(), fileOperation::findTimes(), Foam::flatOutput(), UPstream::master(), Foam::nl, fileOperation::nProcs(), UPstream::parRun(), Foam::Pout, List< T >::set(), and UPstream::worldComm.

Here is the call graph for this function:

◆ findInstance()

Foam::IOobject findInstance	(	const IOobject &	io,
		const scalar	startValue,
		const word &	stopInstance
	)		const

virtual

Find instance where IOobject is.

FatalError if it cannot be found and readOpt is (MUST_READ or MUST_READ_IF_MODIFIED). Otherwise it returns the stopInstance.

Reimplemented from fileOperation.

Definition at line 1517 of file masterUncollatedFileOperation.C.

References Pstream::broadcast(), fileOperation::cacheLevel(), TimePaths::constant(), Foam::ensightOutput::debug, UList< T >::empty(), Foam::endl(), Foam::exists(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::instance(), io(), IOobjectOption::isReadRequired(), IOobject::local(), UPstream::master(), Foam::name(), IOobject::name(), fileOperation::nProcs(), UPstream::parRun(), Foam::Pout, UList< T >::size(), IOobject::time(), Time::timeName(), TimePaths::times(), and UPstream::worldComm.

Here is the call graph for this function:

◆ setTime()

void setTime ( const Time & tm ) const

virtual

Callback for time change.

Reimplemented from fileOperation.

Definition at line 2446 of file masterUncollatedFileOperation.C.

References DynamicList< T, SizeMin >::append(), TimePaths::constant(), Foam::ensightOutput::debug, UList< T >::empty(), Foam::endl(), Foam::findSortedIndex(), UList< T >::last(), Time::path(), Foam::Pout, fileOperation::setTime(), UList< T >::size(), Foam::stableSort(), Time::subCycling(), Time::timeName(), and dimensioned< Type >::value().

Here is the call graph for this function:

◆ flush()

void flush ( ) const

virtual

Forcibly wait until all output done. Flush any cached data.

Reimplemented from fileOperation.

Reimplemented in collatedFileOperation.

Definition at line 2669 of file masterUncollatedFileOperation.C.

References fileOperation::flush().

Referenced by collatedFileOperation::flush().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sync()

void sync ( )

virtual

Forcibly parallel sync.

Reimplemented from fileOperation.

Definition at line 2676 of file masterUncollatedFileOperation.C.

References Pstream::broadcasts(), Foam::ensightOutput::debug, Foam::endl(), forAll, forAllConstIters(), Foam::constant::atomic::group, local, UPstream::master(), UPstream::myProcNo(), Foam::name(), Foam::New(), UPstream::parRun(), path(), Foam::Pout, List< T >::resize(), fileOperation::sync(), and UPstream::worldComm.

Here is the call graph for this function:

◆ times()

const HashPtrTable<DynamicList<instant> >& times ( ) const

inlinenoexcept

Return cached times.

Definition at line 898 of file masterUncollatedFileOperation.H.

References masterUncollatedFileOperation::times_.

Member Data Documentation

◆ times_

HashPtrTable<DynamicList<instant> > times_

mutableprotected

Cached times for a given directory.

Definition at line 105 of file masterUncollatedFileOperation.H.

Referenced by masterUncollatedFileOperation::times().

◆ maxMasterFileBufferSize

float maxMasterFileBufferSize

static

Max size of parallel communications. Switches from non-blocking.

to scheduled when reading/writing files. Read as float to enable easy specification of large sizes.

Definition at line 504 of file masterUncollatedFileOperation.H.

The documentation for this class was generated from the following files:

src/OpenFOAM/global/fileOperations/masterUncollatedFileOperation/masterUncollatedFileOperation.H
src/OpenFOAM/global/fileOperations/masterUncollatedFileOperation/masterUncollatedFileOperation.C
src/OpenFOAM/global/fileOperations/masterUncollatedFileOperation/masterUncollatedFileOperationTemplates.C

Classes

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ masterUncollatedFileOperation() [1/2]

◆ masterUncollatedFileOperation() [2/2]

◆ ~masterUncollatedFileOperation()

Member Function Documentation

◆ scatterList()

◆ masterOp() [1/2]

◆ masterOp() [2/2]

◆ findInstancePath()

◆ filePathInfo()

◆ localObjectPath()

◆ readAndSend()

◆ read() [1/2]

◆ exists() [1/2]

◆ TypeName()

◆ storeComm()

◆ mkDir()

◆ chMod()

◆ mode()

◆ type()

◆ exists() [2/2]

◆ isDir()

◆ isFile()

◆ fileSize()

◆ lastModified()

◆ highResLastModified()

◆ readDir()

◆ cp()

◆ ln()

◆ mv()

◆ mvBak()

◆ rm()

◆ rmDir()

◆ filePath()

◆ dirPath()

◆ readObjects()

◆ readHeader()

◆ readStream()

◆ read() [2/2]

◆ writeObject()

◆ NewIFstream()

◆ NewOFstream() [1/2]

◆ NewOFstream() [2/2]

◆ addWatch()

◆ removeWatch()

◆ findWatch()

◆ addWatches()

◆ getFile()

◆ updateStates()

◆ getState()

◆ setUnmodified()

◆ findTimes()

◆ findInstance()

◆ setTime()

◆ flush()

◆ sync()

◆ times()

Member Data Documentation

◆ times_

◆ maxMasterFileBufferSize