masterUncollatedFileOperation Class Reference

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  isDirOp
 
class  isFileOp
 
class  lastModifiedHROp
 
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)
 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 bool writeObject (const regIOobject &io, IOstreamOption streamOpt=IOstreamOption(), const bool valid=true) const
 Writes a regIOobject (so header, contents and divider). 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...
 
virtual void flush () const
 Forcibly wait until all output done. Flush any cached data. 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 objectPath (const IOobject &io, const word &typeName) const
 Generate disk file name for object. Opposite of filePath. More...
 
virtual fileName filePath (const fileName &) const
 Search for a file or directory. Use IOobject version in. More...
 
virtual word processorsDir (const IOobject &io) const
 Actual name of processors dir (for use in mode PROCOBJECT,. More...
 
virtual word processorsDir (const fileName &) const
 Actual name of processors dir (for use in mode PROCOBJECT,. More...
 
virtual void setNProcs (const label nProcs)
 Set number of processor directories/results. Only used 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 Member Functions

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

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

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

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 85 of file masterUncollatedFileOperation.H.

Constructor & Destructor Documentation

◆ masterUncollatedFileOperation() [1/2]

Construct null.

Definition at line 733 of file masterUncollatedFileOperation.C.

References DetailInfo, Foam::endl(), Foam::infoDetailLevel, and WarningInFunction.

Here is the call graph for this function:

◆ masterUncollatedFileOperation() [2/2]

masterUncollatedFileOperation ( const label  comm,
bool  verbose 
)

Construct from communicator.

Definition at line 785 of file masterUncollatedFileOperation.C.

References DetailInfo, Foam::endl(), Foam::infoDetailLevel, and WarningInFunction.

Here is the call graph for this function:

◆ ~masterUncollatedFileOperation()

Destructor.

Definition at line 862 of file masterUncollatedFileOperation.C.

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

Here is the call graph for this function:

Member Function Documentation

◆ subRanks()

Foam::labelList subRanks ( const label  n)
staticprotected

Get the list of processors that are part of this communicator.

Definition at line 84 of file masterUncollatedFileOperation.C.

References DynamicList< T, SizeMin >::append(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::getEnv(), Foam::identity(), and n.

Here is the call graph for this function:

◆ scatterList()

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

Definition at line 35 of file masterUncollatedFileOperationTemplates.C.

References PstreamBuffers::finishedSends().

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 70 of file masterUncollatedFileOperationTemplates.C.

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

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 113 of file masterUncollatedFileOperationTemplates.C.

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

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 135 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 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 160 of file masterUncollatedFileOperation.C.

References IOobject::caseName(), TimePaths::constant(), IOobject::db(), objectRegistry::dbDir(), forAll, TimePaths::globalCaseName(), IOobject::headerClassName(), IOobject::instance(), fileName::isAbsolute(), Foam::isFile(), IOobject::local(), IOobject::name(), IOobject::objectPath(), Time::path(), TimePaths::processorCase(), IOobject::rootPath(), Foam::search(), TimePaths::system(), and IOobject::time().

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 335 of file masterUncollatedFileOperation.C.

References IOobject::caseName(), IOobject::db(), objectRegistry::dbDir(), TimePaths::globalCaseName(), IOobject::headerClassName(), IOobject::instance(), IOobject::local(), IOobject::name(), Foam::name(), NotImplemented, IOobject::path(), IOobject::rootPath(), and IOobject::time().

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 procs,
PstreamBuffers pBufs 
)
staticprotected

Read file contents and send to processors.

Handles compressed or uncompressed files

Definition at line 495 of file masterUncollatedFileOperation.C.

References bool, IOstreamOption::compression(), Foam::BitOps::count(), Foam::expressions::patchExpr::debug, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::fileSize(), IOstream::good(), Foam::Pout, IFstream::stdStream(), and UOPstream::write().

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 boolList procValid 
)
staticprotected

Read files on comms master.

Definition at line 568 of file masterUncollatedFileOperation.C.

References DynamicList< T, SizeMin >::append(), Foam::expressions::patchExpr::debug, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, PstreamBuffers::finishedSends(), IOobject::name(), IOobject::objectPath(), Foam::Pout, UIPstream::read(), IOobject::readHeader(), 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 1426 of file masterUncollatedFileOperation.C.

References forAll, IOobject::instance(), Foam::isFile(), IOobject::name(), word::null, IOobject::objectPath(), TimePaths::processorCase(), and IOobject::time().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "masterUncollated"  )

Runtime type information.

◆ mkDir()

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

Make directory.

Implements fileOperation.

Definition at line 874 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 
) const
virtual

Set the file mode.

Implements fileOperation.

Definition at line 890 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 906 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 LINK.

Implements fileOperation.

Definition at line 922 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 941 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 958 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 974 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 991 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 1007 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

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 1023 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

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 1086 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 1104 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 1122 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 1139 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 1039 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 1055 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
virtual

Remove a directory and its contents.

Parameters
silentdo not report missing directory

Implements fileOperation.

