regIOobject is an abstract class derived from IOobject to handle automatic object registration with the objectRegistry. More...
Inherits IOobject.
Inherited by AveragingMethod< Foam::vector >, AveragingMethod< scalar >, BlendedInterfacialModel< Foam::dragModel >, BlendedInterfacialModel< Foam::heatTransferModel >, BlendedInterfacialModel< Foam::liftModel >, BlendedInterfacialModel< Foam::turbulentDispersionModel >, BlendedInterfacialModel< Foam::virtualMassModel >, BlendedInterfacialModel< Foam::wallLubricationModel >, CompactIOList< face, label >, DimensionedField< scalar, Foam::areaMesh >, DimensionedField< scalar, Foam::volMesh >, DimensionedField< scalar, triSurfacePointGeoMesh >, DimensionedField< Type, Foam::areaMesh >, DimensionedField< Type, Foam::edgeMesh >, DimensionedField< Type, Foam::pointMesh >, DimensionedField< Type, Foam::surfaceMesh >, DimensionedField< Type, Foam::volMesh >, DimensionedField< vector, Foam::pointMesh >, DimensionedField< vector, Foam::volMesh >, adjointSolverManager, ATCModel, AveragingMethod< Type >, baseIOdictionary, BlendedInterfacialModel< ModelType >, CompactIOField< T, BaseType >, CompactIOList< T, BaseType >, coordinateSystems, decomposedBlockData, populationBalanceModel, DimensionedField< Type, GeoMesh >, dragModel, dragModel, exprResultGlobals, fvExprDriverWriter, extendedFeatureEdgeMesh, faBoundaryMesh, faBoundaryMeshEntries, featureEdgeMesh, fieldDictionary, GlobalIOField< Type >, GlobalIOList< Type >, adjointTurbulenceModel, IOField< Type >, IOFieldRef< Type >, IOList< T >, IOListRef< T >, IOMap< T >, IOmapDistribute, IOmapDistributePolyMesh, IOmapDistributePolyMeshRef, IOPosition< CloudType >, IOPtrList< T >, lduPrimitiveMeshAssembly, lumpedPointIOMovement, meshObject, surfaceTensionModel, objectiveManager, objectRegistry, PDRDragModel, polyBoundaryMesh, polyBoundaryMeshEntries, polyTopoChanger, porosityModel, porousModel, solarLoadBase, rawIOField< Type >, surfaceTensionModel, refinementHistory, searchableSurface, SLGThermo, solutionControl, surfaceTensionModel, surfZoneIOList, topoSet, UniformDimensionedField< Type >, virtualMassModel, virtualMassModel, ZoneMesh< ZoneType, MeshType >, GlobalIOField< vector >, GlobalIOList< kinematicParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< reactingParcelInjectionData >, IOList< label >, IOList< labelList >, IOList< scalarList >, IOPtrList< Foam::entry >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, ZoneMesh< cellZone, polyMesh >, ZoneMesh< faceZone, polyMesh >, and ZoneMesh< pointZone, polyMesh >.
Public Member Functions | |
void | operator= (const regIOobject &)=delete |
No copy assignment. More... | |
TypeName ("regIOobject") | |
Runtime type information. More... | |
regIOobject (const IOobject &io, const bool isTimeObject=false) | |
Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time). More... | |
regIOobject (const regIOobject &rio) | |
Copy construct. More... | |
regIOobject (const regIOobject &rio, bool registerCopy) | |
Copy construct, transferring registry registration to the copy if registerCopy is true. More... | |
regIOobject (const word &newName, const regIOobject &, bool registerCopy) | |
Copy construct with new name, transferring registry registration to the copy if registerCopy is true. More... | |
regIOobject (const IOobject &io, const regIOobject &rio) | |
Copy construct with new IO parameters. More... | |
virtual | ~regIOobject () |
Destructor. More... | |
bool | checkIn () |
Add object to registry, if not already registered. More... | |
bool | checkOut () |
Remove object from registry, and remove all file watches. More... | |
virtual void | addWatch () |
Add file watch on object (if registered and READ_IF_MODIFIED) More... | |
bool | registered () const noexcept |
Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference. More... | |
bool | ownedByRegistry () const noexcept |
Is this object owned by the registry? More... | |
bool | store () |
Register object with its registry and transfer ownership to the registry. More... | |
void | release (const bool unregister=false) noexcept |
Set object as not ownedByRegistry. More... | |
label | eventNo () const noexcept |
Event number at last update. More... | |
label & | eventNo () noexcept |
Event number at last update. More... | |
bool | upToDate (const regIOobject &) const |
Return true if up-to-date with respect to given object. More... | |
bool | upToDate (const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
bool | upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const |
Return true if up-to-date with respect to given objects. More... | |
void | setUpToDate () |
Set as up-to-date. More... | |
virtual void | rename (const word &newName) |
Rename. More... | |
const dictionary * | findMetaData () const noexcept |
Return pointer to meta-data or nullptr. More... | |
dictionary & | getMetaData () noexcept |
Get or create meta-data. More... | |
void | removeMetaData () |
Remove meta-data. More... | |
virtual void | updateMetaData () |
Update internal meta-data (eg, prior to writing) More... | |
virtual fileName | filePath () const |
Return complete path + object name if the file exists. More... | |
bool | headerOk () |
Read and check header info. Does not check the headerClassName. More... | |
Istream & | readStream (const word &, const bool readOnProc=true) |
Return Istream and check object type against that given. More... | |
void | close () |
Close Istream. More... | |
virtual bool | readData (Istream &) |
Virtual readData function. More... | |
virtual bool | read () |
Read object. More... | |
virtual label | addWatch (const fileName &) |
Add file watch for fileName on object if not yet watched. More... | |
const labelList & | watchIndices () const noexcept |
Read access to file-monitoring handles. More... | |
labelList & | watchIndices () noexcept |
Write access to file-monitoring handles. More... | |
virtual bool | modified () const |
Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time) More... | |
virtual bool | readIfModified () |
Read object if modified (as set by call to modified) More... | |
virtual bool | writeData (Ostream &) const =0 |
Pure virtual writeData function. More... | |
virtual bool | writeObject (IOstreamOption streamOpt, const bool writeOnProc) const |
Write using stream options. More... | |
virtual bool | write (const bool writeOnProc=true) const |
Write using setting from DB. More... | |
virtual bool | global () const |
Is object global. More... | |
void | operator= (const IOobject &io) |
Copy assignment. More... | |
virtual bool | writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const |
Write using given format, version and compression. More... | |
Public Member Functions inherited from IOobject | |
TypeName ("IOobject") | |
Declare type-name, virtual type (with debug switch) More... | |
IOobject (const IOobject &)=default | |
Copy construct. More... | |
virtual | ~IOobject ()=default |
Destructor. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption ioOpt=IOobjectOption()) | |
Construct from path, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, registry, io options. More... | |
IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from name, instance, local, registry, io options. More... | |
IOobject (const fileName &path, const objectRegistry ®istry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false) | |
Construct from path, registry, io options. More... | |
IOobject (const IOobject &io, const objectRegistry ®istry) | |
Copy construct, resetting registry. More... | |
IOobject (const IOobject &io, const word &name) | |
Copy construct, resetting name. More... | |
IOobject (const IOobject &io, const word &name, const fileName &local) | |
Copy construct, resetting name and local component. More... | |
IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt) | |
Copy construct, resetting read/write options. More... | |
IOobject (const IOobject &io, IOobjectOption::registerOption regOpt) | |
Copy construct, resetting register option. More... | |
autoPtr< IOobject > | clone () const |
Clone. More... | |
autoPtr< IOobject > | clone (const objectRegistry ®istry) const |
Clone resetting registry. More... | |
const objectRegistry & | db () const noexcept |
Return the local objectRegistry. More... | |
const Time & | time () const noexcept |
Return Time associated with the objectRegistry. More... | |
const word & | name () const noexcept |
Return the object name. More... | |
const word & | headerClassName () const noexcept |
Return name of the class name read from header. More... | |
word & | headerClassName () noexcept |
Return non-constant access to the class name read from header. More... | |
const string & | note () const noexcept |
Return the optional note. More... | |
string & | note () noexcept |
Modifiable access to the optional note. More... | |
unsigned | labelByteSize () const noexcept |
The sizeof (label) in bytes, possibly read from the header. More... | |
unsigned | scalarByteSize () const noexcept |
The sizeof (scalar) in bytes, possibly read from the header. More... | |
void | resetHeader (const word &newName=word::null) |
Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file. More... | |
bool | hasHeaderClass () const noexcept |
True if headerClassName() is non-empty (after reading) More... | |
template<class Type > | |
bool | isHeaderClass () const |
Check if headerClassName() equals Type::typeName. More... | |
template<class Type > | |
bool | isHeaderClassName () const |
Same as isHeaderClass() More... | |
word | group () const |
Return group (extension part of name) More... | |
word | member () const |
Return member (name without the extension) More... | |
const fileName & | rootPath () const noexcept |
Return the Time::rootPath() More... | |
const fileName & | caseName () const noexcept |
Return the Time::caseName() More... | |
const fileName & | globalCaseName () const noexcept |
Return the Time::globalCaseName() More... | |
const fileName & | instance () const noexcept |
Read access to instance path component. More... | |
fileName & | instance () noexcept |
Write access to instance path component. More... | |
const fileName & | local () const noexcept |
Read access to local path component. More... | |
fileName | path () const |
The complete path for the object (with instance, local,...). More... | |
fileName | globalPath () const |
The complete global path for the object (with instance, local,...) More... | |
fileName | path (const word &instance, const fileName &local=fileName::null) const |
The complete path with alternative instance and local. More... | |
fileName | globalPath (const word &instance, const fileName &local=fileName::null) const |
The complete global path with alternative instance and local. More... | |
fileName | objectPath () const |
The complete path + object name. More... | |
fileName | globalObjectPath () const |
The complete global path + object name. More... | |
fileName | objectRelPath () const |
The object path relative to the root. More... | |
fileName | localFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching locally. More... | |
fileName | globalFilePath (const word &typeName, const bool search=true) const |
Redirect to fileHandler filePath, searching up if in parallel. More... | |
IOstreamOption | parseHeader (const dictionary &headerDict) |
Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics. More... | |
bool | readHeader (Istream &is) |
Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
bool | readHeader (dictionary &headerDict, Istream &is) |
Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics. More... | |
template<class Type > | |
bool | typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true) |
Read header (respects is_globalIOobject trait) and check its info. More... | |
template<class Type > | |
fileName | typeFilePath (const bool search=true) const |
Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait. More... | |
template<class Type > | |
void | warnNoRereading () const |
Helper: warn that type does not support re-reading. More... | |
bool | writeHeader (Ostream &os) const |
Write header with current type() More... | |
bool | writeHeader (Ostream &os, const word &objectType) const |
Write header with override of type. More... | |
void | writeHeader (dictionary &dict, IOstreamOption streamOpt) const |
Write header into a dictionary with current type() and given output format. More... | |
void | writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const |
Write header into a dictionary with override of type and given output format. More... | |
bool | good () const noexcept |
Did last readHeader() succeed? More... | |
bool | bad () const noexcept |
Did last readHeader() fail? More... | |
InfoProxy< IOobject > | info () const noexcept |
Return info proxy, for printing information to a stream. More... | |
void | operator= (const IOobject &io) |
Copy assignment, copies all values (except the registry) More... | |
template<> | |
bool | isHeaderClass () const |
Specialization for void always returns true (no headerClassName check). More... | |
template<class StringType > | |
Foam::word | groupName (StringType base, const word &group) |
template<class Type > | |
Foam::fileName | typeFilePath (const bool search) const |
Public Member Functions inherited from IOobjectOption | |
constexpr | IOobjectOption (readOption rOpt=readOption::NO_READ, writeOption wOpt=writeOption::NO_WRITE, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Default construct (NO_READ, NO_WRITE, REGISTER, non-global) or construct with specified options. More... | |
constexpr | IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_WRITE with specified read/register options. More... | |
constexpr | IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept |
Construct NO_READ with specified write/register options. More... | |
constexpr | IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option. More... | |
constexpr | IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept |
Construct from components with specified register option as bool. More... | |
constexpr | IOobjectOption (bool registerObject, bool globalObject=false) noexcept |
Construct (NO_READ, NO_WRITE) with specified register option as bool. More... | |
readOption | readOpt () const noexcept |
Get the read option. More... | |
readOption | readOpt (readOption opt) noexcept |
Set the read option. More... | |
writeOption | writeOpt () const noexcept |
Get the write option. More... | |
writeOption | writeOpt (writeOption opt) noexcept |
Set the write option. More... | |
bool | registerObject () const noexcept |
Should objects created with this IOobject be registered? More... | |
bool | registerObject (bool on) noexcept |
Change registration preference. More... | |
bool | globalObject () const noexcept |
True if object is treated the same for all processors. More... | |
bool | globalObject (bool on) noexcept |
Change global-object status. More... | |
bool | isAnyRead () const noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
bool | isReadRequired () const noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
bool | isReadOptional () const noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
readOption & | readOpt () noexcept |
Access to the read option. More... | |
writeOption & | writeOpt () noexcept |
Access to the write option. More... | |
bool & | registerObject () noexcept |
Access to the register object option. More... | |
bool & | globalObject () noexcept |
Access to the global object option. More... | |
Static Public Member Functions | |
template<class Type > | |
static Type & | store (Type *p) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (std::unique_ptr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (autoPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (refPtr< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &ptr) |
Transfer pointer ownership to its registry. More... | |
template<class Type > | |
static Type & | store (tmp< Type > &&ptr) |
Transfer pointer ownership to its registry. More... | |
Static Public Member Functions inherited from IOobject | |
static bool | bannerEnabled () noexcept |
Status of output file banner. More... | |
static bool | bannerEnabled (bool on) noexcept |
Enable/disable output file banner. More... | |
static bool | fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name) |
Split path into instance, local, name components. More... | |
template<class StringType > | |
static word | groupName (StringType base, const word &group) |
Create dot-delimited name.group string. More... | |
static word | group (const word &name) |
Return group (extension part of name) More... | |
static word | member (const word &name) |
Return member (name without the extension) More... | |
static word | scopedName (const std::string &scope, const word &name) |
Create scope:name or scope_name string. More... | |
static word | scopedName (const std::string &scope, const word &name1, const word &name2) |
Create scope:name1:name2 or scope_name1_name2 string. More... | |
static IOobject | selectIO (const IOobject &io, const fileName &altFile, const word &ioName="") |
Return the IOobject, but also consider an alternative file name. More... | |
static Ostream & | writeBanner (Ostream &os, const bool noSyntaxHint=false) |
Write the standard OpenFOAM file/dictionary banner. More... | |
static Ostream & | writeDivider (Ostream &os) |
Write the standard file section divider. More... | |
static Ostream & | writeEndDivider (Ostream &os) |
Write the standard end file divider. More... | |
Static Public Member Functions inherited from IOobjectOption | |
static bool | isAnyRead (readOption opt) noexcept |
True if any reading may be required (ie, != NO_READ) More... | |
static bool | isReadRequired (readOption opt) noexcept |
True if (MUST_READ | READ_MODIFIED) bits are set. More... | |
static bool | isReadOptional (readOption opt) noexcept |
True if (LAZY_READ) bits are set [same as READ_IF_PRESENT]. More... | |
static readOption | lazierRead (readOption opt) noexcept |
Downgrade readOption optional (LAZY_READ), leaves NO_READ intact. More... | |
Protected Member Functions | |
bool | readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName) |
Helper: check readOpt flags and read if necessary. More... | |
Protected Member Functions inherited from IOobject | |
void | setBad (const string &s) |
Set the object state to bad. More... | |
Static Protected Attributes | |
static bool | masterOnlyReading = false |
To flag master-only reading of objects. More... | |
Friends | |
class | functionEntries::codeStream |
Friendship with classes needing access to masterOnlyReading. More... | |
class | fileOperations::uncollatedFileOperation |
Additional Inherited Members | |
Public Types inherited from IOobject | |
enum | objectState : char { GOOD, BAD } |
Enumeration defining the valid states of an IOobject. More... | |
enum | fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster } |
Enumeration defining the file checking options. More... | |
Public Types inherited from IOobjectOption | |
enum | readOption : unsigned char { NO_READ = 0, MUST_READ = 0x1, READ_MODIFIED = 0x3, MUST_READ_IF_MODIFIED = 0x3, LAZY_READ = 0x4, READ_IF_PRESENT = 0x4 } |
Enumeration defining read preferences. More... | |
enum | writeOption : unsigned char { NO_WRITE = 0, AUTO_WRITE = 0x10 } |
Enumeration defining write preferences. More... | |
enum | registerOption : unsigned char { NO_REGISTER = 0, REGISTER = 1, LEGACY_REGISTER = 2 } |
Enumeration for use with registerObject(). Values map to bool (false/true) More... | |
Static Public Attributes inherited from IOobject | |
static const Enum< fileCheckTypes > | fileCheckTypesNames |
Names for the fileCheckTypes. More... | |
static char | scopeSeparator |
Character for scoping object names (':' or '_') More... | |
static fileCheckTypes | fileModificationChecking |
Type of file modification checking. More... | |
static float | fileModificationSkew |
Time skew (seconds) for file modification checks. More... | |
static int | maxFileModificationPolls |
Max number of times to poll for file modification changes. More... | |
Static Protected Member Functions inherited from IOobject | |
static void | writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr) |
Helper: write content for FoamFile IOobject header with optional meta information. More... | |
static void | writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr) |
Helper: write dictionary content for FoamFile header with optional meta information. More... | |
regIOobject is an abstract class derived from IOobject to handle automatic object registration with the objectRegistry.
Definition at line 68 of file regIOobject.H.
regIOobject | ( | const IOobject & | io, |
const bool | isTimeObject = false |
||
) |
Construct from IOobject. The optional flag adds special handling if the object is the top-level regIOobject (eg, Time).
Definition at line 43 of file regIOobject.C.
References regIOobject::checkIn(), and IOobjectOption::registerObject().
regIOobject | ( | const regIOobject & | rio | ) |
Copy construct.
Definition at line 60 of file regIOobject.C.
regIOobject | ( | const regIOobject & | rio, |
bool | registerCopy | ||
) |
Copy construct, transferring registry registration to the copy if registerCopy is true.
Definition at line 75 of file regIOobject.C.
References regIOobject::checkIn(), and regIOobject::checkOut().
regIOobject | ( | const word & | newName, |
const regIOobject & | rio, | ||
bool | registerCopy | ||
) |
Copy construct with new name, transferring registry registration to the copy if registerCopy is true.
Definition at line 97 of file regIOobject.C.
regIOobject | ( | const IOobject & | io, |
const regIOobject & | rio | ||
) |
Copy construct with new IO parameters.
Definition at line 121 of file regIOobject.C.
References IOobjectOption::registerObject().
|
virtual |
Destructor.
Definition at line 142 of file regIOobject.C.
References Foam::ensightOutput::debug, Foam::endl(), Foam::name(), path(), Foam::Pout, and Foam::type().
|
protected |
Helper: check readOpt flags and read if necessary.
Definition at line 32 of file regIOobjectRead.C.
References Foam::fileHandler.
|
delete |
No copy assignment.
TypeName | ( | "regIOobject" | ) |
Runtime type information.
bool checkIn | ( | ) |
Add object to registry, if not already registered.
Definition at line 184 of file regIOobject.C.
References Foam::abort(), Foam::ensightOutput::debug, polyMesh::defaultRegion, Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::name(), Foam::nl, and WarningInFunction.
Referenced by regIOobject::regIOobject().
bool checkOut | ( | ) |
Remove object from registry, and remove all file watches.
Definition at line 221 of file regIOobject.C.
References Foam::fileHandler, and forAllReverse.
Referenced by InterfaceForce< CloudType >::cacheFields(), PressureGradientForce< CloudType >::cacheFields(), LiftForce< CloudType >::cacheFields(), regionFunctionObject::clearObject(), regionFunctionObject::clearObjects(), removeRegisteredObject::execute(), regIOobject::regIOobject(), and lumpedPointDisplacementPointPatchVectorField::~lumpedPointDisplacementPointPatchVectorField().
|
virtual |
Add file watch on object (if registered and READ_IF_MODIFIED)
Reimplemented in unwatchedIOdictionary.
Definition at line 277 of file regIOobject.C.
References Foam::abort(), Pstream::broadcasts(), UList< T >::empty(), f(), Foam::FatalError, FatalErrorInFunction, Foam::fileHandler, IOobject::fileModificationChecking, forAll, forAllReverse, IOobject::inotifyMaster, UPstream::master(), UPstream::parRun(), DynamicList< T, SizeMin >::push_back(), IOobjectOption::READ_MODIFIED, List< T >::resize(), IOobject::timeStampMaster, Foam::type(), and UPstream::worldComm.
Referenced by includeEntry::execute().
|
inlinenoexcept |
Query the registered state (ie, has been checked in). This is not necessarily the same as registerObject(), which is just a stated preference.
Definition at line 24 of file regIOobjectI.H.
|
inlinenoexcept |
Is this object owned by the registry?
Definition at line 30 of file regIOobjectI.H.
Referenced by objectRegistry::clear(), regionFunctionObject::clearObject(), regionFunctionObject::clearObjects(), objectRegistry::erase(), and removeRegisteredObject::execute().
|
inline |
Register object with its registry and transfer ownership to the registry.
Definition at line 36 of file regIOobjectI.H.
References Foam::name(), Foam::nl, and WarningInFunction.
Referenced by objectRegistry::cacheTemporaryObject(), Foam::calc_rhoU(), ObukhovLength::calcOL(), codedBase::codeDict(), mappedPatchBase::constructIOField(), cloud::createIOField(), fvMatrix< Type >::createOrUpdateLduPrimitiveAssembly(), CrankNicolsonDdtScheme< Type >::ddt0_(), electricPotential::electricPotential(), filmFlux::execute(), forces::force(), forceCoeffs::forceCoeff(), histogramModel::getOrReadField(), heatTransferCoeff::heatTransferCoeff(), hydrostaticPressure::hydrostaticPressure(), volPointInterpolation::interpolate(), readFields::loadAndStore(), fvExpressionField::loadAndStore(), forces::moment(), forceCoeffs::momentCoeff(), momentumError::momentumError(), lumpedPointDisplacementPointPatchVectorField::movement(), multiphaseInterHtcModel::multiphaseInterHtcModel(), options::New(), processorColour::New(), coordinateSystems::New(), zoneCPCStencil::New(), zoneDistribute::New(), polySurface::New(), GAMGAgglomeration::New(), polySurface::polySurface(), HeatTransferCoeff< CloudType >::postEvolve(), NusseltNumber< CloudType >::postEvolve(), processorField::processorField(), proudmanAcousticPower::proudmanAcousticPower(), reactingEulerHtcModel::reactingEulerHtcModel(), resolutionIndexModel::read(), momentum::read(), Cloud< passivePositionParticle >::readStoreFile(), stabilityBlendingFactor::stabilityBlendingFactor(), mappedPatchBase::storeField(), objectRegistry::subRegistry(), processorField::updateMesh(), wallHeatFlux::wallHeatFlux(), wallShearStress::wallShearStress(), yPlus::yPlus(), and cellCellStencil::zoneID().
|
inlinestatic |
Transfer pointer ownership to its registry.
Definition at line 53 of file regIOobjectI.H.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and p.
|
inlinestatic |
Transfer pointer ownership to its registry.
Resets (clears) the parameter.
Definition at line 77 of file regIOobjectI.H.
|
inlinestatic |
Transfer pointer ownership to its registry.
Resets (clears) the parameter.
Definition at line 85 of file regIOobjectI.H.
References autoPtr< T >::release().
|
inlinestatic |
Transfer pointer ownership to its registry.
Resets (clears) the parameter.
Definition at line 93 of file regIOobjectI.H.
|
inlinestatic |
Transfer pointer ownership to its registry.
Changes parameter from PTR to CREF (do not rely on this).
Definition at line 101 of file regIOobjectI.H.
References refPtr< T >::cref(), refPtr< T >::get(), refPtr< T >::is_pointer(), IOobject::name(), p, refPtr< T >::release(), and WarningInFunction.
|
inlinestatic |
Transfer pointer ownership to its registry.
Changes parameter from PTR to CREF (do not rely on this).
Definition at line 134 of file regIOobjectI.H.
|
inlinestatic |
Transfer pointer ownership to its registry.
Changes parameter from PTR to CREF (do not rely on this).
Definition at line 142 of file regIOobjectI.H.
References tmp< T >::cref(), tmp< T >::get(), tmp< T >::is_pointer(), IOobject::name(), p, tmp< T >::protect(), tmp< T >::ptr(), and WarningInFunction.
|
inlinestatic |
Transfer pointer ownership to its registry.
Changes parameter from PTR to CREF (do not rely on this).
Definition at line 177 of file regIOobjectI.H.
|
inlinenoexcept |
Set object as not ownedByRegistry.
unregister | optionally set as non-registered too |
Definition at line 184 of file regIOobjectI.H.
Referenced by objectRegistry::clear(), and objectRegistry::erase().
|
inlinenoexcept |
Event number at last update.
Definition at line 195 of file regIOobjectI.H.
Referenced by faMatrix< Type >::faMatrix(), triSurfaceMesh::movePoints(), cyclicACMIPolyPatch::updateAreas(), and regIOobject::upToDate().
|
inlinenoexcept |
Event number at last update.
Definition at line 200 of file regIOobjectI.H.
bool upToDate | ( | const regIOobject & | a | ) | const |
Return true if up-to-date with respect to given object.
Definition at line 406 of file regIOobject.C.
References regIOobject::eventNo(), and Foam::labelMax.
bool upToDate | ( | const regIOobject & | a, |
const regIOobject & | b | ||
) | const |
Return true if up-to-date with respect to given objects.
Definition at line 446 of file regIOobject.C.
References Foam::constant::physicoChemical::b.
bool upToDate | ( | const regIOobject & | a, |
const regIOobject & | b, | ||
const regIOobject & | c | ||
) | const |
Return true if up-to-date with respect to given objects.
Definition at line 456 of file regIOobject.C.
References Foam::constant::physicoChemical::b, and Foam::constant::universal::c.
bool upToDate | ( | const regIOobject & | a, |
const regIOobject & | b, | ||
const regIOobject & | c, | ||
const regIOobject & | d | ||
) | const |
Return true if up-to-date with respect to given objects.
Definition at line 467 of file regIOobject.C.
References Foam::constant::physicoChemical::b, and Foam::constant::universal::c.
void setUpToDate | ( | ) |
Set as up-to-date.
Definition at line 478 of file regIOobject.C.
Referenced by cyclicACMIPolyPatch::updateAreas().
|
virtual |
Rename.
Reimplemented from IOobject.
Reimplemented in objectRegistry.
Definition at line 484 of file regIOobject.C.
References IOobjectOption::registerObject(), and IOobject::rename().
Referenced by RASModelVariables::copyAndRename(), if(), ReynoldsStress< RASModel< BasicTurbulenceModel > >::k(), reuseTmpDimensionedField< TypeR, TypeR, GeoMesh >::New(), reuseTmpGeometricField< TypeR, TypeR, PatchField, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, Type2, GeoMesh >::New(), reuseTmpTmpDimensionedField< TypeR, TypeR, TypeR, TypeR, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, Type2, PatchField, GeoMesh >::New(), reuseTmpTmpGeometricField< TypeR, TypeR, TypeR, TypeR, PatchField, GeoMesh >::New(), objectRegistry::rename(), variablesSet::renameTurbulenceField(), faMeshReconstructor::writeAddressing(), faMeshDecomposition::writeDecomposition(), and topOVariablesBase::writeFluidSolidInterface().
|
virtualnoexcept |
Return pointer to meta-data or nullptr.
Reimplemented from IOobject.
Definition at line 26 of file regIOobjectMetaData.C.
|
noexcept |
Get or create meta-data.
Definition at line 32 of file regIOobjectMetaData.C.
References dictionary.
void removeMetaData | ( | ) |
Remove meta-data.
Definition at line 42 of file regIOobjectMetaData.C.
|
virtual |
Update internal meta-data (eg, prior to writing)
Reimplemented in ZoneMesh< ZoneType, MeshType >, ZoneMesh< faceZone, polyMesh >, ZoneMesh< pointZone, polyMesh >, and ZoneMesh< cellZone, polyMesh >.
Definition at line 48 of file regIOobjectMetaData.C.
|
virtual |
Return complete path + object name if the file exists.
in the case directory otherwise null. Does not search up if parallel. Can be overridden to provide this functionality (e.g. IOdictionary)
Reimplemented in distributedTriSurfaceMesh, triSurfaceMesh, porosityModel, searchableSurface, extendedFeatureEdgeMesh, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, IOdictionary, IOMap< T >, localIOdictionary, GlobalIOField< Type >, GlobalIOList< Type >, GlobalIOField< vector >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< kinematicParcelInjectionData >, unwatchedIOdictionary, baseIOdictionary, and featureEdgeMesh.
Definition at line 499 of file regIOobject.C.
References Foam::type().
bool headerOk | ( | ) |
Read and check header info. Does not check the headerClassName.
Definition at line 505 of file regIOobject.C.
References Foam::ensightOutput::debug, Foam::endl(), Foam::fileHandler, IOWarningInFunction, and Foam::type().
Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), faBoundaryMeshEntries::faBoundaryMeshEntries(), featureEdgeMesh::featureEdgeMesh(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), boundaryRegion::readDict(), and cellTable::readDict().
Foam::Istream & readStream | ( | const word & | expectName, |
const bool | readOnProc = true |
||
) |
Return Istream and check object type against that given.
Definition at line 119 of file regIOobjectRead.C.
References Foam::ensightOutput::debug, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::name(), Foam::Pout, and Foam::type().
Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), faBoundaryMeshEntries::faBoundaryMeshEntries(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), and polyBoundaryMeshEntries::polyBoundaryMeshEntries().
void close | ( | ) |
Close Istream.
Definition at line 161 of file regIOobjectRead.C.
References Foam::ensightOutput::debug, Foam::endl(), and Foam::Pout.
Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), faBoundaryMeshEntries::faBoundaryMeshEntries(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), and adjointRASModel::read().
|
virtual |
Virtual readData function.
Must be defined in derived types for which re-reading is required
Reimplemented in refinementHistory, exprResultGlobals, IOmapDistributePolyMeshRef, extendedFeatureEdgeMesh, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, GlobalIOField< Type >, GlobalIOList< Type >, GlobalIOField< vector >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< kinematicParcelInjectionData >, baseIOdictionary, lumpedPointIOMovement, IOmapDistributePolyMesh, fvExprDriverWriter, IOmapDistribute, and featureEdgeMesh.
Definition at line 175 of file regIOobjectRead.C.
|
virtual |
Read object.
Reimplemented in multiphaseInterSystem, adjointkOmegaSST, basicThermo, phaseSystem, Time, schemesLookup, refinementHistory, adjointRASModel, phaseModel, twoPhaseMixtureThermo, adjointSpalartAllmaras, twoPhaseMixtureEThermo, solarLoad, laserDTRM, multiphaseSystem, kinematicSingleLayer, solution, multiphaseMixture, fvDOM, viewFactor, radiationModel, thermoSingleLayer, incompressibleThreePhaseMixture, phaseModel, optimisationManager, diffusionMulticomponent< ReactionThermo, ThermoType >, adjointTurbulenceModel, twoPhaseSystem, crankConRod, rigidBodyMeshMotion, incompressibleTwoPhaseInteractingMixture, kineticTheoryModel, kineticTheoryModel, RASModel< EddyDiffusivity< ThermalDiffusivity< PhaseCompressibleTurbulenceModel< phaseModel > > > >, RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >, motionSolver, EDC< ReactionThermo >, solidThermo, reactingOneDim, multiphaseSystem, combustionModel, rigidBodyMeshMotionSolver, decomposedBlockData, FSD< ReactionThermo, ThermoType >, incompressibleTwoPhaseMixture, engineTime, temperaturePhaseChangeTwoPhaseMixture, sixDoFRigidBodyMotionSolver, phaseChangeTwoPhaseMixture, interfaceHeatResistance, adjointLaminar, SRFModel, regionModel, thermoIncompressibleTwoPhaseMixture, phasePressureModel, phasePressureModel, phaseModel, solutionControl, SchnerrSauer, SIMPLEControl, zoneCombustion< ReactionThermo >, CombustionModel< ReactionThermo >, P1, laminar< ReactionThermo >, PaSR< ReactionThermo >, turbulenceModel, eddyDissipationDiffusionModel< ReactionThermo, ThermoType >, eddyDissipationModelBase< ReactionThermo, ThermoType >, Kunz, thermalBaffle, singleStepCombustion< ReactionThermo, ThermoType >, constant, pimpleControl, Merkle, diffusion< ReactionThermo, ThermoType >, regionModel1D, singlePhaseTransportModel, IOMRFZoneList, infinitelyFastChemistry< ReactionThermo, ThermoType >, noCombustion< ReactionThermo >, options, thermalBaffleModel, options, opaqueSolid, noRadiation, EddyDiffusivity< ThermalDiffusivity< PhaseCompressibleTurbulenceModel< phaseModel > > >, EddyDiffusivity< phaseCompressibleTurbulenceModel >, eddyViscosity< RASModel< EddyDiffusivity< ThermalDiffusivity< PhaseCompressibleTurbulenceModel< phaseModel > > > > >, eddyViscosity< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >, singleLayerRegion, rpm, tolerances, pisoControl, IOporosityModelList, pyrolysisModel, linearViscousStress< RASModel< EddyDiffusivity< ThermalDiffusivity< PhaseCompressibleTurbulenceModel< phaseModel > > > > >, linearViscousStress< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >, immiscibleIncompressibleTwoPhaseMixture, surfaceFilmRegionModel, thermo, noPyrolysis, noThermo, SIMPLEControlOpt, SIMPLEControlSingleRun, and simpleControl.
Definition at line 181 of file regIOobjectRead.C.
References IOstreamOption::BINARY, Foam::fileHandler, IOobject::fileModificationChecking, forAllReverse, IOobject::inotifyMaster, IOobject::timeStampMaster, and Foam::type().
Referenced by IOporosityModelList::read(), tolerances::read(), IOMRFZoneList::read(), singlePhaseTransportModel::read(), turbulenceModel::read(), regionModel::read(), SRFModel::read(), incompressibleTwoPhaseMixture::read(), combustionModel::read(), solidThermo::read(), motionSolver::read(), twoPhaseSystem::read(), optimisationManager::read(), radiationModel::read(), solution::read(), multiphaseSystem::read(), schemesLookup::read(), phaseSystem::read(), basicThermo::read(), multiphaseInterSystem::read(), and DimensionedField< Type, Foam::pointMesh >::readField().
|
virtual |
Add file watch for fileName on object if not yet watched.
1. Directly add to fileHandler
index = fileHandler().findWatch(watchIndices_, f);
if (index == -1) { index = watchIndices_.size(); watchIndices_.push_back(fileHandler().addWatch(f)); }
2. Delay adding; add to list and handle in addWatch() later on
Note: what do we return?
Reimplemented in unwatchedIOdictionary.
Definition at line 241 of file regIOobject.C.
References f(), and IOobjectOption::READ_MODIFIED.
|
inlinenoexcept |
Read access to file-monitoring handles.
Definition at line 206 of file regIOobjectI.H.
Referenced by masterUncollatedFileOperation::addWatches(), fileOperation::addWatches(), and Time::readDict().
|
inlinenoexcept |
Write access to file-monitoring handles.
Definition at line 212 of file regIOobjectI.H.
|
virtual |
Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time)
Reimplemented in objectRegistry.
Definition at line 225 of file regIOobjectRead.C.
References Foam::fileHandler, forAllReverse, and fileMonitor::UNMODIFIED.
|
virtual |
Read object if modified (as set by call to modified)
Reimplemented in objectRegistry.
Definition at line 239 of file regIOobjectRead.C.
References Foam::endl(), Foam::fileHandler, forAllReverse, InfoInFunction, Foam::name(), Foam::read(), and fileMonitor::UNMODIFIED.
|
pure virtual |
Pure virtual writeData function.
Must be defined in derived types
Implemented in GeometricField< Type, PatchField, GeoMesh >, GeometricField< Type, Foam::pointPatchField, Foam::pointMesh >, GeometricField< tensor, faPatchField, areaMesh >, GeometricField< Foam::vector, Foam::pointPatchField, Foam::pointMesh >, GeometricField< Type, Foam::fvPatchField, Foam::volMesh >, GeometricField< scalar, Foam::fvPatchField, Foam::volMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< vector, fvsPatchField, surfaceMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< scalar, faePatchField, edgeMesh >, GeometricField< vector, faPatchField, areaMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< scalar, Foam::pointPatchField, Foam::pointMesh >, GeometricField< Type, Foam::fvsPatchField, Foam::surfaceMesh >, GeometricField< vector, pointPatchField, pointMesh >, GeometricField< scalar, faPatchField, areaMesh >, GeometricField< Foam::vector, Foam::fvPatchField, Foam::volMesh >, objectRegistry, DimensionedField< Type, GeoMesh >, DimensionedField< Type, Foam::edgeMesh >, DimensionedField< scalar, Foam::volMesh >, DimensionedField< scalar, triSurfacePointGeoMesh >, DimensionedField< Type, Foam::surfaceMesh >, DimensionedField< Type, Foam::volMesh >, DimensionedField< scalar, Foam::areaMesh >, DimensionedField< vector, Foam::volMesh >, DimensionedField< vector, Foam::pointMesh >, DimensionedField< Type, Foam::areaMesh >, DimensionedField< Type, Foam::pointMesh >, NURBS3DVolume, MMA, objective, polyBoundaryMesh, ZoneMesh< ZoneType, MeshType >, ZoneMesh< faceZone, polyMesh >, ZoneMesh< pointZone, polyMesh >, ZoneMesh< cellZone, polyMesh >, ISQP, topoSet, refinementHistory, nullSpace, populationBalanceModel, searchableSphere, triSurfaceMesh, faBoundaryMesh, searchableCone, searchableSurfaceWithGaps, updateMethod, searchableSurfaceCollection, searchableBox, topODesignVariables, searchableRotatedBox, searchableCylinder, porosityModel, searchableDisk, searchablePlate, profiling, searchableExtrudedCircle, adjointSolver, searchablePlane, volumetricBSplinesDesignVariables, lduPrimitiveMeshAssembly, adjointSolverManager, LBFGS, solidification, MeshObject< polyMesh, UpdateableMeshObject, manifoldCellsMeshObject >, MeshObject< fvMesh, MoveableMeshObject, FitDataType >, MeshObject< polyMesh, GeometricMeshObject, meshSearchMeshObject >, MeshObject< polyMesh, UpdateableMeshObject, decompositionModel >, MeshObject< fvMesh, MoveableMeshObject, CentredFitData< Polynomial > >, MeshObject< fvMesh, TopologicalMeshObject, centredCPCCellToFaceStencilObject >, MeshObject< polyMesh, UpdateableMeshObject, twoDPointCorrector >, MeshObject< fvMesh, UpdateableMeshObject, wallDist >, MeshObject< fvMesh, TopologicalMeshObject, zoneDistribute >, MeshObject< fvMesh, MoveableMeshObject, cellCellStencilObject >, MeshObject< pointMesh, UpdateableMeshObject, pointConstraints >, MeshObject< fvMesh, TopologicalMeshObject, centredCPCCellToCellStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCECCellToCellStencilObject >, MeshObject< polyMesh, GeometricMeshObject, meshSearchFACE_CENTRE_TRISMeshObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCFaceToCellStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindFECCellToFaceStencilObject >, MeshObject< faMesh, MoveableMeshObject, leastSquaresFaVectors >, MeshObject< fvMesh, MoveableMeshObject, LeastSquaresVectors< Stencil > >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCCellToCellStencilObject >, MeshObject< polyMesh, MoveableMeshObject, cellAspectRatio >, MeshObject< fvMesh, MoveableMeshObject, leastSquaresVectors >, MeshObject< fvMesh, TopologicalMeshObject, upwindCECCellToFaceStencilObject >, MeshObject< lduMesh, MoveableMeshObject, processorColour >, MeshObject< fvMesh, UpdateableMeshObject, volPointInterpolation >, MeshObject< fvMesh, TopologicalMeshObject, upwindCFCCellToFaceStencilObject >, MeshObject< polyMesh, UpdateableMeshObject, faMeshesRegistry >, MeshObject< fvMesh, TopologicalMeshObject, upwindCPCCellToFaceStencilObject >, MeshObject< lduMesh, GeometricMeshObject, GAMGAgglomeration >, MeshObject< fvMesh, TopologicalMeshObject, pureUpwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, UpdateableMeshObject, wallDistAddressing >, MeshObject< fvMesh, UpdateableMeshObject, volPointInterpolationAdjoint >, MeshObject< Time, TopologicalMeshObject, meshObjects::gravity >, MeshObject< fvMesh, UpdateableMeshObject, volBSplinesBase >, MeshObject< fvMesh, TopologicalMeshObject, centredCECCellToFaceStencilObject >, MeshObject< fvMesh, MoveableMeshObject, UpwindFitData< Polynomial > >, MeshObject< polyMesh, TopologicalMeshObject, regionSplit >, MeshObject< fvMesh, MoveableMeshObject, skewCorrectionVectors >, MeshObject< polyMesh, UpdateableMeshObject, pointMesh >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCCellToFaceStencilObject >, MeshObject< fvMesh, GeometricMeshObject, boundaryRadiationProperties >, MeshObject< fvMesh, TopologicalMeshObject, centredFECCellToFaceStencilObject >, MeshObject< Time, TopologicalMeshObject, multiWorldConnections >, MeshObject< fvMesh, MoveableMeshObject, CentredFitSnGradData< Polynomial > >, MeshObject< fvMesh, TopologicalMeshObject, zoneCPCStencil >, levelSetDesignVariables, powerLawLopesdaCosta, solver, adjointTurbulenceModel, BlendedInterfacialModel< ModelType >, BlendedInterfacialModel< Foam::wallLubricationModel >, BlendedInterfacialModel< Foam::dragModel >, BlendedInterfacialModel< Foam::heatTransferModel >, BlendedInterfacialModel< Foam::virtualMassModel >, BlendedInterfacialModel< Foam::liftModel >, BlendedInterfacialModel< Foam::turbulentDispersionModel >, IOFieldRef< Type >, ATCModel, DarcyForchheimer, IOListRef< T >, exprResultGlobals, coordinateSystems, adjointSimple, solutionControl, simple, decomposedBlockData, IOmapDistributePolyMeshRef, AveragingMethod< Type >, AveragingMethod< scalar >, AveragingMethod< Foam::vector >, objectiveManager, powerLaw, fixedCoeff, polyTopoChanger, SLGThermo, PDRDragModel, dragModel, dragModel, quasiNewton, surfaceTensionModel, dynamicTopODesignVariables, virtualMassModel, virtualMassModel, extendedFeatureEdgeMesh, polyBoundaryMeshEntries, SQP, CompactIOList< T, BaseType >, CompactIOList< face, label >, temperatureDependent, CompactIOField< T, BaseType >, RASTurbulenceModel, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, GlobalIOField< Type >, GlobalIOList< Type >, IOMap< T >, GlobalIOField< vector >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< kinematicParcelInjectionData >, IOField< Type >, surfaceTensionModel, baseIOdictionary, rawIOField< Type >, faBoundaryMeshEntries, liquidProperties, surfaceTensionModel, IOList< T >, IOList< label >, IOList< scalarList >, IOList< labelList >, conjugateGradient, porousModel, lumpedPointIOMovement, constant, IOPtrList< T >, IOmapDistributePolyMesh, IOPtrList< Foam::entry >, objectivePartialVolume, fvExprDriverWriter, IOmapDistribute, surfZoneIOList, IOPosition< CloudType >, featureEdgeMesh, solarLoadBase, and fieldDictionary.
Referenced by searchableSurfaceWithGaps::writeData(), and mappedPatchBase::writeDict().
|
virtual |
Write using stream options.
uncomment this if you want to write global objects on master only
bool isGlobal = global();
Reimplemented in polyMesh, objectRegistry, fvMesh, distributedTriSurfaceMesh, Time, polySurface, polyBoundaryMesh, surfMesh, triSurfaceMesh, faBoundaryMesh, dynamicRefineFvMesh, Cloud< ParticleType >, Cloud< Foam::passiveParticle >, Cloud< wallBoundedStreamLineParticle >, Cloud< indexedParticle >, Cloud< basicKinematicCollidingParcel >, Cloud< ParcelType >, Cloud< Foam::molecule >, Cloud< solidParticle >, Cloud< parcelType >, Cloud< molecule >, Cloud< typename CloudType::parcelType >, Cloud< passiveParticle >, Cloud< injectedParticle >, Cloud< Foam::DTRMParticle >, Cloud< streamLineParticle >, Cloud< passivePositionParticle >, profiling, dynamicOversetFvMesh, staticOversetFvMesh, coordinateSystems, rigidBodyMeshMotion, faceZoneSet, decomposedBlockData, motionSolver, faMeshesRegistry, rigidBodyMeshMotionSolver, pointZoneSet, cellZoneSet, sixDoFRigidBodyMotionSolver, polyBoundaryMeshEntries, CompactIOList< T, BaseType >, CompactIOList< face, label >, CompactIOField< T, BaseType >, faBoundaryMeshEntries, and unmappedPassivePositionParticleCloud.
Definition at line 29 of file regIOobjectWrite.C.
References Foam::ensightOutput::debug, Foam::endl(), Foam::fileHandler, IOobject::instance(), Foam::name(), Foam::Pout, SeriousErrorInFunction, Foam::system(), and timeName.
Referenced by regIOobject::write(), faBoundaryMeshEntries::writeObject(), CompactIOField< T, BaseType >::writeObject(), polyBoundaryMeshEntries::writeObject(), cellZoneSet::writeObject(), pointZoneSet::writeObject(), faceZoneSet::writeObject(), coordinateSystems::writeObject(), oversetFvMeshBase::writeObject(), profiling::writeObject(), faBoundaryMesh::writeObject(), regIOobject::writeObject(), and polyBoundaryMesh::writeObject().
|
virtual |
Write using setting from DB.
Reimplemented in faMesh, fvMesh, objective, objectiveIncompressible, incompressibleAdjointSolver, solver, AveragingMethod< Type >, AveragingMethod< scalar >, AveragingMethod< Foam::vector >, incompressiblePrimalSolver, SIMPLEControl, SIMPLEControlOpt, SIMPLEControlSingleRun, and IOPosition< CloudType >.
Definition at line 130 of file regIOobjectWrite.C.
References IOobject::time(), and regIOobject::writeObject().
Referenced by topOZones::addIOcellsZone(), jouleHeatingSource::addSup(), DarcyForchheimer::calcTransformModelData(), hydrostaticPressure::calculateAndWrite(), columnFvMesh::columnFvMesh(), hexRef8::consistentSlowRefinement2(), ShapeSensitivitiesBase::constructAndWriteSensitivtyPointField(), thixotropicViscosity::correct(), diffusionMulticomponent< ReactionThermo, ThermoType >::correct(), contactAngleForce::correct(), limitedSnGrad< Type >::correction(), snappySnapDriver::doSnap(), dynamicRefineFvMesh::init(), diffusionGasEvaporation< Thermo, OtherThermo >::Kexp(), SIMPLEControlOpt::loop(), meshRefinement::mergePatchFacesUndo(), polyMesh::movePoints(), Foam::operator<<(), polyMesh::polyMesh(), liquidFilmBase::postEvolveRegion(), simple::postIter(), snappySnapDriver::scaleMesh(), removeFaces::setRefinement(), hexRef8::setUnrefinement(), adjointMeshMovementSolver::solve(), adjointEikonalSolver::solve(), kinematicSingleLayer::transferPrimaryRegionSourceFields(), levelSetDesignVariables::update(), PatchCollisionDensity< CloudType >::write(), SIMPLEControlSingleRun::write(), dsmcFields::write(), XiReactionRate::write(), processorField::write(), surfaceInterpolate::write(), writeObjects::write(), columnAverage::write(), zeroGradient::write(), ObukhovLength::write(), setFlow::write(), momentum::write(), electricPotential::write(), regionSizeDistribution::write(), fvMesh::write(), KinematicParcel< ParcelType >::writeFields(), wallBoundedStreamLineParticle::writeFields(), injectedParticle::writeFields(), solidParticle::writeFields(), streamLineParticle::writeFields(), MPPICParcel< ParcelType >::writeFields(), molecule::writeFields(), wallBoundedParticle::writeFields(), ReactingParcel< ParcelType >::writeFields(), ReactingMultiphaseParcel< ParcelType >::writeFields(), SprayParcel< ParcelType >::writeFields(), particle< Type >::writeFields(), topOVariablesBase::writeFluidSolidInterface(), faMeshReconstructor::writeMesh(), regionFunctionObject::writeObject(), dynamicRefineFvMesh::writeObject(), faMeshTools::writeProcAddressing(), and isoAdvection::writeSurfaceCells().
|
inlinevirtual |
Is object global.
Reimplemented in distributedTriSurfaceMesh, triSurfaceMesh, porosityModel, searchableSurface, extendedFeatureEdgeMesh, UniformDimensionedField< Type >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, baseIOdictionary, IOdictionary, localIOdictionary, IOMap< T >, GlobalIOField< Type >, GlobalIOList< Type >, GlobalIOField< vector >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< kinematicParcelInjectionData >, unwatchedIOdictionary, and featureEdgeMesh.
Definition at line 504 of file regIOobject.H.
Referenced by includeEtcEntry::execute().
void operator= | ( | const IOobject & | io | ) |
Copy assignment.
Definition at line 526 of file regIOobject.C.
References io(), IOobject::operator=(), and IOobjectOption::registerObject().
|
inlinevirtual |
Write using given format, version and compression.
Definition at line 526 of file regIOobject.H.
References regIOobject::writeObject().
|
friend |
Friendship with classes needing access to masterOnlyReading.
Definition at line 142 of file regIOobject.H.
|
friend |
Definition at line 143 of file regIOobject.H.
|
staticprotected |
To flag master-only reading of objects.
Definition at line 86 of file regIOobject.H.
Referenced by uncollatedFileOperation::read().