Classes | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
masterUncollatedFileOperation Class Reference
Inheritance diagram for masterUncollatedFileOperation:
Inheritance graph
[legend]
Collaboration diagram for masterUncollatedFileOperation:
Collaboration graph
[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 (const bool verbose)
 Construct null. More...
 
 masterUncollatedFileOperation (const label comm, const 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 &) const
 Remove a directory and its contents. More...
 
virtual fileName filePath (const bool checkGlobal, const IOobject &, const word &typeName) const
 Search for an object. checkGlobal : also check undecomposed case. More...
 
virtual fileName dirPath (const bool checkGlobal, const IOobject &) 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 &, IOstream::streamFormat format=IOstream::ASCII, IOstream::versionNumber version=IOstream::currentVersion, IOstream::compressionType compression=IOstream::UNCOMPRESSED, 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< OstreamNewOFstream (const fileName &pathname, IOstream::streamFormat format=IOstream::ASCII, IOstream::versionNumber version=IOstream::currentVersion, IOstream::compressionType compression=IOstream::UNCOMPRESSED, const bool valid=true) const
 Generate an Ostream 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 null. More...
 
 declareRunTimeSelectionTable (autoPtr, fileOperation, word,(const bool verbose),(verbose))
 
virtual ~fileOperation ()
 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 &type, const bool verbose)
 Select 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 NamedEnum< pathType, 12 > pathTypeNames_
 
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 &, 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
 
void cacheProcessorsPath (const fileName &fName) const
 Detect presence of processorsDDD. More...
 
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 IOstream::compressionType cmp, const labelUList &procs, PstreamBuffers &pBufs)
 Read file contents and send to processors. More...
 
static void readAndSend (const fileName &fName, const labelUList &procs, PstreamBuffers &pBufs)
 Detect file (possibly compressed), read file contents and send. 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
 Description of processor directory naming: More...
 
typedef List< dirIndexdirIndexList
 

Detailed Description

Definition at line 81 of file masterUncollatedFileOperation.H.

Constructor & Destructor Documentation

◆ masterUncollatedFileOperation() [1/2]

masterUncollatedFileOperation ( const bool  verbose)

◆ masterUncollatedFileOperation() [2/2]

masterUncollatedFileOperation ( const label  comm,
const bool  verbose 
)

◆ ~masterUncollatedFileOperation()

Destructor.

Definition at line 867 of file masterUncollatedFileOperation.C.

References UPstream::freeCommunicator(), and masterUncollatedFileOperation::mkDir().

