A globally available registry of expression results. These are currently registered on Time (may change in the future). More...

Inheritance diagram for exprResultGlobals:

[legend]

Collaboration diagram for exprResultGlobals:

[legend]

Classes
class	Table
	The table of results. More...

Public Member Functions
	TypeNameNoDebug ("exprResultGlobals")
	Runtime type information. More...

virtual	~exprResultGlobals ()=default
	Destructor. More...

Table &	getNamespace (const word &name)
	Get an existing table for the namespace. More...

const exprResult &	get (const word &name, const wordUList &scopes) const
	Return a global variable, if it exists, or a exprResult::null. More...

exprResult &	addValue (const word &name, const word &scope, const exprResult &value, const bool overwrite=true)
	Add named result to specified scope. More...

exprResult &	addValue (const word &name, const word &scope, autoPtr< exprResult > &&value, const bool overwrite=true)
	Add named result to specified scope. More...

exprResult &	addValue (const dictionary &dict, const word &scope="", const bool overwrite=true)
	Extract result from dictionary and add to the scope. More...

bool	removeValue (const word &name, const word &scope)
	Remove named result from specified scope. More...

virtual bool	writeData (Ostream &os) const
	Write variables. More...

virtual bool	readData (Istream &os)
	Read variables. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &io, const bool isTimeObject=false)

	regIOobject (const regIOobject &rio)
	Copy construct. More...

	regIOobject (const regIOobject &rio, bool registerCopy)

	regIOobject (const word &newName, const regIOobject &, bool registerCopy)

	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 all file watches and remove object from registry. More...

virtual void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

bool	store ()

void	release (const bool unregister=false)
	Release ownership of this object from its registry. More...

label	eventNo () const
	Event number at last update. More...

label &	eventNo ()
	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. More...

Istream &	readStream (const word &, const bool valid=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. 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
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstreamOption streamOpt, const bool valid) const
	Write using stream options. More...

virtual bool	write (const bool valid=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 comp, const bool valid) 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 &registry, readOption r=NO_READ, writeOption w=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 &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true, bool globalObject=false)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Copy construct, resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Copy construct, resetting name. More...

	IOobject (const IOobject &io, readOption, writeOption)
	Copy construct, resetting io options. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

const objectRegistry &	db () const noexcept
	Return the local objectRegistry. More...

const Time &	time () const
	Return Time associated with the objectRegistry. More...

const word &	name () const noexcept
	Return 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
	Return non-constant access to the optional note. More...

bool	registerObject () const noexcept
	Should object created with this IOobject be registered? More...

bool	registerObject (bool on) noexcept
	Change registration preference, return previous value. More...

bool	globalObject () const noexcept
	Is object same for all processors? More...

bool	globalObject (bool on) noexcept
	Change global-object status, return previous value. 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...

bool	isHeaderClassName (const word &clsName) const
	Test if headerClassName() equals the given class name. More...

template<class Type >
bool	isHeaderClassName () const
	Test if headerClassName() equals Type::typeName. More...

readOption	readOpt () const noexcept
	The read option. More...

readOption	readOpt (readOption opt) noexcept
	Change the read option, return previous value. More...

writeOption	writeOpt () const noexcept
	The write option. More...

writeOption	writeOpt (writeOption opt) noexcept
	Change the write option, return previous value. 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

const fileName &	caseName () const

const fileName &	instance () const noexcept

fileName &	instance () noexcept

const fileName &	local () const noexcept

fileName	path () const
	The complete path. More...

fileName	path (const word &instance, const fileName &local=fileName::null) const
	The complete path with alternative instance and local. More...

fileName	objectPath () const
	The complete 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
	Helper for filePath that searches locally. More...

fileName	globalFilePath (const word &typeName, const bool search=true) const
	Helper for filePath that searches up if in parallel. More...

IOstreamOption	parseHeader (const dictionary &headerDict)

bool	readHeader (Istream &is)

bool	readHeader (dictionary &headerDict, Istream &is)

template<class Type >
bool	typeHeaderOk (const bool checkType=true, const bool search=true, const bool verbose=true)
	Read header (uses typeFilePath to find file) and check its info. 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

void	writeHeader (dictionary &dict, const word &objectType, IOstreamOption streamOpt) const

bool	good () const noexcept

bool	bad () const noexcept

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &io)

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

template<>
bool	isHeaderClassName () const
	Specialization for `void` always returns true (no headerClassName check). More...

template<class StringType >
Foam::word	groupName (StringType base, const word &group)

Static Public Member Functions
static exprResultGlobals &	New (const objectRegistry &obr)
	Static constructor for singleton. More...

static bool	Delete (const objectRegistry &obr)
	Static destructor for singleton. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *p)
	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 an 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 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...

