collatedFileOperation Class Reference

Version of masterUncollatedFileOperation that collates regIOobjects into a container in the processors/ subdirectory. More...

Inheritance diagram for collatedFileOperation:
[legend]
Collaboration diagram for collatedFileOperation:
[legend]

Public Member Functions

 TypeName ("collated")
 Runtime type information. More...
 
 collatedFileOperation (bool verbose)
 Construct null. More...
 
 collatedFileOperation (const label comm, const labelList &ioRanks, const word &typeName, bool verbose)
 Construct from user communicator. More...
 
virtual ~collatedFileOperation ()
 Destructor. More...
 
virtual fileName objectPath (const IOobject &io, const word &typeName) const
 Generate disk file name for object. Opposite of filePath. More...
 
virtual bool writeObject (const regIOobject &, IOstreamOption streamOpt=IOstreamOption(), const bool valid=true) const
 Writes a regIOobject (so header, contents and divider). More...
 
virtual void flush () const
 Forcibly wait until all output done. Flush any cached data. More...
 
virtual word processorsDir (const IOobject &) const
 Actual name of processors dir. More...
 
virtual word processorsDir (const fileName &) const
 Actual name of processors dir. More...
 
virtual void setNProcs (const label nProcs)
 Set number of processor directories/results. Only used in. More...
 
- Public Member Functions inherited from masterUncollatedFileOperation
 TypeName ("masterUncollated")
 Runtime type information. More...
 
 masterUncollatedFileOperation (bool verbose)
 Construct null. More...
 
 masterUncollatedFileOperation (const label comm, bool verbose)
 Construct from communicator. More...
 
virtual ~masterUncollatedFileOperation ()
 Destructor. 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 LINK. 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
 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< ISstreamreadStream (regIOobject &, const fileName &, const word &typeName, const bool valid=true) const
 Reads header for regIOobject and returns an ISstream. More...
 
virtual bool read (regIOobject &, const bool masterOnly, const IOstream::streamFormat format, const word &typeName) const
 Top-level read. More...
 
virtual autoPtr< ISstreamNewIFstream (const fileName &) const
 Generate an ISstream that reads a file. More...
 