Definition at line 1070 of file masterUncollatedFileOperation.C.

References UPstream::msgType().

Here is the call graph for this function:

◆ filePath()

◆ dirPath()

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

◆ 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 1675 of file masterUncollatedFileOperation.C.

References TimePaths::constant(), Foam::expressions::patchExpr::debug, Foam::endl(), Instant< T >::equal(), fileOperation::findTimes(), forAllReverse, UPstream::master(), Foam::name(), word::null, IOobject::objectPath(), UPstream::parRun(), Time::path(), Foam::Pout, fileOperation::readObjects(), Pstream::scatter(), and objectRegistry::time().

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 1762 of file masterUncollatedFileOperation.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), forAll, Pstream::gatherList(), IOstream::good(), IOobject::headerClassName(), UPstream::master(), UPstream::msgType(), UPstream::myProcNo(), IOobject::note(), UPstream::nProcs(), IOobject::objectPath(), Foam::Pout, IOobject::readHeader(), decomposedBlockData::readMasterHeader(), Pstream::scatter(), List< T >::setSize(), and UPstream::worldComm.

Here is the call graph for this function:

◆ readStream()

◆ read() [2/2]

◆ 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 fileOperation.

Reimplemented in collatedFileOperation.

Definition at line 2205 of file masterUncollatedFileOperation.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), IOstream::good(), IOobject::objectPath(), Foam::Pout, setTime(), IOobject::time(), regIOobject::writeData(), IOobject::writeEndDivider(), and IOobject::writeHeader().

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 2356 of file masterUncollatedFileOperation.C.

References Foam::expressions::patchExpr::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(), autoPtr< T >::reset(), and UPstream::worldComm.

Here is the call graph for this function:

◆ NewOFstream()

Foam::autoPtr< Foam::OSstream > NewOFstream ( const fileName pathname,
IOstreamOption  streamOpt = IOstreamOption(),
const bool  valid = true 
) const
virtual

Generate an OSstream that writes a file.

Implements fileOperation.

Definition at line 2467 of file masterUncollatedFileOperation.C.

◆ addWatch()

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

Add watching of a file. Returns handle.

Reimplemented from fileOperation.

Definition at line 2494 of file masterUncollatedFileOperation.C.

References UPstream::master(), and Pstream::scatter().

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 2509 of file masterUncollatedFileOperation.C.

References UPstream::master(), and Pstream::scatter().

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 2524 of file masterUncollatedFileOperation.C.

References forAll, UPstream::master(), and Pstream::scatter().

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 2548 of file masterUncollatedFileOperation.C.

References DynamicList< T, SizeMin >::append(), HashTable< T, Key, Hash >::erase(), f(), 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 2585 of file masterUncollatedFileOperation.C.

References UPstream::master(), and Pstream::scatter().

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 2600 of file masterUncollatedFileOperation.C.

References UPstream::master().

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 2614 of file masterUncollatedFileOperation.C.

References UPstream::master(), Pstream::scatter(), and fileMonitor::UNMODIFIED.

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 2629 of file masterUncollatedFileOperation.C.

References UPstream::master().

Here is the call graph for this function:

◆ uniformFile()

bool uniformFile ( const fileNameList filePaths)
static

Same file?

Definition at line 477 of file masterUncollatedFileOperation.C.

◆ findTimes()

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

Get sorted list of times.

Reimplemented from fileOperation.

Definition at line 2249 of file masterUncollatedFileOperation.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), fileOperation::findTimes(), UPstream::master(), Foam::nl, UPstream::parRun(), Foam::Pout, and Pstream::scatter().

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. Fails if cannot be found.

and readOpt() is MUST_READ/MUST_READ_IF_MODIFIED. Otherwise returns stopInstance.

Reimplemented from fileOperation.

Definition at line 1475 of file masterUncollatedFileOperation.C.

References TimePaths::constant(), Foam::expressions::patchExpr::debug, Foam::endl(), Foam::exists(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::instance(), IOobject::local(), UPstream::master(), UPstream::msgType(), IOobject::MUST_READ, IOobject::MUST_READ_IF_MODIFIED, IOobject::name(), Foam::name(), IOobject::objectPath(), Foam::Pout, IOobject::readOpt(), Pstream::scatter(), 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 2296 of file masterUncollatedFileOperation.C.

References List< T >::append(), TimePaths::constant(), Foam::expressions::patchExpr::debug, Foam::endl(), Foam::findSortedIndex(), Time::path(), Foam::Pout, fileOperation::setTime(), 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 2486 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:

◆ times()

const HashPtrTable<instantList>& times ( ) const
inline

Return cached times.

Definition at line 766 of file masterUncollatedFileOperation.H.

References masterUncollatedFileOperation::times_.

Member Data Documentation

◆ myComm_

const label myComm_
protected

Any communicator allocated by me.

Definition at line 94 of file masterUncollatedFileOperation.H.

◆ times_

HashPtrTable<instantList> times_
mutableprotected

Cached times for a given directory.

Definition at line 97 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 485 of file masterUncollatedFileOperation.H.


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