Additional Inherited Members
Public Types inherited from IOobject
enum	objectState : char { GOOD, BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption : char { MUST_READ, MUST_READ_IF_MODIFIED, READ_IF_PRESENT, NO_READ }
	Enumeration defining the read options. More...

enum	writeOption : char { AUTO_WRITE = 0, NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes : char { timeStamp, timeStampMaster, inotify, inotifyMaster }
	Enumeration defining the file checking options. 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...

Protected Member Functions inherited from regIOobject
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 Member Functions inherited from IOobject
static void	writeHeaderContent (Ostream &os, const IOobject &io, const word &objectType, const dictionary *metaDataDict=nullptr)

static void	writeHeaderContent (dictionary &dict, const IOobject &io, const word &objectType, IOstreamOption streamOpt, const dictionary *metaDataDict=nullptr)

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

Detailed Description

A globally available registry of expression results. These are currently registered on Time (may change in the future).

Note: The storage mechanism is similar to a MeshObject, but always stores on Time and flushes stale values according to the time index.

Source files

Definition at line 61 of file exprResultGlobals.H.

Constructor & Destructor Documentation

◆ ~exprResultGlobals()

virtual ~exprResultGlobals ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeNameNoDebug()

TypeNameNoDebug ( "exprResultGlobals" )

Runtime type information.

◆ New()

Foam::expressions::exprResultGlobals & New ( const objectRegistry & obr )

static

Static constructor for singleton.

Definition at line 119 of file exprResultGlobals.C.

References objectRegistry::getObjectPtr(), objectRegistry::time(), and TimeState::timeIndex().

Referenced by fvExprDriver::lookupGlobal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Delete()

bool Delete ( const objectRegistry & obr )

static

Static destructor for singleton.

Definition at line 146 of file exprResultGlobals.C.

References objectRegistry::checkOut(), objectRegistry::getObjectPtr(), and objectRegistry::time().

Here is the call graph for this function:

◆ getNamespace()

Foam::expressions::exprResultGlobals::Table & getNamespace ( const word & name )

Get an existing table for the namespace.

Definition at line 190 of file exprResultGlobals.C.

References IOobject::name().

Here is the call graph for this function:

◆ get()

const Foam::expressions::exprResult & get	(	const word &	name,
		const wordUList &	scopes
	)		const

Return a global variable, if it exists, or a exprResult::null.

Definition at line 198 of file exprResultGlobals.C.

References IOobject::name(), Foam::nl, exprResult::null, and WarningInFunction.

Referenced by fvExprDriver::lookupGlobal().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addValue() [1/3]

Foam::expressions::exprResult & addValue	(	const word &	name,
		const word &	scope,
		const exprResult &	value,
		const bool	overwrite = `true`
	)

Add named result to specified scope.

Definition at line 232 of file exprResultGlobals.C.

References IOobject::name(), and HashPtrTable< T, Key, Hash >::set().

Referenced by exprResultGlobals::addValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addValue() [2/3]

Foam::expressions::exprResult & addValue	(	const word &	name,
		const word &	scope,
		autoPtr< exprResult > &&	value,
		const bool	overwrite = `true`
	)

Add named result to specified scope.

Definition at line 259 of file exprResultGlobals.C.

References IOobject::name(), and HashPtrTable< T, Key, Hash >::set().

Here is the call graph for this function:

◆ addValue() [3/3]

Foam::expressions::exprResult & addValue	(	const dictionary &	dict,
		const word &	scope = `""`,
		const bool	overwrite = `true`
	)

Extract result from dictionary and add to the scope.

Controlled by dictionary entries:

globalName (mandatory)
globalScope (optional)
resultType (optional)

Definition at line 279 of file exprResultGlobals.C.

References exprResultGlobals::addValue(), dict, IOobject::name(), and exprResult::New().

Here is the call graph for this function:

◆ removeValue()

bool removeValue	(	const word &	name,
		const word &	scope
	)

Remove named result from specified scope.

Returns: true if result was removed

Definition at line 318 of file exprResultGlobals.C.

References IOobject::name().

Here is the call graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Write variables.

Implements regIOobject.

Definition at line 163 of file exprResultGlobals.C.

References IOstreamOption::ASCII, and os().

Here is the call graph for this function:

◆ readData()

bool readData ( Istream & os )

virtual

Read variables.

Reimplemented from regIOobject.

Definition at line 176 of file exprResultGlobals.C.

References IOstreamOption::ASCII, IOstream::bad(), and IOstreamOption::format().

Here is the call graph for this function:

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

src/OpenFOAM/expressions/exprResult/exprResultGlobals.H
src/OpenFOAM/expressions/exprResult/exprResultGlobals.C

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~exprResultGlobals()

Member Function Documentation

◆ TypeNameNoDebug()

◆ New()

◆ Delete()

◆ getNamespace()

◆ get()

◆ addValue() [1/3]

◆ addValue() [2/3]

◆ addValue() [3/3]

◆ removeValue()

◆ writeData()

◆ readData()