regIOobject Class Reference

regIOobject is an abstract class derived from IOobject to handle automatic object registration with the objectRegistry. More...

#include <regIOobject.H>

Inherits IOobject.

Inherited by TypeGrad< Type >, AveragingMethod< Foam::Vector< scalar > >, AveragingMethod< scalar >, BlendedInterfacialModel< Foam::dragModel >, BlendedInterfacialModel< Foam::virtualMassModel >, BlendedInterfacialModel< Foam::heatTransferModel >, BlendedInterfacialModel< Foam::liftModel >, BlendedInterfacialModel< Foam::wallLubricationModel >, BlendedInterfacialModel< Foam::turbulentDispersionModel >, CompactIOField< diagTensorField >, CompactIOField< labelField >, CompactIOField< scalarField >, CompactIOField< sphericalTensorField >, CompactIOField< symmTensorField >, CompactIOField< tensorField >, CompactIOField< vector2DField >, CompactIOField< vectorField >, CompactIOList< cell >, CompactIOList< edge >, CompactIOList< face >, CompactIOList< labelList >, CompactIOList< scalarList >, CompactIOList< vectorList >, DimensionedField< Type, areaMesh >, DimensionedField< Type, edgeMesh >, DimensionedField< Type, volMesh >, DimensionedField< Type, surfaceMesh >, DimensionedField< vector, pointMesh >, DimensionedField< scalar, polyGeoMesh >, DimensionedField< vector, polyGeoMesh >, DimensionedField< sphericalTensor, polyGeoMesh >, DimensionedField< symmTensor, polyGeoMesh >, DimensionedField< tensor, polyGeoMesh >, DimensionedField< Type, pointMesh >, DimensionedField< Type, polySurfaceGeoMesh >, DimensionedField< label, polySurfaceGeoMesh >, DimensionedField< scalar, polySurfaceGeoMesh >, DimensionedField< vector, polySurfaceGeoMesh >, DimensionedField< sphericalTensor, polySurfaceGeoMesh >, DimensionedField< symmTensor, polySurfaceGeoMesh >, DimensionedField< tensor, polySurfaceGeoMesh >, DimensionedField< Type, polySurfacePointGeoMesh >, DimensionedField< label, polySurfacePointGeoMesh >, DimensionedField< scalar, polySurfacePointGeoMesh >, DimensionedField< vector, polySurfacePointGeoMesh >, DimensionedField< sphericalTensor, polySurfacePointGeoMesh >, DimensionedField< symmTensor, polySurfacePointGeoMesh >, DimensionedField< tensor, polySurfacePointGeoMesh >, DimensionedField< label, surfGeoMesh >, DimensionedField< scalar, surfGeoMesh >, DimensionedField< vector, surfGeoMesh >, DimensionedField< sphericalTensor, surfGeoMesh >, DimensionedField< symmTensor, surfGeoMesh >, DimensionedField< tensor, surfGeoMesh >, DimensionedField< label, surfPointGeoMesh >, DimensionedField< scalar, surfPointGeoMesh >, DimensionedField< vector, surfPointGeoMesh >, DimensionedField< sphericalTensor, surfPointGeoMesh >, DimensionedField< symmTensor, surfPointGeoMesh >, DimensionedField< tensor, surfPointGeoMesh >, DimensionedField< label, triSurfaceGeoMesh >, DimensionedField< scalar, triSurfaceGeoMesh >, DimensionedField< vector, triSurfaceGeoMesh >, DimensionedField< sphericalTensor, triSurfaceGeoMesh >, DimensionedField< symmTensor, triSurfaceGeoMesh >, DimensionedField< tensor, triSurfaceGeoMesh >, DimensionedField< label, triSurfacePointGeoMesh >, DimensionedField< scalar, triSurfacePointGeoMesh >, DimensionedField< vector, triSurfacePointGeoMesh >, DimensionedField< sphericalTensor, triSurfacePointGeoMesh >, DimensionedField< symmTensor, triSurfacePointGeoMesh >, DimensionedField< tensor, triSurfacePointGeoMesh >, DimensionedField< scalar, Foam::volMesh >, DimensionedField< Foam::Vector< scalar >, Foam::volMesh >, DimensionedField< Foam::Vector< scalar >, Foam::pointMesh >, DimensionedField< scalar, Foam::areaMesh >, DimensionedField< Type, Foam::areaMesh >, DimensionedField< Type, Foam::edgeMesh >, DimensionedField< Type, Foam::volMesh >, DimensionedField< Type, Foam::surfaceMesh >, DimensionedField< Type, Foam::pointMesh >, DimensionedField< scalar, Foam::edgeMesh >, DimensionedField< Foam::Vector< scalar >, Foam::areaMesh >, DimensionedField< Foam::Vector< scalar >, Foam::edgeMesh >, DimensionedField< Foam::SphericalTensor< scalar >, Foam::areaMesh >, DimensionedField< Foam::SphericalTensor< scalar >, Foam::edgeMesh >, DimensionedField< Foam::SymmTensor< scalar >, Foam::areaMesh >, DimensionedField< Foam::SymmTensor< scalar >, Foam::edgeMesh >, DimensionedField< Foam::Tensor< scalar >, Foam::areaMesh >, DimensionedField< Foam::Tensor< scalar >, Foam::edgeMesh >, DimensionedField< scalar, Foam::pointMesh >, GlobalIOField< label >, GlobalIOField< scalar >, GlobalIOField< vector >, GlobalIOField< sphericalTensor >, GlobalIOField< symmTensor >, GlobalIOField< tensor >, GlobalIOList< kinematicParcelInjectionData >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< thermoParcelInjectionData >, GlobalIOList< label >, GlobalIOList< scalar >, GlobalIOList< vector >, GlobalIOList< sphericalTensor >, GlobalIOList< symmTensor >, GlobalIOList< tensor >, IOField< bool >, IOField< diagTensorField >, IOField< diagTensor >, IOField< labelField >, IOField< label >, IOField< quaternion >, IOField< scalarField >, IOField< scalar >, IOField< sphericalTensorField >, IOField< sphericalTensor >, IOField< symmTensorField >, IOField< symmTensor >, IOField< tensorField >, IOField< tensor >, IOField< triad >, IOField< vector2DField >, IOField< vector2D >, IOField< vectorField >, IOField< vector >, IOList< cell >, IOList< cellShape >, IOList< edge >, IOList< face >, IOList< pointIndexHit >, IOList< label >, IOList< labelList >, IOList< scalar >, IOList< scalarList >, IOList< string >, IOList< stringList >, IOList< word >, IOList< wordList >, IOList< vector >, IOList< vectorList >, IOPtrList< Foam::entry >, UniformDimensionedField< label >, UniformDimensionedField< scalar >, UniformDimensionedField< vector >, UniformDimensionedField< sphericalTensor >, UniformDimensionedField< symmTensor >, UniformDimensionedField< tensor >, ZoneMesh< faFaceZone, faMesh >, ZoneMesh< cellZone, polyMesh >, ZoneMesh< faceZone, polyMesh >, ZoneMesh< pointZone, polyMesh >, ATCModel, AveragingMethod< Type >, BlendedInterfacialModel< ModelType >, CompactIOField< T >, CompactIOList< T >, DimensionedField< Type, GeoMesh >, GlobalIOField< Type >, GlobalIOList< Type >, IOField< Type >, IOFieldRef< Type >, IOList< T >, IOListRef< T >, IOMap< T >, IOPosition< CloudType >, IOPtrList< T >, IOmapDistribute, IOmapDistributePolyMesh, IOmapDistributePolyMeshRef, PDRDragModel, SLGThermo, UniformDimensionedField< Type >, ZoneMesh< ZoneType, MeshType >, adjointSolverManager, baseIOdictionary, coordinateSystems, decomposedBlockData, populationBalanceModel, dragModel, dragModel, exprResultGlobals, fvExprDriverWriter, extendedFeatureEdgeMesh, faBoundaryMesh, faBoundaryMeshEntries, featureEdgeMesh, fieldDictionary, adjointTurbulenceModel, lduPrimitiveMeshAssembly, lumpedPointIOMovement, meshObject, surfaceTensionModel, objectRegistry, objectiveManager, pointBoundaryMesh, polyBoundaryMesh, polyBoundaryMeshEntries, polyTopoChanger, porosityModel, porousModel, solarLoadBase, rawIOField< Type >, surfaceTensionModel, refinementHistory, searchableSurface, solutionControl, surfZoneIOList, surfaceTensionModel, topoSet, virtualMassModel, and virtualMassModel.

Collaboration diagram for regIOobject:

Public Member Functions
void	operator= (const regIOobject &)=delete
	No copy assignment.
	TypeName ("regIOobject")
	Runtime type information.
	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).
	regIOobject (const regIOobject &rio)
	Copy construct.
	regIOobject (const regIOobject &rio, bool registerCopy)
	Copy construct, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const word &newName, const regIOobject &, bool registerCopy)
	Copy construct with new name, transferring registry registration to the copy if registerCopy is true.
	regIOobject (const IOobject &io, const regIOobject &rio)
	Copy construct with new IO parameters.
virtual	~regIOobject ()
	Destructor.
bool	checkIn ()
	Add object to registry, if not already registered.
bool	checkOut ()
	Remove object from registry, and remove all file watches.
virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED).
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.
bool	ownedByRegistry () const noexcept
	Is this object owned by the registry?
bool	store ()
	Register object with its registry and transfer ownership to the registry.
void	release (const bool unregister=false) noexcept
	Set object as not ownedByRegistry.
label	eventNo () const noexcept
	Event number at last update.
label &	eventNo () noexcept
	Event number at last update.
bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object.
bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects.
void	setUpToDate ()
	Set as up-to-date.
virtual void	rename (const word &newName)
	Rename.
const dictionary *	findMetaData () const noexcept
	Return pointer to meta-data or nullptr.
dictionary &	getMetaData () noexcept
	Get or create meta-data.
void	removeMetaData ()
	Remove meta-data.
virtual void	updateMetaData ()
	Update internal meta-data (eg, prior to writing).
virtual fileName	filePath () const
	Return complete path + object name if the file exists.
bool	headerOk ()
	Read and check header info. Does not check the headerClassName.
Istream &	readStream (const word &, const bool readOnProc=true)
	Return Istream and check object type against that given.
void	close ()
	Close Istream.
virtual bool	readData (Istream &)
	Virtual readData function.
virtual bool	read ()
	Read object.
virtual label	addWatch (const fileName &)
	Add file watch for fileName on object if not yet watched.