virtual autoPtr< OSstreamNewOFstream (const fileName &pathname, IOstreamOption streamOpt=IOstreamOption(), const bool valid=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. Fails if cannot be found. More...
 
virtual void setTime (const Time &) const
 Callback for time change. More...
 
const HashPtrTable< instantList > & times () const
 Return cached times. More...
 
- Public Member Functions inherited from fileOperation
 TypeName ("fileOperation")
 Runtime type information. More...
 
 fileOperation (const label comm)
 Construct from communicator. More...
 
 declareRunTimeSelectionTable (autoPtr, fileOperation, word,(bool verbose),(verbose))
 
virtual ~fileOperation ()=default
 Destructor. More...
 
virtual fileName filePath (const fileName &) const
 Search for a file or directory. Use IOobject version in. More...
 
virtual label nProcs (const fileName &dir, const fileName &local="") const
 Get number of processor directories/results. Used for e.g. More...
 
fileName processorsCasePath (const IOobject &, const word &procDir) const
 Generate path (like io.path) from root+casename with any. More...
 
fileName processorsPath (const IOobject &, 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...
 

Static Public Attributes

static float maxThreadFileBufferSize
 Max size of thread buffer size. This is the overall size of. More...
 
- Static Public Attributes inherited from masterUncollatedFileOperation
static float maxMasterFileBufferSize
 Max size of parallel communications. Switches from non-blocking. More...
 
- Static Public Attributes inherited from fileOperation
static const Enum< pathTypepathTypeNames_
 
static word processorsBaseDir = "processors"
 Return the processors directory name (usually "processors") More...
 
static word defaultFileHandler
 Default fileHandler. More...
 
static autoPtr< fileOperationfileHandlerPtr_
 Static fileOperation. More...
 

Protected Member Functions

bool isMasterRank (const label proci) const
 Is proci master of communicator (in parallel) or master of. More...
 
bool appendObject (const regIOobject &io, const fileName &pathName, IOstreamOption streamOpt) const
 Append to processors/ file. More...
 
- Protected Member Functions inherited from masterUncollatedFileOperation
template<class Type >
Type scatterList (const UList< Type > &, const int, const label comm) const
 
template<class Type , class fileOp >
Type masterOp (const fileName &, const fileOp &fop, const int tag, const label comm) const
 
template<class Type , class fileOp >
Type masterOp (const fileName &, const fileName &, const fileOp &fop, const int tag, const label comm) const
 
virtual fileName filePathInfo (const bool checkGlobal, const bool isFile, const IOobject &, 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
fileMonitormonitor () const
 
tmpNrc< dirIndexListlookupAndCacheProcessorsPath (const fileName &, const bool syncPar) const
 Lookup name of processorsDDD using cache. Return empty fileName. More...
 
virtual tmpNrc< dirIndexListlookupProcessorsPath (const fileName &) const
 Lookup name of processorsDDD using cache. Return empty fileName. More...
 
bool exists (IOobject &io) const
 Does ioobject exist. Is either a directory (empty name()) or. More...
 

Static Protected Member Functions

static labelList ioRanks ()
 
- Static Protected Member Functions inherited from masterUncollatedFileOperation
static labelList subRanks (const label n)
 Get the list of processors that are part of this communicator. More...
 
static word findInstancePath (const instantList &timeDirs, const instant &t)
 Equivalent of Time::findInstance. More...
 
static void readAndSend (const fileName &filePath, const labelUList &procs, PstreamBuffers &pBufs)
 Read file contents and send to processors. More...
 
static autoPtr< ISstreamread (IOobject &io, const label comm, const bool uniform, const fileNameList &filePaths, const boolList &procValid)
 Read files on comms master. More...
 
- Static Protected Member Functions inherited from fileOperation
static instantList sortTimes (const fileNameList &, const word &)
 Sort directory entries according to time value. More...
 
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...
 

Protected Attributes

const label myComm_
 Any communicator allocated by me. More...
 
OFstreamCollator writer_
 Threaded writer. More...
 
label nProcs_
 Number of processors (overall) More...
 
const labelList ioRanks_
 Ranks of IO handlers. More...
 
- Protected Attributes inherited from masterUncollatedFileOperation
const label myComm_
 Any communicator allocated by me. More...
 
HashPtrTable< instantListtimes_
 Cached times for a given directory. More...
 
- Protected Attributes inherited from fileOperation
const label comm_
 Communicator to use. More...
 
HashTable< dirIndexListprocsDirs_
 Detected processors directories. More...
 
autoPtr< fileMonitormonitorPtr_
 file-change monitor for all registered files More...
 

Additional Inherited Members

- Public Types inherited from fileOperation
enum  pathType {
  NOTFOUND, ABSOLUTE, OBJECT, WRITEOBJECT,
  PROCUNCOLLATED, PROCBASEOBJECT, PROCOBJECT, PARENTOBJECT,
  FINDINSTANCE, PROCUNCOLLATEDINSTANCE, PROCBASEINSTANCE, PROCINSTANCE
}
 Enumeration for the location of an IOobject. More...
 
typedef Tuple2< fileName, Tuple2< pathType, label > > dirIndex
 
typedef List< dirIndexdirIndexList
 
- Static Public Member Functions inherited from masterUncollatedFileOperation
static bool uniformFile (const fileNameList &)
 Same file? More...
 
- Static Public Member Functions inherited from fileOperation
static autoPtr< fileOperationNew (const word &handlerType, bool verbose=false)
 Select fileHandler-type. More...
 
static label splitProcessorPath (const fileName &, fileName &path, fileName &procDir, fileName &local, label &groupStart, label &groupSize, label &nProcs)
 Split fileName into part before 'processor' and part after. More...
 
static label detectProcessorPath (const fileName &)
 Detect processor number from '/aa/bb/processorDDD/cc'. More...
 

Detailed Description

Version of masterUncollatedFileOperation that collates regIOobjects into a container in the processors/ subdirectory.

Uses threading if maxThreadFileBufferSize > 0.

See also
masterUncollatedFileOperation
Source files

Definition at line 61 of file collatedFileOperation.H.

Constructor & Destructor Documentation

◆ collatedFileOperation() [1/2]

Construct null.

Definition at line 247 of file collatedFileOperation.C.

References DetailInfo, Foam::endl(), IOobject::fileModificationChecking, Pstream::gatherList(), Foam::hostName(), Foam::infoDetailLevel, IOobject::inotifyMaster, UPstream::master(), UPstream::myProcNo(), Foam::name(), Foam::nl, UPstream::nProcs(), Foam::pid(), IOobject::timeStampMaster, and WarningInFunction.

Here is the call graph for this function:

◆ collatedFileOperation() [2/2]

collatedFileOperation ( const label  comm,
const labelList ioRanks,
const word typeName,
bool  verbose 
)

Construct from user communicator.

Definition at line 349 of file collatedFileOperation.C.

References DetailInfo, Foam::endl(), IOobject::fileModificationChecking, Foam::infoDetailLevel, IOobject::inotifyMaster, Foam::nl, IOobject::timeStampMaster, and WarningInFunction.

Here is the call graph for this function:

◆ ~collatedFileOperation()

~collatedFileOperation ( )
virtual

Destructor.

Definition at line 418 of file collatedFileOperation.C.

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

Here is the call graph for this function:

Member Function Documentation

◆ ioRanks()

Foam::labelList ioRanks ( )
staticprotected

Definition at line 79 of file collatedFileOperation.C.

References Foam::getEnv().

Here is the call graph for this function:

◆ isMasterRank()

bool isMasterRank ( const label  proci) const
protected

Is proci master of communicator (in parallel) or master of.

the io ranks (non-parallel)

Definition at line 95 of file collatedFileOperation.C.

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

Here is the call graph for this function:

◆ appendObject()

bool appendObject ( const regIOobject io,
const fileName pathName,
IOstreamOption  streamOpt 
) const
protected

◆ TypeName()

TypeName ( "collated"  )

Runtime type information.

◆ objectPath()

Foam::fileName objectPath ( const IOobject io,
const word typeName 
) const
virtual

Generate disk file name for object. Opposite of filePath.

Reimplemented from fileOperation.

Definition at line 430 of file collatedFileOperation.C.

References IOobject::instance(), masterUncollatedFileOperation::localObjectPath(), word::null, fileOperation::OBJECT, TimePaths::processorCase(), fileOperation::PROCOBJECT, and IOobject::time().

Here is the call graph for this function:

◆ writeObject()

bool writeObject ( const regIOobject io,
IOstreamOption  streamOpt = IOstreamOption(),
const bool  valid = true 
) const
virtual

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

Returns success state.

Reimplemented from masterUncollatedFileOperation.

Definition at line 460 of file collatedFileOperation.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), regIOobject::global(), IOstream::good(), IOobject::instance(), fileName::isAbsolute(), UPstream::master(), Foam::mkDir(), IOobject::name(), IOobject::objectPath(), UPstream::parRun(), path(), IOobject::path(), Foam::Pout, TimePaths::processorCase(), IOobject::time(), regIOobject::writeData(), IOobject::writeEndDivider(), and IOobject::writeHeader().

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 masterUncollatedFileOperation.

Definition at line 618 of file collatedFileOperation.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), masterUncollatedFileOperation::flush(), and Foam::Pout.

Here is the call graph for this function:

◆ processorsDir() [1/2]

Foam::word processorsDir ( const IOobject io) const
virtual

Actual name of processors dir.

Reimplemented from fileOperation.

Definition at line 696 of file collatedFileOperation.C.

References IOobject::objectPath().

Here is the call graph for this function:

◆ processorsDir() [2/2]

Foam::word processorsDir ( const fileName fName) const
virtual

Actual name of processors dir.

Reimplemented from fileOperation.

Definition at line 632 of file collatedFileOperation.C.

References forAll, Foam::name(), UPstream::nProcs(), UPstream::parRun(), and UPstream::procID().

Here is the call graph for this function:

◆ setNProcs()

void setNProcs ( const label  nProcs)
virtual

Set number of processor directories/results. Only used in.

decomposePar

Reimplemented from fileOperation.

Definition at line 704 of file collatedFileOperation.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

Member Data Documentation

◆ myComm_

const label myComm_
protected

Any communicator allocated by me.

Definition at line 70 of file collatedFileOperation.H.

◆ writer_

OFstreamCollator writer_
mutableprotected

Threaded writer.

Definition at line 73 of file collatedFileOperation.H.

◆ nProcs_

label nProcs_
protected

Number of processors (overall)

Definition at line 78 of file collatedFileOperation.H.

◆ ioRanks_

const labelList ioRanks_
protected

Ranks of IO handlers.

Definition at line 81 of file collatedFileOperation.H.

◆ maxThreadFileBufferSize

float maxThreadFileBufferSize
static

Max size of thread buffer size. This is the overall size of.

all files to be written. Starts blocking if not enough size. Read as float to enable easy specification of large sizes.

Definition at line 112 of file collatedFileOperation.H.

Referenced by collatedFileOperationInitialise::needsThreading().


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