Referenced by masterUncollatedFileOperationInitialise::masterUncollatedFileOperationInitialise(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 80 of file masterUncollatedFileOperation.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::append(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::findIndex(), masterUncollatedFileOperation::findInstancePath(), Foam::getEnv(), Foam::identity(), UPstream::myProcNo(), and PackedBoolList::set().

Referenced by masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ scatterList()

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

Definition at line 33 of file masterUncollatedFileOperationTemplates.C.

References PstreamBuffers::finishedSends(), and masterUncollatedFileOperation::masterOp().

Referenced by masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 68 of file masterUncollatedFileOperationTemplates.C.

References Foam::endl(), Foam::name(), Foam::Pout, and List< T >::size().

Referenced by masterUncollatedFileOperation::readDirOp::operator()(), and masterUncollatedFileOperation::scatterList().

Here is the call graph for this function:
Here is the caller 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 111 of file masterUncollatedFileOperationTemplates.C.

References Foam::endl(), Foam::Pout, and List< 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 132 of file masterUncollatedFileOperation.C.

References instant::equal(), masterUncollatedFileOperation::filePathInfo(), forAllReverse, and word::null.

Referenced by masterUncollatedFileOperation::readDirOp::operator()(), and masterUncollatedFileOperation::subRanks().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ filePathInfo()

Foam::fileName filePathInfo ( const bool  checkGlobal,
const bool  isFile,
const IOobject io,
pathType searchType,
word processorsDir,
word instance 
) const
protectedvirtual

◆ localObjectPath()

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

◆ readAndSend() [1/2]

void readAndSend ( const fileName filePath,
const IOstream::compressionType  cmp,
const labelUList procs,
PstreamBuffers pBufs 
)
staticprotected

Read file contents and send to processors.

Definition at line 497 of file masterUncollatedFileOperation.C.

References UList< T >::begin(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::fileSize(), forAll, IOstream::good(), Foam::Pout, IFstream::stdStream(), and UOPstream::write().

Referenced by masterUncollatedFileOperation::readDirOp::operator()(), and masterUncollatedFileOperation::uniformFile().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ readAndSend() [2/2]

void readAndSend ( const fileName fName,
const labelUList procs,
PstreamBuffers pBufs 
)
staticprotected

Detect file (possibly compressed), read file contents and send.

to processors

Definition at line 561 of file masterUncollatedFileOperation.C.

References Foam::exists(), and masterUncollatedFileOperation::read().

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

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

References masterUncollatedFileOperation::findInstance(), UList< T >::first(), forAll, IOobject::instance(), IOobject::name(), word::null, IOobject::objectPath(), TimePaths::processorCase(), and IOobject::time().

Referenced by masterUncollatedFileOperation::dirPath(), masterUncollatedFileOperation::readDirOp::operator()(), and masterUncollatedFileOperation::type().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ TypeName()

TypeName ( "masterUncollated"  )

Runtime type information.

Referenced by masterUncollatedFileOperation::readDirOp::operator()().

Here is the caller graph for this function:

◆ mkDir()

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

Make directory.

Implements fileOperation.

Definition at line 879 of file masterUncollatedFileOperation.C.

References masterUncollatedFileOperation::chMod(), and UPstream::msgType().

Referenced by masterUncollatedFileOperation::readDirOp::operator()(), and masterUncollatedFileOperation::~masterUncollatedFileOperation().

Here is the call graph for this function:
Here is the caller 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 895 of file masterUncollatedFileOperation.C.

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

Referenced by masterUncollatedFileOperation::mkDir(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 911 of file masterUncollatedFileOperation.C.

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

Referenced by masterUncollatedFileOperation::chMod(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 927 of file masterUncollatedFileOperation.C.

References masterUncollatedFileOperation::exists(), and UPstream::msgType().

Referenced by masterUncollatedFileOperation::mode(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 946 of file masterUncollatedFileOperation.C.

References masterUncollatedFileOperation::isDir(), and 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 963 of file masterUncollatedFileOperation.C.

References masterUncollatedFileOperation::isFile(), and UPstream::msgType().

Referenced by masterUncollatedFileOperation::exists(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 979 of file masterUncollatedFileOperation.C.

References masterUncollatedFileOperation::fileSize(), and UPstream::msgType().

Referenced by masterUncollatedFileOperation::isDir(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 996 of file masterUncollatedFileOperation.C.

References masterUncollatedFileOperation::lastModified(), and UPstream::msgType().

Referenced by masterUncollatedFileOperation::isFile(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 1012 of file masterUncollatedFileOperation.C.

References masterUncollatedFileOperation::highResLastModified(), and UPstream::msgType().

Referenced by masterUncollatedFileOperation::fileSize(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 1028 of file masterUncollatedFileOperation.C.

References UPstream::msgType(), and masterUncollatedFileOperation::mvBak().

Referenced by masterUncollatedFileOperation::lastModified(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 1090 of file masterUncollatedFileOperation.C.

References masterUncollatedFileOperation::cp(), and UPstream::msgType().

Referenced by masterUncollatedFileOperation::readDirOp::operator()(), and masterUncollatedFileOperation::rmDir().

Here is the call graph for this function:
Here is the caller 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 1108 of file masterUncollatedFileOperation.C.

References masterUncollatedFileOperation::ln(), and UPstream::msgType().

Referenced by masterUncollatedFileOperation::readDirOp::operator()(), and masterUncollatedFileOperation::readDir().

Here is the call graph for this function:
Here is the caller 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 1126 of file masterUncollatedFileOperation.C.

References UPstream::msgType(), and masterUncollatedFileOperation::mv().

Referenced by masterUncollatedFileOperation::cp(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 1143 of file masterUncollatedFileOperation.C.

References masterUncollatedFileOperation::filePath(), and UPstream::msgType().

Referenced by masterUncollatedFileOperation::ln(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 1044 of file masterUncollatedFileOperation.C.

References UPstream::msgType(), and masterUncollatedFileOperation::rm().

Referenced by masterUncollatedFileOperation::highResLastModified(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 1060 of file masterUncollatedFileOperation.C.

References UPstream::msgType(), and masterUncollatedFileOperation::rmDir().

Referenced by masterUncollatedFileOperation::mvBak(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ rmDir()

bool rmDir ( const fileName dir) const
virtual

Remove a directory and its contents.

Implements fileOperation.

Definition at line 1075 of file masterUncollatedFileOperation.C.

References UPstream::msgType(), and masterUncollatedFileOperation::readDir().

Referenced by masterUncollatedFileOperation::readDirOp::operator()(), and masterUncollatedFileOperation::rm().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ filePath()

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

◆ dirPath()

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

◆ readObjects()

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

◆ readHeader()

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

◆ readStream()

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

◆ read() [2/2]

bool read ( regIOobject io,
const bool  masterOnly,
const IOstream::streamFormat  format,
const word typeName 
) const
virtual

◆ writeObject()

bool writeObject ( const regIOobject io,
IOstream::streamFormat  format = IOstream::ASCII,
IOstream::versionNumber  version = IOstream::currentVersion,
IOstream::compressionType  compression = IOstream::UNCOMPRESSED,
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 2219 of file masterUncollatedFileOperation.C.

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

Referenced by masterUncollatedFileOperation::readDirOp::operator()(), and masterUncollatedFileOperation::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ NewIFstream()

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

◆ NewOFstream()

Foam::autoPtr< Foam::Ostream > NewOFstream ( const fileName pathname,
IOstream::streamFormat  format = IOstream::ASCII,
IOstream::versionNumber  version = IOstream::currentVersion,
IOstream::compressionType  compression = IOstream::UNCOMPRESSED,
const bool  valid = true 
) const
virtual

Generate an Ostream that writes a file.

Implements fileOperation.

Definition at line 2512 of file masterUncollatedFileOperation.C.

Referenced by masterUncollatedFileOperation::NewIFstream(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the caller graph for this function:

◆ addWatch()

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

Add watching of a file. Returns handle.

Reimplemented from fileOperation.

Definition at line 2543 of file masterUncollatedFileOperation.C.

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

Referenced by masterUncollatedFileOperation::flush(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 2558 of file masterUncollatedFileOperation.C.

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

Referenced by masterUncollatedFileOperation::addWatch(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 2573 of file masterUncollatedFileOperation.C.

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

Referenced by masterUncollatedFileOperation::readDirOp::operator()(), and masterUncollatedFileOperation::removeWatch().

Here is the call graph for this function:
Here is the caller 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 2597 of file masterUncollatedFileOperation.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::append(), HashTable< T, Key, Hash >::erase(), f(), forAll, forAllConstIter(), masterUncollatedFileOperation::getFile(), and regIOobject::watchIndices().

Referenced by masterUncollatedFileOperation::findWatch(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 2635 of file masterUncollatedFileOperation.C.

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

Referenced by masterUncollatedFileOperation::addWatches(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 2650 of file masterUncollatedFileOperation.C.

References masterUncollatedFileOperation::getState(), and UPstream::master().

Referenced by masterUncollatedFileOperation::getFile(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller 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 2664 of file masterUncollatedFileOperation.C.

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

Referenced by masterUncollatedFileOperation::readDirOp::operator()(), and masterUncollatedFileOperation::updateStates().

Here is the call graph for this function:
Here is the caller 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 2679 of file masterUncollatedFileOperation.C.

References UPstream::master().

Referenced by masterUncollatedFileOperation::getState(), and masterUncollatedFileOperation::readDirOp::operator()().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ uniformFile()

bool uniformFile ( const fileNameList filePaths)
static

Same file?

Definition at line 479 of file masterUncollatedFileOperation.C.

References masterUncollatedFileOperation::readAndSend(), and List< T >::size().

Referenced by masterUncollatedFileOperation::localObjectPath(), masterUncollatedFileOperation::readDirOp::operator()(), and masterOFstream::~masterOFstream().

Here is the call graph for this function:
Here is the caller 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 2275 of file masterUncollatedFileOperation.C.

References Foam::endl(), fileOperation::findTimes(), UPstream::master(), Foam::nl, UPstream::parRun(), Foam::Pout, Pstream::scatter(), masterUncollatedFileOperation::setTime(), and List< T >::xfer().

Referenced by masterUncollatedFileOperation::readDirOp::operator()(), and masterUncollatedFileOperation::writeObject().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ findInstance()

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

◆ setTime()

void setTime ( const Time tm) const
virtual

◆ flush()

void flush ( ) const
virtual

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

Reimplemented from fileOperation.

Reimplemented in collatedFileOperation.

Definition at line 2535 of file masterUncollatedFileOperation.C.

References masterUncollatedFileOperation::addWatch(), and fileOperation::flush().

Referenced by collatedFileOperation::flush(), and masterUncollatedFileOperation::readDirOp::operator()().

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

References masterUncollatedFileOperation::times_.

Member Data Documentation

◆ myComm_

const label myComm_
protected

Any communicator allocated by me.

Definition at line 90 of file masterUncollatedFileOperation.H.

◆ times_

HashPtrTable<instantList> times_
mutableprotected

Cached times for a given directory.

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

Referenced by masterUncollatedFileOperation::readDirOp::operator()().


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