const labelList &	watchIndices () const noexcept
	Read access to file-monitoring handles.
labelList &	watchIndices () noexcept
	Write access to file-monitoring handles.
virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) have been modified. (modified state is cached by Time).
virtual bool	readIfModified ()
	Read object if modified (as set by call to modified).
virtual bool	writeData (Ostream &) const =0
	Pure virtual writeData function.
virtual bool	writeObject (IOstreamOption streamOpt, const bool writeOnProc) const
	Write using stream options.
virtual bool	write (const bool writeOnProc=true) const
	Write using setting from DB.
virtual bool	global () const
	Is object global.
void	operator= (const IOobject &io)
	Copy assignment.
virtual bool	writeObject (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc) const
	Write using given format, version and compression.
Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Declare type-name, virtual type (with debug switch).
	IOobject (const IOobject &)=default
	Copy construct.
virtual	~IOobject ()=default
	Destructor.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption ioOpt=IOobjectOption())
	Construct from path, registry, io options.
	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, registry, io options.
	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options.
	IOobject (const fileName &path, const objectRegistry &registry, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt=IOobjectOption::NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options.
	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry.
	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name.
	IOobject (const IOobject &io, const word &name, const fileName &local)
	Copy construct, resetting name and local component.
	IOobject (const IOobject &io, IOobjectOption::readOption rOpt, IOobjectOption::writeOption wOpt)
	Copy construct, resetting read/write options.
	IOobject (const IOobject &io, IOobjectOption::registerOption regOpt)
	Copy construct, resetting register option.
autoPtr< IOobject >	clone () const
	Clone.
autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry.
const objectRegistry &	db () const noexcept
	Return the local objectRegistry.
const Time &	time () const noexcept
	Return Time associated with the objectRegistry.
const word &	name () const noexcept
	Return the object name.
const word &	headerClassName () const noexcept
	Return name of the class name read from header.
word &	headerClassName () noexcept
	Modifiable access to the class name read from header.
const string &	note () const noexcept
	Return the optional note.
string &	note () noexcept
	Modifiable access to the optional note.
unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes, possibly read from the header.
unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes, possibly read from the header.
void	resetHeader (const word &newName=word::null)
	Clear various bits (headerClassName, note, sizeof...) that would be obtained when reading from a file.
bool	hasHeaderClass () const noexcept
	True if headerClassName() is non-empty (after reading).
bool	isHeaderClass (const word &expectedType) const
	Check if headerClassName() equals the expected type. Always true if the expected type is empty.
template<class Type>
bool	isHeaderClass () const
	Check if headerClassName() equals Type::typeName Always true for a void type.
word	group () const
	Return group (extension part of name).
word	member () const
	Return member (name without the extension).
const fileName &	rootPath () const noexcept
	Return the Time::rootPath().
const fileName &	caseName () const noexcept
	Return the Time::caseName().
const fileName &	globalCaseName () const noexcept
	Return the Time::globalCaseName().
const fileName &	caseName (IOobjectOption::Layout) const noexcept
	Return the Time::caseName() - normal or global.
const fileName &	instance () const noexcept
	Read access to instance path component.
fileName &	instance () noexcept
	Modifiable access to instance path component.
scalar	instanceValue () const
	Return the scalar value of the instance component (or 0), which often corresponds to a time index/value.
const fileName &	local () const noexcept
	Read access to local path component.
fileName &	local () noexcept
	Modifiable access to the local path component.
fileName	path () const
	The complete path for the object (with instance, local,...).
fileName	globalPath () const
	The complete global path for the object (with instance, local,...).
fileName	path (IOobjectOption::Layout) const
	The complete path (normal or global) for the object.
fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local.
fileName	globalPath (const word &instance, const fileName &local=fileName::null) const
	The complete global path with alternative instance and local.
fileName	path (IOobjectOption::Layout, const word &instance, const fileName &local=fileName::null) const
	The complete path (normal or global) with alternative instance and local.
fileName	objectPath () const
	The complete path + object name.
fileName	globalObjectPath () const
	The complete global path + object name.
fileName	objectPath (IOobjectOption::Layout) const
	The complete path (normal or global) + object name.
fileName	objectPath (IOobjectOption::Layout, const word &instance) const
	The complete path (normal or global) + object name with alternative instance.
fileName	objectPath (const word &instance) const
	The complete path + object name with alternative instance.
fileName	globalObjectPath (const word &instance) const
	The complete global path + object name with alternative instance.
fileName	objectRelPath () const
	The object path relative to the case.
fileName	localFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching locally.
fileName	globalFilePath (const word &typeName, const bool search=true) const
	Redirect to fileHandler filePath, searching up if in parallel.
IOstreamOption	parseHeader (const dictionary &headerDict)
	Parse 'FoamFile' header contents and set the IOobject characteristics and return the stream characteristics.
bool	readHeader (Istream &is)
	Read header ('FoamFile' dictionary) and set the IOobject and stream characteristics.
bool	readHeader (dictionary &headerDict, Istream &is)
	Read header (the 'FoamFile' dictionary) and set the IOobject and stream characteristics.
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. A void type suppresses trait and type-name checks.
template<class Type, bool Searching>
bool	typeHeaderOk (const bool checkType=true, const bool verbose=true)
	Forwards to single-parameter version with the specified search type. A void type suppresses trait and type-name checks.
template<class Type>
fileName	typeFilePath (const bool search=true) const
	Call localFilePath or globalFilePath for given type depending on its is_globalIOobject trait.
template<class Type>
void	warnNoRereading () const
	Helper: warn that type does not support re-reading.
bool	writeHeader (Ostream &os) const
	Write header with current type().
bool	writeHeader (Ostream &os, const word &objectType) const
	Write header with override of type.
void	writeHeader (dictionary &dict, IOstreamOption streamOpt) const
	Write header into a dictionary with current type() and given output format.
void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const
	Write header into a dictionary with override of type and given output format.
bool	good () const noexcept
	Did last readHeader() succeed?
bool	bad () const noexcept
	Did last readHeader() fail?
InfoProxy< IOobject >	info () const noexcept
	Return info proxy, for printing information to a stream.
void	operator= (const IOobject &io)
	Copy assignment, copies all values (except the registry).
template<class Type>
bool	isHeaderClassName () const
	Same as isHeaderClass().
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.
constexpr	IOobjectOption (readOption rOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_WRITE with specified read/register options.
constexpr	IOobjectOption (writeOption wOpt, registerOption registerObject=registerOption::REGISTER, bool globalObject=false) noexcept
	Construct NO_READ with specified write/register options.
constexpr	IOobjectOption (registerOption registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option.
constexpr	IOobjectOption (readOption rOpt, writeOption wOpt, bool registerObject, bool globalObject=false) noexcept
	Construct from components with specified register option as bool.
constexpr	IOobjectOption (bool registerObject, bool globalObject=false) noexcept
	Construct (NO_READ, NO_WRITE) with specified register option as bool.
readOption	readOpt () const noexcept
	Get the read option.
readOption	readOpt (readOption opt) noexcept
	Set the read option.
writeOption	writeOpt () const noexcept
	Get the write option.
writeOption	writeOpt (writeOption opt) noexcept
	Set the write option.
bool	registerObject () const noexcept
	Should objects created with this IOobject be registered?
bool	registerObject (bool on) noexcept
	Change registration preference.
bool	globalObject () const noexcept
	True if object is treated the same for all processors.
bool	globalObject (bool on) noexcept
	Change global-object status.
bool	isAnyRead () const noexcept
	True if any reading may be required (ie, != NO_READ).
bool	isReadRequired () const noexcept
	True if (MUST_READ | READ_MODIFIED) bits are set.
bool	isReadOptional () const noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
readOption &	readOpt () noexcept
	Access to the read option.
writeOption &	writeOpt () noexcept
	Access to the write option.
bool &	registerObject () noexcept
	Access to the register object option.
bool &	globalObject () noexcept
	Access to the global object option.

Static Public Member Functions
template<class Type>
static Type &	store (Type *p)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (std::unique_ptr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (autoPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (refPtr< Type > &&ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &ptr)
	Transfer pointer ownership to its registry.
template<class Type>
static Type &	store (tmp< Type > &&ptr)
	Transfer pointer ownership to its registry.
Static Public Member Functions inherited from IOobject
static bool	bannerEnabled () noexcept
	Status of output file banner.
static bool	bannerEnabled (bool on) noexcept
	Enable/disable output file banner.
static bool	fileModificationChecking_masterOnly () noexcept
	Test fileModificationChecking for master-only.
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components.
template<class StringType>
static word	groupName (StringType base, const word &group)
	Create dot-delimited name.group string.
static word	group (const word &name)
	Return group (extension part of name).
static word	member (const word &name)
	Return member (name without the extension).
static word	scopedName (const std::string &scope, const word &name)
	Create scope:name or scope_name string.
static word	scopedName (const std::string &scope, const word &name1, const word &name2)
	Create scope:name1:name2 or scope_name1_name2 string.
static IOobject	selectIO (const IOobject &io, const fileName &altFile, const word &ioName="")
	Return the IOobject, but also consider an alternative file name.
static Ostream &	writeBanner (Ostream &os, const bool noSyntaxHint=false)
	Write the standard OpenFOAM file/dictionary banner.
static Ostream &	writeDivider (Ostream &os)
	Write the standard file section divider.
static Ostream &	writeEndDivider (Ostream &os)
	Write the standard end file divider.
Static Public Member Functions inherited from IOobjectOption
static bool	isAnyRead (readOption opt) noexcept
	True if any reading may be required (ie, != NO_READ).
static bool	isReadRequired (readOption opt) noexcept
	True if (MUST_READ | READ_MODIFIED) bits are set.
static bool	isReadOptional (readOption opt) noexcept
	True if (LAZY_READ) bits are set [same as READ_IF_PRESENT].
static readOption	lazierRead (readOption opt) noexcept
	Downgrade readOption optional (LAZY_READ), leaves NO_READ intact.

Protected Member Functions
bool	readHeaderOk (const IOstreamOption::streamFormat fmt, const word &typeName)
	Helper: check readOpt flags and read if necessary.
Protected Member Functions inherited from IOobject
void	setBad (const string &s)
	Set the object state to bad.

Static Protected Attributes
static bool	masterOnlyReading = false
	To flag master-only reading of objects.

Friends
class	functionEntries::codeStream
	Friendship with classes needing access to masterOnlyReading.
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 = 1 , timeStampMaster = 3 , inotify = 4 , inotifyMaster = 6 }
	Enumeration defining the file checking options (time-stamp | inotify) | (all | masterOnly). 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...
enum class	Layout : unsigned char { regular , global }
	The layout of the case structure. More...
Static Public Attributes inherited from IOobject
static const Enum< fileCheckTypes >	fileCheckTypesNames
	Names for the fileCheckTypes.
static char	scopeSeparator
	Character for scoping object names (':' or '_').
static fileCheckTypes	fileModificationChecking
	Type of file modification checking.
static float	fileModificationSkew
	Time skew (seconds) for file modification checks.
static int	maxFileModificationPolls
	Max number of times to poll for file modification changes.
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.
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.

Detailed Description

regIOobject is an abstract class derived from IOobject to handle automatic object registration with the objectRegistry.

Source files

• regIOobject.H
• regIOobject.C
• regIOobjectI.H
• regIOobjectRead.C
• regIOobjectWrite.C
• regIOobjectMetaData.C

Definition at line 68 of file regIOobject.H.

Constructor & Destructor Documentation

regIOobject() [1/5]

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 checkIn(), IOobject::db(), io, and IOobjectOption::registerObject().

Referenced by adjointSolverManager::adjointSolverManager(), adjointTurbulenceModel::adjointTurbulenceModel(), ATCModel::ATCModel(), AveragingMethod< Type >::AveragingMethod(), AveragingMethod< Type >::AveragingMethod(), baseIOdictionary::baseIOdictionary(), baseIOdictionary::baseIOdictionary(), BlendedInterfacialModel< ModelType >::BlendedInterfacialModel(), objectRegistry::checkIn(), objectRegistry::checkIn(), objectRegistry::checkOut(), objectRegistry::checkOut(), objectRegistry::classesImpl(), objectRegistry::clear(), CompactIOField< T >::CompactIOField(), CompactIOField< T >::CompactIOField(), CompactIOField< T >::CompactIOField(), CompactIOField< T >::CompactIOField(), CompactIOField< T >::CompactIOField(), CompactIOField< T >::CompactIOField(), CompactIOList< T >::CompactIOList(), CompactIOList< T >::CompactIOList(), CompactIOList< T >::CompactIOList(), CompactIOList< T >::CompactIOList(), CompactIOList< T >::CompactIOList(), coordinateSystems::coordinateSystems(), coordinateSystems::coordinateSystems(), coordinateSystems::coordinateSystems(), objectRegistry::count(), objectRegistry::countImpl(), objectRegistry::countTypeImpl(), decomposedBlockData::decomposedBlockData(), DimensionedField< Type, GeoMesh >::DimensionedField(), DimensionedField< Type, GeoMesh >::DimensionedField(), DimensionedField< Type, GeoMesh >::DimensionedField(), DimensionedField< Type, GeoMesh >::DimensionedField(), DimensionedField< Type, GeoMesh >::DimensionedField(), DimensionedField< Type, GeoMesh >::DimensionedField(), DimensionedField< Type, GeoMesh >::DimensionedField(), DimensionedField< Type, GeoMesh >::DimensionedField(), DimensionedField< Type, GeoMesh >::DimensionedField(), DimensionedField< Type, GeoMesh >::DimensionedField(), DimensionedField< Type, GeoMesh >::DimensionedField(), DimensionedField< Type, GeoMesh >::DimensionedField(), DimensionedField< Type, GeoMesh >::DimensionedField(), DimensionedField< Type, GeoMesh >::DimensionedField(), dragModel::dragModel(), dragModel::dragModel(), objectRegistry::erase(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), faBoundaryMesh::faBoundaryMesh(), faBoundaryMesh::faBoundaryMesh(), faBoundaryMesh::faBoundaryMesh(), faBoundaryMesh::faBoundaryMesh(), faBoundaryMesh::faBoundaryMesh(), faBoundaryMeshEntries::faBoundaryMeshEntries(), featureEdgeMesh::featureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), fvExprDriverWriter::fvExprDriverWriter(), GlobalIOField< Type >::GlobalIOField(), GlobalIOField< Type >::GlobalIOField(), GlobalIOField< Type >::GlobalIOField(), GlobalIOField< Type >::GlobalIOField(), GlobalIOField< Type >::GlobalIOField(), GlobalIOList< Type >::GlobalIOList(), GlobalIOList< Type >::GlobalIOList(), GlobalIOList< Type >::GlobalIOList(), GlobalIOList< Type >::GlobalIOList(), GlobalIOList< Type >::GlobalIOList(), IOField< Type >::IOField(), IOField< Type >::IOField(), IOField< Type >::IOField(), IOField< Type >::IOField(), IOField< Type >::IOField(), IOField< Type >::IOField(), IOField< Type >::IOField(), IOFieldRef< Type >::IOFieldRef(), IOList< T >::IOList(), IOList< T >::IOList(), IOList< T >::IOList(), IOList< T >::IOList(), IOList< T >::IOList(), IOListRef< T >::IOListRef(), IOMap< T >::IOMap(), IOMap< T >::IOMap(), IOMap< T >::IOMap(), IOMap< T >::IOMap(), IOmapDistribute::IOmapDistribute(), IOmapDistribute::IOmapDistribute(), IOmapDistribute::IOmapDistribute(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), IOmapDistributePolyMesh::IOmapDistributePolyMesh(), IOmapDistributePolyMeshRef::IOmapDistributePolyMeshRef(), IOPosition< CloudType >::IOPosition(), IOPtrList< T >::IOPtrList(), IOPtrList< T >::IOPtrList(), IOPtrList< T >::IOPtrList(), IOPtrList< T >::IOPtrList(), IOPtrList< T >::IOPtrList(), objectRegistry::is_cacheTemporaryObject(), objectRegistry::is_cacheTemporaryObject(), BlendedInterfacialModel< Foam::dragModel >::K(), lduPrimitiveMeshAssembly::lduPrimitiveMeshAssembly(), lduPrimitiveMeshAssembly::lduPrimitiveMeshAssembly(), objectRegistry::lookupClass(), objectRegistry::lookupClassTypeImpl(), lumpedPointIOMovement::lumpedPointIOMovement(), objectRegistry::namesImpl(), objectRegistry::namesTypeImpl(), objectiveManager::objectiveManager(), objectRegistry::objectRegistry(), objectRegistry::objectRegistry(), objectRegistry::objectsTypeImpl(), operator=(), pointBoundaryMesh::pointBoundaryMesh(), pointBoundaryMesh::pointBoundaryMesh(), polyBoundaryMesh::polyBoundaryMesh(), polyBoundaryMesh::polyBoundaryMesh(), polyBoundaryMesh::polyBoundaryMesh(), polyBoundaryMesh::polyBoundaryMesh(), polyBoundaryMesh::polyBoundaryMesh(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), polyTopoChanger::polyTopoChanger(), populationBalanceModel::populationBalanceModel(), porosityModel::porosityModel(), porousModel::porousModel(), rawIOField< Type >::rawIOField(), refinementHistory::refinementHistory(), refinementHistory::refinementHistory(), refinementHistory::refinementHistory(), refinementHistory::refinementHistory(), refinementHistory::refinementHistory(), refinementHistory::refinementHistory(), refinementHistory::refinementHistory(), regIOobject(), regIOobject(), regIOobject(), regIOobject(), objectRegistry::resetCacheTemporaryObject(), objectRegistry::resetCacheTemporaryObject(), searchableSurface::searchableSurface(), SLGThermo::SLGThermo(), solarLoadBase::solarLoadBase(), solutionControl::solutionControl(), objectRegistry::sorted(), surfaceTensionModel::surfaceTensionModel(), surfaceTensionModel::surfaceTensionModel(), surfZoneIOList::surfZoneIOList(), surfZoneIOList::surfZoneIOList(), surfZoneIOList::surfZoneIOList(), topoSet::topoSet(), topoSet::topoSet(), topoSet::topoSet(), topoSet::topoSet(), topoSet::topoSet(), topoSet::topoSet(), topoSet::topoSet(), topoSet::topoSet(), topoSet::topoSet(), topoSet::topoSet(), TypeName(), UniformDimensionedField< Type >::UniformDimensionedField(), UniformDimensionedField< Type >::UniformDimensionedField(), UniformDimensionedField< Type >::UniformDimensionedField(), UniformDimensionedField< Type >::UniformDimensionedField(), UniformDimensionedField< Type >::UniformDimensionedField(), upToDate(), upToDate(), upToDate(), upToDate(), virtualMassModel::virtualMassModel(), decomposedBlockData::writeBlockEntry(), decomposedBlockData::writeObject(), objectRegistry::writeObject(), writeObject(), ZoneMesh< ZoneType, MeshType >::ZoneMesh(), ZoneMesh< ZoneType, MeshType >::ZoneMesh(), ZoneMesh< ZoneType, MeshType >::ZoneMesh(), ZoneMesh< ZoneType, MeshType >::ZoneMesh(), and ZoneMesh< ZoneType, MeshType >::ZoneMesh().

Here is the call graph for this function:

regIOobject() [2/5]

regIOobject

(

const regIOobject &

rio

)

Copy construct.

Definition at line 60 of file regIOobject.C.

References IOobject::clone(), IOobject::db(), and regIOobject().

Here is the call graph for this function:

regIOobject() [3/5]

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 checkIn(), checkOut(), IOobject::clone(), IOobject::db(), and regIOobject().

Here is the call graph for this function:

regIOobject() [4/5]

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 96 of file regIOobject.C.

References checkIn(), IOobject::clone(), IOobject::db(), IOobject::instance(), IOobject::local(), and regIOobject().

Here is the call graph for this function:

regIOobject() [5/5]

regIOobject	(	const IOobject &	io,
		const regIOobject &	rio )

Copy construct with new IO parameters.

Definition at line 120 of file regIOobject.C.

References checkIn(), IOobject::clone(), IOobject::db(), io, regIOobject(), and IOobjectOption::registerObject().

Here is the call graph for this function:

~regIOobject()

~regIOobject ( )

virtual

Destructor.

Definition at line 142 of file regIOobject.C.

References checkOut(), IOobject::db(), Foam::endl(), name, path(), Foam::Pout, and Foam::type().

Here is the call graph for this function:

Member Function Documentation

readHeaderOk()

bool readHeaderOk ( const IOstreamOption::streamFormat fmt, const word & typeName )

protected

Helper: check readOpt flags and read if necessary.

Definition at line 31 of file regIOobjectRead.C.

References UPstream::broadcast, Foam::fileHandler, IOobject::fileModificationChecking_masterOnly(), global(), Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, headerOk(), IOobjectOption::isReadOptional(), IOobjectOption::isReadRequired(), UPstream::master(), and UPstream::parRun().

Referenced by GlobalIOField< Type >::GlobalIOField(), GlobalIOField< Type >::GlobalIOField(), GlobalIOField< Type >::GlobalIOField(), GlobalIOField< Type >::GlobalIOField(), GlobalIOField< Type >::GlobalIOField(), GlobalIOList< Type >::GlobalIOList(), GlobalIOList< Type >::GlobalIOList(), GlobalIOList< Type >::GlobalIOList(), GlobalIOList< Type >::GlobalIOList(), GlobalIOList< Type >::GlobalIOList(), IOdictionary::IOdictionary(), localIOdictionary::localIOdictionary(), UniformDimensionedField< Type >::UniformDimensionedField(), UniformDimensionedField< Type >::UniformDimensionedField(), UniformDimensionedField< Type >::UniformDimensionedField(), UniformDimensionedField< Type >::UniformDimensionedField(), and unwatchedIOdictionary::unwatchedIOdictionary().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [1/2]

void operator= ( const regIOobject & )

delete

No copy assignment.

References regIOobject().

Here is the call graph for this function:

TypeName()

TypeName

(

"regIOobject"

)

Runtime type information.

References addWatch(), close(), eventNo(), filePath(), findMetaData(), getMetaData(), headerOk(), io, modified(), Foam::noexcept, ownedByRegistry(), p, read(), readData(), readIfModified(), regIOobject(), release(), removeMetaData(), rename(), setUpToDate(), store(), updateMetaData(), upToDate(), and watchIndices().

Here is the call graph for this function:

checkIn()

bool checkIn

(

)

Add object to registry, if not already registered.

Returns

true if object was already registered, or was newly registered

Definition at line 184 of file regIOobject.C.

References Foam::abort(), IOobject::db(), polyMesh::defaultRegion, Foam::endl(), Foam::FatalError, FatalErrorInFunction, Foam::flatOutput(), name, Foam::nl, IOobject::objectRelPath(), and WarningInFunction.

Referenced by multiDisplacementMotionSolver::multiDisplacementMotionSolver(), multiDisplacementMotionSolver::multiDisplacementMotionSolver(), operator=(), regIOobject(), regIOobject(), regIOobject(), regIOobject(), rename(), and store().

Here is the call graph for this function:

Here is the caller graph for this function:

checkOut()

bool checkOut

(

)

Remove object from registry, and remove all file watches.

Returns

true if object was registered and was removed

Definition at line 221 of file regIOobject.C.

References IOobject::db(), Foam::fileHandler, and forAllReverse.

Referenced by InterfaceForce< CloudType >::cacheFields(), LiftForce< CloudType >::cacheFields(), PressureGradientForce< CloudType >::cacheFields(), regionFunctionObject::clearObject(), regionFunctionObject::clearObjects(), removeRegisteredObject::execute(), multiDisplacementMotionSolver::multiDisplacementMotionSolver(), multiDisplacementMotionSolver::multiDisplacementMotionSolver(), operator=(), regIOobject(), rename(), motionSolver::stealRegistration(), lumpedPointDisplacementPointPatchVectorField::~lumpedPointDisplacementPointPatchVectorField(), and ~regIOobject().

Here is the call graph for this function:

Here is the caller graph for this function:

addWatch() [1/2]

void addWatch ( )

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(), addWatch(), Pstream::broadcasts(), f(), Foam::FatalError, FatalErrorInFunction, Foam::fileHandler, IOobject::fileModificationChecking_masterOnly(), filePath(), forAll, forAllReverse, global(), UPstream::master(), IOobject::objectPath(), UPstream::parRun(), UPstream::parRun(), DynamicList< T, SizeMin >::push_back(), IOobjectOption::READ_MODIFIED, IOobjectOption::readOpt(), List< T >::resize(), IOobject::time(), Foam::type(), and UPstream::worldComm.

Referenced by addWatch(), includeEntry::execute(), includeEntry::execute(), IOdictionary::IOdictionary(), IOdictionary::IOdictionary(), IOPtrList< T >::IOPtrList(), IOPtrList< T >::IOPtrList(), IOPtrList< T >::IOPtrList(), localIOdictionary::localIOdictionary(), localIOdictionary::localIOdictionary(), read(), IOPtrList< Foam::entry >::readContents(), schemesLookup::schemesLookup(), solution::solution(), TypeName(), and UniformDimensionedField< Type >::UniformDimensionedField().

Here is the call graph for this function:

Here is the caller graph for this function:

registered()

bool registered ( ) const

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.

References Foam::noexcept.

ownedByRegistry()

bool ownedByRegistry ( ) const

inlinenoexcept

Is this object owned by the registry?

Definition at line 30 of file regIOobjectI.H.

References Foam::noexcept.

Referenced by objectRegistry::clear(), regionFunctionObject::clearObject(), regionFunctionObject::clearObjects(), objectRegistry::erase(), removeRegisteredObject::execute(), and TypeName().

Here is the caller graph for this function:

store() [1/9]

bool store ( )

inline

Register object with its registry and transfer ownership to the registry.

Returns

true if now ownedByRegistry

Definition at line 36 of file regIOobjectI.H.

References checkIn(), name, Foam::nl, and WarningInFunction.

Referenced by fieldAverage::addMeanFieldType(), InterfaceForce< CloudType >::cacheFields(), LiftForce< CloudType >::cacheFields(), PressureGradientForce< CloudType >::cacheFields(), objectRegistry::cacheTemporaryObject(), codedBase::codeDict(), adjointBoundaryCondition< Type >::computePatchGrad(), mappedPatchBase::constructIOField(), cloud::createIOField(), fvMatrix< Type >::createOrUpdateLduPrimitiveAssembly(), CrankNicolsonDdtScheme< Type >::ddt0_(), electricPotential::electricPotential(), age::execute(), filmFlux::execute(), surfaceCourantNumber::execute(), forces::force(), forceCoeffs::forceCoeff(), histogramModel::getOrReadField(), resolutionIndexModel::getOrReadField(), gradScheme< Type >::grad(), gradScheme< Type >::grad(), heatTransferCoeff::heatTransferCoeff(), hydrostaticPressure::hydrostaticPressure(), volPointInterpolation::interpolate(), volPointInterpolation::interpolate(), LimitedScheme< Type, Limiter, LimitFunc >::limiter(), fvExpressionField::loadAndStore(), readFields::loadAndStore(), waveModel::lookupOrCreate(), forces::moment(), forceCoeffs::momentCoeff(), momentumError::momentumError(), lumpedPointDisplacementPointPatchVectorField::movement(), multiphaseInterHtcModel::multiphaseInterHtcModel(), coordinateSystems::New(), options::New(), GAMGAgglomeration::New(), GAMGAgglomeration::New(), GAMGAgglomeration::New(), polySurface::New(), processorColour::New(), zoneCPCStencil::New(), zoneDistribute::New(), polySurface::newField(), surfMesh::newField(), polySurface::polySurface(), HeatTransferCoeff< CloudType >::postEvolve(), NusseltNumber< CloudType >::postEvolve(), proudmanAcousticPower::proudmanAcousticPower(), reactingEulerHtcModel::reactingEulerHtcModel(), momentum::read(), resolutionIndexModel::read(), fvExprDriver::readAndRegister(), stabilityBlendingFactor::stabilityBlendingFactor(), regionFunctionObject::store(), store(), store(), store(), store(), store(), store(), store(), mappedPatchBase::storeField(), polySurface::storeField(), polySurface::storeField(), surfMesh::storeField(), surfMesh::storeField(), regionFunctionObject::storeInDb(), sampledSurface::storeRegistrySurface(), objectRegistry::subRegistry(), surfaceDistance::surfaceDistance(), TypeName(), wallShearStress::wallShearStress(), yPlus::yPlus(), and cellCellStencil::zoneID().

Here is the call graph for this function:

store() [2/9]

template<class Type>

Type & store ( Type * p )

inlinestatic

Transfer pointer ownership to its registry.

Returns

reference to the stored object

Definition at line 53 of file regIOobjectI.H.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and p.

Here is the call graph for this function:

store() [3/9]

template<class Type>

Type & store ( std::unique_ptr< Type > && ptr )

inlinestatic

Transfer pointer ownership to its registry.

Resets (clears) the parameter.

Returns

reference to the stored object

Definition at line 77 of file regIOobjectI.H.

References store().

Here is the call graph for this function:

store() [4/9]

template<class Type>

Type & store ( autoPtr< Type > & ptr )

inlinestatic

Transfer pointer ownership to its registry.

Resets (clears) the parameter.

Returns

reference to the stored object

Definition at line 85 of file regIOobjectI.H.

References autoPtr< T >::release(), and store().

Here is the call graph for this function:

store() [5/9]

template<class Type>

Type & store ( autoPtr< Type > && ptr )

inlinestatic

Transfer pointer ownership to its registry.

Resets (clears) the parameter.

Returns

reference to the stored object

Definition at line 93 of file regIOobjectI.H.

References store().

Here is the call graph for this function:

store() [6/9]

template<class Type>

Type & store ( refPtr< Type > & ptr )

inlinestatic

Transfer pointer ownership to its registry.

Changes parameter from PTR to CREF (do not rely on this).

Returns

reference to the stored object

Definition at line 101 of file regIOobjectI.H.

References refPtr< T >::cref(), refPtr< T >::get(), refPtr< T >::is_pointer(), p, refPtr< T >::release(), store(), and WarningInFunction.

Here is the call graph for this function:

store() [7/9]

template<class Type>

Type & store ( refPtr< Type > && ptr )

inlinestatic

Transfer pointer ownership to its registry.

Changes parameter from PTR to CREF (do not rely on this).

Returns

reference to the stored object

Definition at line 134 of file regIOobjectI.H.

References store().

Here is the call graph for this function:

store() [8/9]

template<class Type>

Type & store ( tmp< Type > & ptr )

inlinestatic

Transfer pointer ownership to its registry.

Changes parameter from PTR to CREF (do not rely on this).

Returns

reference to the stored object

Definition at line 142 of file regIOobjectI.H.

References tmp< T >::cref(), tmp< T >::get(), tmp< T >::is_pointer(), p, tmp< T >::protect(), tmp< T >::ptr(), store(), and WarningInFunction.

Here is the call graph for this function:

store() [9/9]

template<class Type>

Type & store ( tmp< Type > && ptr )

inlinestatic

Transfer pointer ownership to its registry.

Changes parameter from PTR to CREF (do not rely on this).

Returns

reference to the stored object

Definition at line 177 of file regIOobjectI.H.

References store().

Here is the call graph for this function:

release()

void release ( const bool unregister = false )

inlinenoexcept

Set object as not ownedByRegistry.

Parameters

unregister

optionally set as non-registered too

Definition at line 184 of file regIOobjectI.H.

Referenced by objectRegistry::clear(), objectRegistry::erase(), and TypeName().

Here is the caller graph for this function:

eventNo() [1/2]

Foam::label eventNo ( ) const

inlinenoexcept

Event number at last update.

Definition at line 195 of file regIOobjectI.H.

References Foam::noexcept.

Referenced by triSurfaceMesh::movePoints(), TypeName(), and upToDate().

Here is the caller graph for this function:

eventNo() [2/2]

Foam::label & eventNo ( )

inlinenoexcept

Event number at last update.

Definition at line 200 of file regIOobjectI.H.

References Foam::noexcept.

upToDate() [1/4]

bool upToDate

(

const regIOobject &

a

)

const

Return true if up-to-date with respect to given object.

Definition at line 403 of file regIOobject.C.

References eventNo(), Foam::labelMax, and regIOobject().

Referenced by TypeName(), upToDate(), upToDate(), and upToDate().

Here is the call graph for this function:

Here is the caller graph for this function:

upToDate() [2/4]

bool upToDate	(	const regIOobject &	a,
		const regIOobject &	b ) const

Return true if up-to-date with respect to given objects.

Definition at line 442 of file regIOobject.C.

References b, regIOobject(), and upToDate().

Here is the call graph for this function:

upToDate() [3/4]

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 452 of file regIOobject.C.

References b, regIOobject(), and upToDate().

Here is the call graph for this function:

upToDate() [4/4]

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 463 of file regIOobject.C.

References b, regIOobject(), and upToDate().

Here is the call graph for this function:

setUpToDate()

void setUpToDate

(

)

Set as up-to-date.

Definition at line 475 of file regIOobject.C.

References IOobject::db().

Referenced by GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), GeometricField< Type, PatchField, GeoMesh >::internalFieldRef(), GeometricField< Type, PatchField, GeoMesh >::primitiveFieldRef(), GeometricField< scalar, Foam::fvPatchField, Foam::volMesh >::primitiveFieldRef(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

rename()

void rename ( const word & newName )

virtual

Rename.

Reimplemented from IOobject.

Reimplemented in objectRegistry.

Definition at line 481 of file regIOobject.C.

References checkIn(), checkOut(), IOobjectOption::registerObject(), and IOobject::rename().

Referenced by RASModelVariables::copyAndRename(), if(), Foam::interpolate(), objectRegistry::rename(), variablesSet::renameTurbulenceField(), TypeName(), and topOVariablesBase::writeFluidSolidInterface().

Here is the call graph for this function:

Here is the caller graph for this function:

findMetaData()

const Foam::dictionary * findMetaData ( ) const

virtualnoexcept

Return pointer to meta-data or nullptr.

Reimplemented from IOobject.

Definition at line 26 of file regIOobjectMetaData.C.

References Foam::noexcept.

Referenced by TypeName().

Here is the caller graph for this function:

getMetaData()

Foam::dictionary & getMetaData ( )

noexcept

Get or create meta-data.

Definition at line 32 of file regIOobjectMetaData.C.

References dictionary, and Foam::noexcept.

Referenced by TypeName(), and ZoneMesh< ZoneType, MeshType >::updateMetaData().

Here is the caller graph for this function:

removeMetaData()

void removeMetaData

(

)

Remove meta-data.

Definition at line 42 of file regIOobjectMetaData.C.

Referenced by TypeName(), and ZoneMesh< ZoneType, MeshType >::updateMetaData().

Here is the caller graph for this function:

updateMetaData()

void updateMetaData ( )

virtual

Update internal meta-data (eg, prior to writing).

Reimplemented in ZoneMesh< ZoneType, MeshType >, ZoneMesh< cellZone, polyMesh >, ZoneMesh< faceZone, polyMesh >, ZoneMesh< faFaceZone, faMesh >, and ZoneMesh< pointZone, polyMesh >.

Definition at line 48 of file regIOobjectMetaData.C.

Referenced by TypeName(), and decomposedBlockData::writeObject().

Here is the caller graph for this function:

filePath()

Foam::fileName filePath ( ) const

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 baseIOdictionary, distributedTriSurfaceMesh, extendedFeatureEdgeMesh, featureEdgeMesh, GlobalIOField< Type >, GlobalIOField< label >, GlobalIOField< scalar >, GlobalIOField< sphericalTensor >, GlobalIOField< symmTensor >, GlobalIOField< tensor >, GlobalIOField< vector >, GlobalIOList< Type >, GlobalIOList< kinematicParcelInjectionData >, GlobalIOList< label >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< scalar >, GlobalIOList< sphericalTensor >, GlobalIOList< symmTensor >, GlobalIOList< tensor >, GlobalIOList< thermoParcelInjectionData >, GlobalIOList< vector >, IOdictionary, IOMap< T >, localIOdictionary, porosityModel, searchableSurface, triSurfaceMesh, UniformDimensionedField< Type >, UniformDimensionedField< label >, UniformDimensionedField< scalar >, UniformDimensionedField< sphericalTensor >, UniformDimensionedField< symmTensor >, UniformDimensionedField< tensor >, UniformDimensionedField< vector >, and unwatchedIOdictionary.

Definition at line 496 of file regIOobject.C.

References IOobject::localFilePath(), and Foam::type().

Referenced by addWatch(), headerOk(), decomposedBlockData::read(), readStream(), Time::setControls(), TypeName(), and Time::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

headerOk()

bool headerOk

(

)

Read and check header info. Does not check the headerClassName.

Definition at line 502 of file regIOobject.C.

References Foam::endl(), Foam::fileHandler, filePath(), IOWarningInFunction, IOobject::objectPath(), and Foam::type().

Referenced by decomposedBlockData::decomposedBlockData(), extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), faBoundaryMeshEntries::faBoundaryMeshEntries(), featureEdgeMesh::featureEdgeMesh(), fvExprDriverWriter::fvExprDriverWriter(), IOPtrList< T >::IOPtrList(), IOPtrList< T >::IOPtrList(), IOPtrList< T >::IOPtrList(), pointBoundaryMesh::pointBoundaryMesh(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), boundaryRegion::readDict(), cellTable::readDict(), waveModel::readDict(), readHeaderOk(), topoSet::readIOcontents(), schemesLookup::schemesLookup(), solution::solution(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

readStream()

Foam::Istream & readStream	(	const word &	expectName,
		const bool	readOnProc = true )

Return Istream and check object type against that given.

Definition at line 115 of file regIOobjectRead.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, filePath(), IOobject::headerClassName(), name, Foam::Pout, and Foam::type().

Here is the call graph for this function:

close()

void close

(

)

Close Istream.

Definition at line 158 of file regIOobjectRead.C.

References Foam::endl(), and Foam::Pout.

Referenced by extendedFeatureEdgeMesh::extendedFeatureEdgeMesh(), faBoundaryMeshEntries::faBoundaryMeshEntries(), featureEdgeMesh::featureEdgeMesh(), fieldDictionary::fieldDictionary(), IOPtrList< T >::IOPtrList(), IOPtrList< T >::IOPtrList(), IOPtrList< T >::IOPtrList(), lumpedPointIOMovement::lumpedPointIOMovement(), pointBoundaryMesh::pointBoundaryMesh(), polyBoundaryMeshEntries::polyBoundaryMeshEntries(), adjointRASModel::read(), refinementHistory::read(), IOPtrList< Foam::entry >::readContents(), topoSet::readIOcontents(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

readData()

bool readData ( Istream & )

virtual

Virtual readData function.

Must be defined in derived types for which re-reading is required

Reimplemented in baseIOdictionary, exprResultGlobals, fvExprDriverWriter, extendedFeatureEdgeMesh, featureEdgeMesh, GlobalIOField< Type >, GlobalIOField< label >, GlobalIOField< scalar >, GlobalIOField< sphericalTensor >, GlobalIOField< symmTensor >, GlobalIOField< tensor >, GlobalIOField< vector >, GlobalIOList< Type >, GlobalIOList< kinematicParcelInjectionData >, GlobalIOList< label >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< scalar >, GlobalIOList< sphericalTensor >, GlobalIOList< symmTensor >, GlobalIOList< tensor >, GlobalIOList< thermoParcelInjectionData >, GlobalIOList< vector >, IOmapDistribute, IOmapDistributePolyMesh, IOmapDistributePolyMeshRef, IOPosition< CloudType >, lumpedPointIOMovement, refinementHistory, UniformDimensionedField< Type >, UniformDimensionedField< label >, UniformDimensionedField< scalar >, UniformDimensionedField< sphericalTensor >, UniformDimensionedField< symmTensor >, UniformDimensionedField< tensor >, and UniformDimensionedField< vector >.

Definition at line 172 of file regIOobjectRead.C.

Referenced by TypeName().

Here is the caller graph for this function:

read()

bool read ( )

virtual

Read object.

Reimplemented in basicThermo, CombustionModel< ReactionThermo >, combustionModel, CombustionModel< psiReactionThermo >, CombustionModel< rhoReactionThermo >, diffusion< ReactionThermo, ThermoType >, diffusionMulticomponent< ReactionThermo, ThermoType >, EDC< ReactionThermo >, eddyDissipationDiffusionModel< ReactionThermo, ThermoType >, eddyDissipationModelBase< ReactionThermo, ThermoType >, FSD< ReactionThermo, ThermoType >, infinitelyFastChemistry< ReactionThermo, ThermoType >, laminar< ReactionThermo >, noCombustion< ReactionThermo >, PaSR< ReactionThermo >, singleStepCombustion< ReactionThermo, ThermoType >, zoneCombustion< ReactionThermo >, PDRkEpsilon, crankConRod, decomposedBlockData, EddyDiffusivity< compressible::turbulenceModel >, EddyDiffusivity< phaseCompressibleTurbulenceModel >, EddyDiffusivity< ThermalDiffusivity< PhaseCompressibleTurbulenceModel< phaseModel > > >, eddyViscosity< RASModel< EddyDiffusivity< compressible::turbulenceModel > > >, eddyViscosity< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >, eddyViscosity< RASModel< EddyDiffusivity< ThermalDiffusivity< PhaseCompressibleTurbulenceModel< phaseModel > > > > >, engineTime, options, caseInfo, options, heThermo< solidReactionThermo, SpecieMixturereactingMixtureconstIsoSolidTransportsensibleEnthalpyhConstThermorhoConstspecie >, heThermo< solidReactionThermo, SpecieMixturereactingMixtureconstIsoSolidTransportsensibleEnthalpyhPowerThermorhoConstspecie >, heThermo< solidThermo, pureMixture< constAnIsoSolidTransportsensibleEnthalpyhConstThermorhoConstspecie > >, heThermo< solidThermo, pureMixture< constIsoSolidTransportsensibleEnthalpyhConstThermorhoConstspecie > >, heThermo< solidThermo, pureMixture< exponentialSolidTransportsensibleEnthalpyhPowerThermorhoConstspecie > >, heThermo< solidThermo, pureMixture< hTransportThermoPoly8SolidThermoPhysics > >, heThermo< solidThermo, pureMixture< polynomialSolidTransportsensibleEnthalpyhPolynomialThermoicoPolynomialspecie > >, heThermo< solidThermo, pureMixture< tabulatedAnIsoSolidTransportsensibleEnthalpyhTabulatedThermoicoPolynomialspecie > >, heThermo< solidThermo, pureMixture< tabulatedSolidTransportsensibleEnthalpyhTabulatedThermoicoPolynomialspecie > >, heThermo< solidThermo, pureMixture< tabulatedSolidTransportsensibleEnthalpyhTabulatedThermoicoTabulatedspecie > >, heThermo< solidThermo, pureZoneMixture< constAnIsoSolidTransportsensibleEnthalpyhConstThermorhoConstspecie > >, heThermo< solidThermo, pureZoneMixture< constIsoSolidTransportsensibleEnthalpyhConstThermorhoConstspecie > >, heThermo< solidThermo, pureZoneMixture< exponentialSolidTransportsensibleEnthalpyhPowerThermorhoConstspecie > >, heThermo< solidThermo, pureZoneMixture< polynomialSolidTransportsensibleEnthalpyhPolynomialThermoicoPolynomialspecie > >, heThermo< solidThermo, pureZoneMixture< tabulatedSolidTransportsensibleEnthalpyhTabulatedThermoicoPolynomialspecie > >, heThermo< solidThermo, pureZoneMixture< tabulatedSolidTransportsensibleEnthalpyhTabulatedThermoicoTabulatedspecie > >, heThermo< solidThermo, SpecieMixturemultiComponentMixtureconstIsoSolidTransportsensibleEnthalpyhConstThermorhoConstspecie >, immiscibleIncompressibleTwoPhaseMixture, adjointRASModel, adjointkOmegaSST, adjointLaminar, adjointSpalartAllmaras, adjointTurbulenceModel, incompressibleThreePhaseMixture, incompressibleTwoPhaseInteractingMixture, incompressibleTwoPhaseMixture, IOMRFZoneList, IOporosityModelList, laminarModel< fluidThermoCompressibleTurbulenceModel >, Maxwell< fluidThermoCompressibleTurbulenceModel >, linearViscousStress< RASModel< EddyDiffusivity< compressible::turbulenceModel > > >, linearViscousStress< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >, linearViscousStress< RASModel< EddyDiffusivity< ThermalDiffusivity< PhaseCompressibleTurbulenceModel< phaseModel > > > > >, motionSolver, multiphaseSystem, phaseModel, multiphaseInterSystem, multiphaseMixture, multiphaseSystem, optimisationManager, PDRDragModel, phaseChangeTwoPhaseMixture, Kunz, Merkle, SchnerrSauer, phaseModel, phaseModel, phaseSystem, pimpleControl, pisoControl, porosityModel, fvDOM, laserDTRM, noRadiation, opaqueSolid, P1, radiationModel, solarLoad, viewFactor, RASModel< EddyDiffusivity< compressible::turbulenceModel > >, RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >, RASModel< EddyDiffusivity< ThermalDiffusivity< PhaseCompressibleTurbulenceModel< phaseModel > > > >, kEpsilon< EddyDiffusivity< compressible::turbulenceModel > >, kineticTheoryModel, kineticTheoryModel, phasePressureModel, phasePressureModel, refinementHistory, noPyrolysis, pyrolysisModel, reactingOneDim, thermo, regionModel1D, regionModel, singleLayerRegion, kinematicSingleLayer, surfaceFilmRegionModel, thermoSingleLayer, noThermo, thermalBaffle, thermalBaffleModel, rigidBodyMeshMotion, rigidBodyMeshMotionSolver, schemesLookup, SIMPLEControl, simpleControl, SIMPLEControlOpt, SIMPLEControlSingleRun, singlePhaseTransportModel, sixDoFRigidBodyMotionSolver, solidThermo, solution, solutionControl, rpm, SRFModel, temperaturePhaseChangeTwoPhaseMixture, constant, interfaceHeatResistance, thermoIncompressibleTwoPhaseMixture, Time, tolerances, turbulenceModel, twoPhaseMixtureEThermo, twoPhaseMixtureThermo, and twoPhaseSystem.

Definition at line 178 of file regIOobjectRead.C.

References addWatch(), IOstreamOption::BINARY, Foam::fileHandler, IOobject::fileModificationChecking_masterOnly(), forAllReverse, global(), and Foam::type().

Referenced by columnFvMesh::columnFvMesh(), phase::correct(), porosityModel::force(), PDRDragModel::Gk(), basicThermo::read(), combustionModel::read(), incompressibleTwoPhaseMixture::read(), IOMRFZoneList::read(), IOporosityModelList::read(), motionSolver::read(), multiphaseInterSystem::read(), multiphaseSystem::read(), optimisationManager::read(), phaseSystem::read(), radiationModel::read(), regionModel::read(), schemesLookup::read(), singlePhaseTransportModel::read(), solidThermo::read(), solution::read(), SRFModel::read(), tolerances::read(), turbulenceModel::read(), twoPhaseSystem::read(), SimplifiedDynamicFvMesh< DynamicMeshType >::SimplifiedDynamicFvMesh(), TypeName(), and caseInfo::~caseInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

addWatch() [2/2]

Foam::label addWatch ( const fileName & f )

virtual

Add file watch for fileName on object if not yet watched.

Returns

index of watch

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(), IOobjectOption::READ_MODIFIED, IOobjectOption::readOpt(), and IOobject::time().

Here is the call graph for this function:

watchIndices() [1/2]

const Foam::labelList & watchIndices ( ) const

inlinenoexcept

Read access to file-monitoring handles.

Definition at line 206 of file regIOobjectI.H.

References Foam::noexcept.

Referenced by fileOperation::addWatches(), masterUncollatedFileOperation::addWatches(), and TypeName().

Here is the caller graph for this function:

watchIndices() [2/2]

Foam::labelList & watchIndices ( )

inlinenoexcept

Write access to file-monitoring handles.

Definition at line 212 of file regIOobjectI.H.

References Foam::noexcept.

modified()

bool modified ( ) const

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 219 of file regIOobjectRead.C.

References Foam::fileHandler, forAllReverse, and fileMonitor::UNMODIFIED.

Referenced by readIfModified(), and TypeName().

Here is the caller graph for this function:

readIfModified()

bool readIfModified ( )

virtual

Read object if modified (as set by call to modified).

Reimplemented in objectRegistry.

Definition at line 233 of file regIOobjectRead.C.

References Foam::endl(), Foam::fileHandler, forAllReverse, InfoInFunction, modified(), name, Foam::read(), and fileMonitor::UNMODIFIED.

Referenced by TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

writeData()

virtual bool writeData ( Ostream & ) const

pure virtual

Pure virtual writeData function.

Must be defined in derived types

Implemented in adjointSimple, adjointSolver, adjointSolverManager, ATCModel, AveragingMethod< Type >, AveragingMethod< Foam::Vector< scalar > >, AveragingMethod< scalar >, baseIOdictionary, BlendedInterfacialModel< ModelType >, BlendedInterfacialModel< Foam::dragModel >, BlendedInterfacialModel< Foam::heatTransferModel >, BlendedInterfacialModel< Foam::liftModel >, BlendedInterfacialModel< Foam::turbulentDispersionModel >, BlendedInterfacialModel< Foam::virtualMassModel >, BlendedInterfacialModel< Foam::wallLubricationModel >, cellPointConnectivity, CompactIOField< T >, CompactIOField< diagTensorField >, CompactIOField< labelField >, CompactIOField< scalarField >, CompactIOField< sphericalTensorField >, CompactIOField< symmTensorField >, CompactIOField< tensorField >, CompactIOField< vector2DField >, CompactIOField< vectorField >, CompactIOList< T >, CompactIOList< cell >, CompactIOList< edge >, CompactIOList< face >, CompactIOList< labelList >, CompactIOList< scalarList >, CompactIOList< vectorList >, conjugateGradient, coordinateSystems, decomposedBlockData, populationBalanceModel, DimensionedField< Type, GeoMesh >, DimensionedField< label, polySurfaceGeoMesh >, DimensionedField< label, polySurfacePointGeoMesh >, DimensionedField< label, surfGeoMesh >, DimensionedField< label, surfPointGeoMesh >, DimensionedField< label, triSurfaceGeoMesh >, DimensionedField< label, triSurfacePointGeoMesh >, DimensionedField< scalar, polyGeoMesh >, DimensionedField< scalar, polySurfaceGeoMesh >, DimensionedField< scalar, polySurfacePointGeoMesh >, DimensionedField< scalar, surfGeoMesh >, DimensionedField< scalar, surfPointGeoMesh >, DimensionedField< scalar, triSurfaceGeoMesh >, DimensionedField< scalar, triSurfacePointGeoMesh >, DimensionedField< sphericalTensor, polyGeoMesh >, DimensionedField< sphericalTensor, polySurfaceGeoMesh >, DimensionedField< sphericalTensor, polySurfacePointGeoMesh >, DimensionedField< sphericalTensor, surfGeoMesh >, DimensionedField< sphericalTensor, surfPointGeoMesh >, DimensionedField< sphericalTensor, triSurfaceGeoMesh >, DimensionedField< sphericalTensor, triSurfacePointGeoMesh >, DimensionedField< symmTensor, polyGeoMesh >, DimensionedField< symmTensor, polySurfaceGeoMesh >, DimensionedField< symmTensor, polySurfacePointGeoMesh >, DimensionedField< symmTensor, surfGeoMesh >, DimensionedField< symmTensor, surfPointGeoMesh >, DimensionedField< symmTensor, triSurfaceGeoMesh >, DimensionedField< symmTensor, triSurfacePointGeoMesh >, DimensionedField< tensor, polyGeoMesh >, DimensionedField< tensor, polySurfaceGeoMesh >, DimensionedField< tensor, polySurfacePointGeoMesh >, DimensionedField< tensor, surfGeoMesh >, DimensionedField< tensor, surfPointGeoMesh >, DimensionedField< tensor, triSurfaceGeoMesh >, DimensionedField< tensor, triSurfacePointGeoMesh >, DimensionedField< Type, areaMesh >, DimensionedField< Type, edgeMesh >, DimensionedField< Type, pointMesh >, DimensionedField< Type, polySurfaceGeoMesh >, DimensionedField< Type, polySurfacePointGeoMesh >, DimensionedField< Type, surfaceMesh >, DimensionedField< Type, volMesh >, DimensionedField< vector, pointMesh >, DimensionedField< vector, polyGeoMesh >, DimensionedField< vector, polySurfaceGeoMesh >, DimensionedField< vector, polySurfacePointGeoMesh >, DimensionedField< vector, surfGeoMesh >, DimensionedField< vector, surfPointGeoMesh >, DimensionedField< vector, triSurfaceGeoMesh >, DimensionedField< vector, triSurfacePointGeoMesh >, dragModel, dragModel, dynamicTopODesignVariables, exprResultGlobals, fvExprDriverWriter, extendedFeatureEdgeMesh, faBoundaryMesh, faBoundaryMeshEntries, featureEdgeMesh, fieldDictionary, GeometricField< Type, PatchField, GeoMesh >, GeometricField< Foam::SphericalTensor< scalar >, Foam::faePatchField, Foam::edgeMesh >, GeometricField< Foam::SphericalTensor< scalar >, Foam::faPatchField, Foam::areaMesh >, GeometricField< Foam::SymmTensor< scalar >, Foam::faePatchField, Foam::edgeMesh >, GeometricField< Foam::SymmTensor< scalar >, Foam::faPatchField, Foam::areaMesh >, GeometricField< Foam::Tensor< scalar >, Foam::faePatchField, Foam::edgeMesh >, GeometricField< Foam::Tensor< scalar >, Foam::faPatchField, Foam::areaMesh >, GeometricField< Foam::Vector< scalar >, Foam::faePatchField, Foam::edgeMesh >, GeometricField< Foam::Vector< scalar >, Foam::faPatchField, Foam::areaMesh >, GeometricField< Foam::Vector< scalar >, Foam::fvPatchField, Foam::volMesh >, GeometricField< Foam::Vector< scalar >, Foam::pointPatchField, Foam::pointMesh >, GeometricField< scalar, faePatchField, edgeMesh >, GeometricField< scalar, faPatchField, areaMesh >, GeometricField< scalar, Foam::faePatchField, Foam::edgeMesh >, GeometricField< scalar, Foam::faPatchField, Foam::areaMesh >, GeometricField< scalar, Foam::fvPatchField, Foam::volMesh >, GeometricField< scalar, Foam::pointPatchField, Foam::pointMesh >, GeometricField< scalar, fvPatchField, volMesh >, GeometricField< scalar, fvsPatchField, surfaceMesh >, GeometricField< scalar, pointPatchField, pointMesh >, GeometricField< sphericalTensor, faePatchField, edgeMesh >, GeometricField< sphericalTensor, faPatchField, areaMesh >, GeometricField< sphericalTensor, fvPatchField, volMesh >, GeometricField< sphericalTensor, fvsPatchField, surfaceMesh >, GeometricField< sphericalTensor, pointPatchField, pointMesh >, GeometricField< symmTensor, faePatchField, edgeMesh >, GeometricField< symmTensor, faPatchField, areaMesh >, GeometricField< symmTensor, fvPatchField, volMesh >, GeometricField< symmTensor, fvsPatchField, surfaceMesh >, GeometricField< symmTensor, pointPatchField, pointMesh >, GeometricField< tensor, faePatchField, edgeMesh >, GeometricField< tensor, faPatchField, areaMesh >, GeometricField< tensor, fvPatchField, volMesh >, GeometricField< tensor, fvsPatchField, surfaceMesh >, GeometricField< tensor, pointPatchField, pointMesh >, GeometricField< Type, faePatchField, edgeMesh >, GeometricField< Type, faPatchField, areaMesh >, GeometricField< Type, Foam::fvPatchField, Foam::volMesh >, GeometricField< Type, Foam::fvsPatchField, Foam::surfaceMesh >, GeometricField< Type, Foam::pointPatchField, Foam::pointMesh >, GeometricField< Type, fvPatchField, volMesh >, GeometricField< Type, fvsPatchField, surfaceMesh >, GeometricField< Type, pointPatchField, pointMesh >, GeometricField< typename flux< Type >::type, fvsPatchField, surfaceMesh >, GeometricField< value_type, fvPatchField, volMesh >, GeometricField< vector, faePatchField, edgeMesh >, GeometricField< vector, faPatchField, areaMesh >, GeometricField< vector, fvPatchField, volMesh >, GeometricField< vector, fvsPatchField, surfaceMesh >, GeometricField< vector, pointPatchField, pointMesh >, GlobalIOField< Type >, GlobalIOField< label >, GlobalIOField< scalar >, GlobalIOField< sphericalTensor >, GlobalIOField< symmTensor >, GlobalIOField< tensor >, GlobalIOField< vector >, GlobalIOList< Type >, GlobalIOList< kinematicParcelInjectionData >, GlobalIOList< label >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< scalar >, GlobalIOList< sphericalTensor >, GlobalIOList< symmTensor >, GlobalIOList< tensor >, GlobalIOList< thermoParcelInjectionData >, GlobalIOList< vector >, adjointTurbulenceModel, IOField< Type >, IOField< bool >, IOField< diagTensor >, IOField< diagTensorField >, IOField< label >, IOField< labelField >, IOField< quaternion >, IOField< scalar >, IOField< scalarField >, IOField< sphericalTensor >, IOField< sphericalTensorField >, IOField< symmTensor >, IOField< symmTensorField >, IOField< tensor >, IOField< tensorField >, IOField< triad >, IOField< vector >, IOField< vector2D >, IOField< vector2DField >, IOField< vectorField >, IOFieldRef< Type >, IOList< T >, IOList< cell >, IOList< cellShape >, IOList< edge >, IOList< face >, IOList< label >, IOList< labelList >, IOList< pointIndexHit >, IOList< scalar >, IOList< scalarList >, IOList< string >, IOList< stringList >, IOList< vector >, IOList< vectorList >, IOList< word >, IOList< wordList >, IOListRef< T >, IOMap< T >, IOmapDistribute, IOmapDistributePolyMesh, IOmapDistributePolyMeshRef, IOPosition< CloudType >, IOPtrList< T >, IOPtrList< Foam::entry >, ISQP, LBFGS, lduPrimitiveMeshAssembly, levelSetDesignVariables, lumpedPointIOMovement, MeshObject< faMesh, MoveableMeshObject, leastSquaresFaVectors >, MeshObject< fvMesh, GeometricMeshObject, boundaryRadiationProperties >, MeshObject< fvMesh, MoveableMeshObject, cellCellStencilObject >, MeshObject< fvMesh, MoveableMeshObject, CentredFitData< Polynomial > >, MeshObject< fvMesh, MoveableMeshObject, CentredFitSnGradData< Polynomial > >, MeshObject< fvMesh, MoveableMeshObject, FitDataType >, MeshObject< fvMesh, MoveableMeshObject, leastSquaresVectors >, MeshObject< fvMesh, MoveableMeshObject, LeastSquaresVectors< Stencil > >, MeshObject< fvMesh, MoveableMeshObject, skewCorrectionVectors >, MeshObject< fvMesh, MoveableMeshObject, UpwindFitData< Polynomial > >, MeshObject< fvMesh, TopologicalMeshObject, centredCECCellToCellStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCECCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCCellToCellStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCFCFaceToCellStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCPCCellToCellStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredCPCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, centredFECCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, pureUpwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindCECCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindCFCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindCPCCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, upwindFECCellToFaceStencilObject >, MeshObject< fvMesh, TopologicalMeshObject, zoneCPCStencil >, MeshObject< fvMesh, TopologicalMeshObject, zoneDistribute >, MeshObject< fvMesh, UpdateableMeshObject, volBSplinesBase >, MeshObject< fvMesh, UpdateableMeshObject, volPointInterpolation >, MeshObject< fvMesh, UpdateableMeshObject, volPointInterpolationAdjoint >, MeshObject< fvMesh, UpdateableMeshObject, wallDist >, MeshObject< fvMesh, UpdateableMeshObject, wallDistAddressing >, MeshObject< lduMesh, MoveableMeshObject, GAMGAgglomeration >, MeshObject< lduMesh, MoveableMeshObject, processorColour >, MeshObject< pointMesh, UpdateableMeshObject, pointConstraints >, MeshObject< polyMesh, GeometricMeshObject, meshSearchFACE_CENTRE_TRISMeshObject >, MeshObject< polyMesh, GeometricMeshObject, meshSearchMeshObject >, MeshObject< polyMesh, MoveableMeshObject, cellAspectRatio >, MeshObject< polyMesh, TopologicalMeshObject, regionSplit >, MeshObject< polyMesh, UpdateableMeshObject, decompositionModel >, MeshObject< polyMesh, UpdateableMeshObject, faMeshesRegistry >, MeshObject< polyMesh, UpdateableMeshObject, manifoldCellsMeshObject >, MeshObject< polyMesh, UpdateableMeshObject, pointMesh >, MeshObject< polyMesh, UpdateableMeshObject, twoDPointCorrector >, MeshObject< Time, TopologicalMeshObject, meshObjects::gravity >, MeshObject< Time, TopologicalMeshObject, multiWorldConnections >, MMA, surfaceTensionModel, nullSpace, NURBS3DVolume, objective, objectiveManager, objectivePartialVolume, objectRegistry, PDRDragModel, pointBoundaryMesh, polyBoundaryMesh, polyBoundaryMeshEntries, polyTopoChanger, porosityModel, DarcyForchheimer, fixedCoeff, powerLaw, powerLawLopesdaCosta, solidification, porousModel, profiling, quasiNewton, solarLoadBase, RASTurbulenceModel, rawIOField< Type >, surfaceTensionModel, refinementHistory, searchableBox, searchableCone, searchableCylinder, searchableDisk, searchableExtrudedCircle, searchablePlane, searchablePlate, searchableRotatedBox, searchableSphere, searchableSurfaceCollection, searchableSurfaceWithGaps, simple, SLGThermo, solutionControl, solver, SQP, surfaceTensionModel, constant, liquidProperties, temperatureDependent, surfZoneIOList, topODesignVariables, topoSet, triSurfaceMesh, TypeGrad< Type >, UniformDimensionedField< Type >, UniformDimensionedField< label >, UniformDimensionedField< scalar >, UniformDimensionedField< sphericalTensor >, UniformDimensionedField< symmTensor >, UniformDimensionedField< tensor >, UniformDimensionedField< vector >, updateMethod, virtualMassModel, virtualMassModel, volumetricBSplinesDesignVariables, ZoneMesh< ZoneType, MeshType >, ZoneMesh< cellZone, polyMesh >, ZoneMesh< faceZone, polyMesh >, ZoneMesh< faFaceZone, faMesh >, and ZoneMesh< pointZone, polyMesh >.

References write(), writeData(), and writeObject().

Referenced by writeData(), searchableSurfaceWithGaps::writeData(), and mappedPatchBase::writeDict().

Here is the call graph for this function:

Here is the caller graph for this function:

writeObject() [1/2]

bool writeObject ( IOstreamOption streamOpt, const bool writeOnProc ) const

virtual

Write using stream options.

uncomment this if you want to write global objects on master only

bool isGlobal = global();

Reimplemented in cellZoneSet, Cloud< ParticleType >, Cloud< Foam::DSMCParcel< particle > >, Cloud< Foam::DTRMParticle >, Cloud< Foam::molecule >, Cloud< Foam::passiveParticle >, Cloud< indexedParticle >, Cloud< injectedParticle >, Cloud< molecule >, Cloud< ParcelType >, Cloud< passiveParticle >, Cloud< passivePositionParticle >, Cloud< solidParticle >, Cloud< streamLineParticle >, Cloud< typename Foam::DSMCParcel< particle > >, Cloud< wallBoundedStreamLineParticle >, CompactIOField< T >, CompactIOField< diagTensorField >, CompactIOField< labelField >, CompactIOField< scalarField >, CompactIOField< sphericalTensorField >, CompactIOField< symmTensorField >, CompactIOField< tensorField >, CompactIOField< vector2DField >, CompactIOField< vectorField >, CompactIOList< T >, CompactIOList< cell >, CompactIOList< edge >, CompactIOList< face >, CompactIOList< labelList >, CompactIOList< scalarList >, CompactIOList< vectorList >, coordinateSystems, decomposedBlockData, distributedTriSurfaceMesh, dynamicOversetFvMesh, dynamicRefineFvMesh, faBoundaryMesh, faBoundaryMeshEntries, faceZoneSet, faMeshesRegistry, fvMesh, motionSolver, objectRegistry, pointMesh, pointZoneSet, polyBoundaryMesh, polyBoundaryMeshEntries, polyMesh, polySurface, profiling, rigidBodyMeshMotion, rigidBodyMeshMotionSolver, sixDoFRigidBodyMotionSolver, staticOversetFvMesh, surfMesh, Time, triSurfaceMesh, and unmappedPassivePositionParticleCloud.

Definition at line 28 of file regIOobjectWrite.C.

References Foam::endl(), Foam::fileHandler, IOobject::fileModificationChecking_masterOnly(), IOobject::good(), IOobject::instance(), UPstream::master(), IOobject::name(), IOobject::objectPath(), Foam::Pout, regIOobject(), SeriousErrorInFunction, Foam::system(), IOobject::time(), Time::timeName(), and timeName.

Referenced by write(), writeData(), cellZoneSet::writeObject(), CompactIOField< T >::writeObject(), CompactIOList< T >::writeObject(), coordinateSystems::writeObject(), faBoundaryMesh::writeObject(), faBoundaryMeshEntries::writeObject(), faceZoneSet::writeObject(), oversetFvMeshBase::writeObject(), pointZoneSet::writeObject(), polyBoundaryMesh::writeObject(), polyBoundaryMeshEntries::writeObject(), profiling::writeObject(), and writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

write()

bool write ( const bool writeOnProc = true ) const

virtual

Write using setting from DB.

Reimplemented in AveragingMethod< Type >, AveragingMethod< Foam::Vector< scalar > >, AveragingMethod< scalar >, extendedFeatureEdgeMesh, faMesh, caseInfo, fvMesh, incompressibleAdjointSolver, incompressiblePrimalSolver, IOPosition< CloudType >, objective, objectiveIncompressible, SIMPLEControl, SIMPLEControlOpt, SIMPLEControlSingleRun, solver, and TypeGrad< Type >.

Definition at line 128 of file regIOobjectWrite.C.

References IOobject::time(), and writeObject().

Referenced by topOZones::addIOcellsZone(), levelSetDesignVariables::assembleSensitivities(), topODesignVariables::assembleSensitivities(), DarcyForchheimer::calcTransformModelData(), hydrostaticPressure::calculateAndWrite(), columnFvMesh::columnFvMesh(), hexRef8::consistentSlowRefinement2(), ShapeSensitivitiesBase::constructAndWriteSensitivityField(), ShapeSensitivitiesBase::constructAndWriteSensitivtyPointField(), sensitivitySurfacePoints::constructGlobalPointNormalsAndAreas(), diffusionMulticomponent< ReactionThermo, ThermoType >::correct(), contactAngleForce::correct(), filmSeparation::correct(), thixotropicViscosity::correct(), limitedSnGrad< Type >::correction(), distanceSurface::createGeometry(), snappySnapDriver::doSnap(), meshRefinement::dumpRefinementLevel(), dynamicRefineFvMesh::init(), isoSurfaceCell::isoSurfaceCell(), isoSurfacePoint::isoSurfacePoint(), isoSurfaceTopo::isoSurfaceTopo(), diffusionGasEvaporation< Thermo, OtherThermo >::Kexp(), meshRefinement::mergeEdgesUndo(), meshRefinement::mergePatchFacesUndo(), polyMesh::movePoints(), KinematicCloud< Foam::DSMCCloud< dsmcParcel > >::patchData(), snappySnapDriver::scaleMesh(), FriedrichModel::separatedMassRatio(), hexRef8::setRefinement(), removeFaces::setRefinement(), hexRef8::setUnrefinement(), snappySnapDriver::smoothDisplacement(), sensitivitySurface::smoothSensitivities(), oversetFvMeshBase::solveOverset(), surfMesh::storeField(), incompressibleAdjointSolver::topOSensMultiplier(), marchingCells::update(), NURBS3DVolumeCylindrical::updateLocalCoordinateSystem(), columnAverage::write(), dsmcFields::write(), electricPotential::write(), momentum::write(), ObukhovLength::write(), processorField::write(), regionSizeDistribution::write(), solverInfo::write(), surfaceInterpolate::write(), writeCellCentres::write(), writeObjects::write(), XiReactionRate::write(), zeroGradient::write(), fvMesh::write(), IOPosition< CloudType >::write(), oversetFvMeshBase::writeAgglomeration(), triSurfaceTools::writeCloseness(), triSurfaceTools::writeCurvature(), writeData(), Foam::edgeMeshTools::writeFeatureProximity(), CollidingParcel< ParcelType >::writeFields(), molecule::writeFields(), ReactingHeterogeneousParcel< ParcelType >::writeFields(), streamLineParticle::writeFields(), wallBoundedParticle::writeFields(), wallBoundedStreamLineParticle::writeFields(), topOVariablesBase::writeFluidSolidInterface(), dynamicRefineFvMesh::writeObject(), regionFunctionObject::writeObject(), isoAdvection::writeSurfaceCells(), volFieldValue::writeValues(), caseInfo::~caseInfo(), and extendedFeatureEdgeMesh::~extendedFeatureEdgeMesh().

Here is the call graph for this function:

global()

virtual bool global ( ) const

inlinevirtual

Is object global.

Reimplemented in baseIOdictionary, distributedTriSurfaceMesh, extendedFeatureEdgeMesh, featureEdgeMesh, GlobalIOField< Type >, GlobalIOField< label >, GlobalIOField< scalar >, GlobalIOField< sphericalTensor >, GlobalIOField< symmTensor >, GlobalIOField< tensor >, GlobalIOField< vector >, GlobalIOList< Type >, GlobalIOList< kinematicParcelInjectionData >, GlobalIOList< label >, GlobalIOList< reactingMultiphaseParcelInjectionData >, GlobalIOList< reactingParcelInjectionData >, GlobalIOList< scalar >, GlobalIOList< sphericalTensor >, GlobalIOList< symmTensor >, GlobalIOList< tensor >, GlobalIOList< thermoParcelInjectionData >, GlobalIOList< vector >, IOdictionary, IOMap< T >, localIOdictionary, porosityModel, searchableSurface, triSurfaceMesh, UniformDimensionedField< Type >, UniformDimensionedField< label >, UniformDimensionedField< scalar >, UniformDimensionedField< sphericalTensor >, UniformDimensionedField< symmTensor >, UniformDimensionedField< tensor >, UniformDimensionedField< vector >, and unwatchedIOdictionary.

Definition at line 504 of file regIOobject.H.

References global().

Referenced by addWatch(), includeEtcEntry::execute(), includeEtcEntry::execute(), global(), read(), and readHeaderOk().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=() [2/2]

void operator=

(

const IOobject &

io

)

Copy assignment.

Definition at line 523 of file regIOobject.C.

References checkIn(), checkOut(), io, IOobject::operator=(), and IOobjectOption::registerObject().

Here is the call graph for this function:

writeObject() [2/2]

virtual bool writeObject ( IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp, const bool writeOnProc ) const

inlinevirtual

Write using given format, version and compression.

Definition at line 525 of file regIOobject.H.

References writeObject().

Here is the call graph for this function:

Friends And Related Symbol Documentation

functionEntries::codeStream

friend class functionEntries::codeStream

friend

Friendship with classes needing access to masterOnlyReading.

Definition at line 142 of file regIOobject.H.

fileOperations::uncollatedFileOperation

friend class fileOperations::uncollatedFileOperation

friend

Definition at line 143 of file regIOobject.H.

Member Data Documentation

masterOnlyReading

bool masterOnlyReading = false

staticprotected

To flag master-only reading of objects.

Definition at line 86 of file regIOobject.H.

Referenced by codeStream::doingMasterOnlyReading(), and uncollatedFileOperation::read().

---

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

• src/OpenFOAM/db/regIOobject/regIOobject.H
• src/OpenFOAM/db/regIOobject/regIOobject.C
• src/OpenFOAM/db/regIOobject/regIOobjectI.H
• src/OpenFOAM/db/regIOobject/regIOobjectMetaData.C
• src/OpenFOAM/db/regIOobject/regIOobjectRead.C
• src/OpenFOAM/db/regIOobject/regIOobjectWrite.C