Intermediate class for handling field value-based function objects. More...

#include <fieldValue.H>

Inheritance diagram for fieldValue:

[legend]

Collaboration diagram for fieldValue:

[legend]

Public Member Functions
	TypeName ("fieldValue")
	Run-time type information.
	declareRunTimeSelectionTable (autoPtr, fieldValue, runTime,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
	fieldValue (const word &name, const Time &runTime, const dictionary &dict, const word &valueType)
	Construct from name, Time and dictionary.
	fieldValue (const word &name, const objectRegistry &obr, const dictionary &dict, const word &valueType)
	Construct from objectRegistry and dictionary.
virtual	~fieldValue ()=default
	Destructor.
const dictionary &	dict () const noexcept
	Return the reference to the construction dictionary.
const word &	regionName () const noexcept
	Return the region name.
const wordList &	fields () const noexcept
	Return the list of field names.
bool	writeFields () const noexcept
	Return the output field values flag.
virtual bool	read (const dictionary &dict)
	Read the function-object dictionary.
virtual bool	execute ()
	Execute the function-object operations.
virtual bool	write ()
	Write the function-object results.
Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	Runtime type information.
	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary.
	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary.
virtual	~fvMeshFunctionObject ()=default
	Destructor.
Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	Runtime type information.
	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary.
	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary.
virtual	~regionFunctionObject ()=default
	Destructor.
template<class ObjectType>
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10).
template<class ObjectType>
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10).
Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components.
virtual	~stateFunctionObject ()=default
	Destructor.
dictionary &	propertyDict ()
	Return access to the property dictionary.
bool	foundProperty (const word &entryName) const
	Return true if the property exists.
void	clearTrigger ()
	Remove the trigger index from the properties.
label	getTrigger () const
	Get the current trigger index.
bool	setTrigger (const label triggeri)
	Set new trigger index.
bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set.
bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set.
template<class Type>
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property.
template<class Type>
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set.
template<class Type>
void	setProperty (const word &entryName, const Type &value)
	Add generic property.
template<class Type>
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object.
template<class Type>
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set.
template<class Type>
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object.
bool	getObjectResultDict (const word &objectName, dictionary &dict) const
template<class Type>
void	setResult (const word &entryName, const Type &value)
	Add result.
template<class Type>
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object.
template<class Type>
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result.
template<class Type>
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object.
template<class Type>
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set.
word	resultType (const word &entryName) const
	Retrieve the result type.
word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result.
wordList	objectResultEntries () const
	Retrieve the result entries.
wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object.
void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream.
void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream.
void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream.
Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time.
virtual	~timeFunctionObject ()=default
	Destructor.
const Time &	time () const
	Return time database.
objectRegistry &	storedObjects ()
	Write access to the output objects ("functionObjectObjects") registered on Time.
const objectRegistry &	storedObjects () const
	Const access to the output objects ("functionObjectObjects") registered on Time.
Public Member Functions inherited from functionObject
	declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
	functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
	Construct from components.
autoPtr< functionObject >	clone () const
	Return clone.
virtual	~functionObject ()=default
	Destructor.
virtual const word &	type () const =0
	Runtime type information.
const word &	name () const noexcept
	Return the name of this functionObject.
bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix.
bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix.
virtual bool	execute (const label subIndex)
	Execute using the specified subIndex.
virtual bool	end ()
	Called when Time::run() determines that the time-loop exits.
virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true.
virtual bool	filesModified () const
	Did any file get changed during execution?
virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh.
virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh.
Public Member Functions inherited from writeFile
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName.
	writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true, const string &ext=".dat")
	Construct from objectRegistry, prefix, fileName and read options from dictionary.
	writeFile (const writeFile &wf)
	Construct copy.
virtual	~writeFile ()=default
	Destructor.
virtual const string &	setExt (const string &ext)
	Set extension.
virtual OFstream &	file ()
	Return access to the file (if only 1).
virtual bool	writeToFile () const
	Flag to allow writing to file.
virtual bool	canWriteToFile () const
	Flag to allow writing to the file.
virtual bool	canResetFile () const
	Flag to allow resetting the file.
virtual bool	canWriteHeader () const
	Flag to allow writing the header.
virtual label	charWidth () const
	Return width of character stream output.
virtual void	writeCommented (Ostream &os, const string &str) const
	Write a commented string to stream.
virtual void	writeTabbed (Ostream &os, const string &str) const
	Write a tabbed string to stream.
virtual void	writeHeader (Ostream &os, const string &str) const
	Write a commented header to stream.
virtual void	writeCurrentTime (Ostream &os) const
	Write the current time to stream.
virtual void	writeBreak (Ostream &os) const
	Write a break marker to the stream.
template<class Type>
void	writeHeaderValue (Ostream &os, const string &property, const Type &value) const
	Write a (commented) header property and value pair.
template<class Type>
void	writeValue (Ostream &os, const Type &val) const
	Write a given value to stream with the space delimiter.

Static Public Member Functions
static autoPtr< fieldValue >	New (const word &name, const Time &runTime, const dictionary &dict, const bool output=true)
	Return a reference to the selected fieldValue.
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
	Select from dictionary, based on its "type" entry.

Protected Member Functions
template<class Type>
void	combineFields (Field< Type > &field)
	Combine fields from all processor domains into single field.
template<class Type>
void	combineFields (tmp< Field< Type > > &)
	Combine fields from all processor domains into single field.
Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct.
void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used.
template<class ObjectType>
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType *	cfindObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
const ObjectType *	findObject (const word &fieldName) const
	Return const pointer to the object (eg, a field) in the (sub) objectRegistry.
template<class ObjectType>
ObjectType *	findObject (const word &fieldName)
	Return non-const pointer to the object of the given Type, (sub) objectRegistry.
template<class ObjectType>
ObjectType *	getObjectPtr (const word &fieldName) const
	Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable.
template<class ObjectType>
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry.
template<class ObjectType>
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry.
template<class ObjectType>
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the field in the (sub) objectRegistry under the given name.
template<class ObjectType>
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
	Store the field in an optional objectRegistry under the given name.
bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry.
bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present.
void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present.
	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct.
void	operator= (const regionFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary.
functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary.
	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct.
void	operator= (const stateFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects".
	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct.
void	operator= (const timeFunctionObject &)=delete
	No copy assignment.
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name.
Protected Member Functions inherited from writeFile
void	initStream (Ostream &os) const
	Initialise the output stream for writing.
fileName	baseFileDir () const
	Return the base directory for output.
fileName	baseTimeDir () const
	Return the base directory for the current time value.
fileName	filePath (const fileName &fName) const
	Return the full path for the supplied file name.
virtual autoPtr< OFstream >	newFile (const fileName &fName) const
	Return autoPtr to a new file using file name.
virtual autoPtr< OFstream >	newFileAtTime (const word &name, scalar timeValue) const
	Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	newFileAtStartTime (const word &name) const
	Return autoPtr to a new file using the simulation start time.
virtual void	resetFile (const word &name)
	Reset internal file pointer to new file with new name.
Omanip< int >	valueWidth (const label offset=0) const
	Return the value width when writing to stream with optional offset.
void	operator= (const writeFile &)=delete
	No copy assignment.
virtual autoPtr< OFstream >	createFile (const word &name, scalar timeValue) const
	Deprecated(2022-09) Return autoPtr to a new file for a given time.
virtual autoPtr< OFstream >	createFile (const word &name) const
	Deprecated(2022-09) Return autoPtr to a new file using the simulation start time.

Protected Attributes
bool	writeFields_
	Flag to output field values.
word	regionName_
	Name of region (patch, zone, etc.).
scalar	scaleFactor_
	Scaling factor.
dictionary	dict_
	Construction dictionary.
wordList	fields_
	Names of operand fields.
Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh.
Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry.
const objectRegistry &	obr_
	Reference to the region objectRegistry.
const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry.
Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database.
Protected Attributes inherited from writeFile
const objectRegistry &	fileObr_
	Reference to the region objectRegistry.
const fileName	prefix_
	Prefix.
word	fileName_
	Name of file.
autoPtr< OFstream >	filePtr_
	File pointer.
label	writePrecision_
	Write precision.
bool	writeToFile_
	Flag to enable/disable writing to file.
bool	updateHeader_
	Flag to update the header, e.g. on mesh changes. Default is true.
bool	writtenHeader_
	Flag to identify whether the header has been written.
bool	useUserTime_
	Flag to use the specified user time, e.g. CA deg instead of seconds. Default = true.
scalar	startTime_
	Start time value.
string	ext_
	File extension; default = .dat.

Additional Inherited Members
Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info.
Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content.
static bool	postProcess
	Global post-processing mode switch.
static bool	defaultUseNamePrefix
	Global default for useNamePrefix.
static word	outputPrefix
	Directory prefix.
Static Public Attributes inherited from writeFile
static label	addChars = 8
	Additional characters for writing.

Detailed Description

Intermediate class for handling field value-based function objects.

Usage

Minimal example by using system/controlDict.functions:

FOname
{
    // Mandatory and optional entries
    ...

    // Mandatory entries
    fields            (<wordList>);  // (<field1> <field2> ... <fieldN>);

    // Optional entries
    writeFields       <bool>;
    scaleFactor       <scalar>;
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`fields`	Names of operand fields	wordList	yes	-
`writeFields`	Flag to output field values	bool	no	false
`scaleFactor`	Scaling factor	scalar	no	1.0

The inherited entries are elaborated in:

Source files

Definition at line 109 of file fieldValue.H.

Constructor & Destructor Documentation

◆ fieldValue() [1/2]

fieldValue	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict,
		const word &	valueType )

Construct from name, Time and dictionary.

Definition at line 40 of file fieldValue.C.

References dict(), dict_, fields_, fvMeshFunctionObject::fvMeshFunctionObject(), Foam::name(), regionFunctionObject::obr_, read(), regionName_, runTime, scaleFactor_, writeFields_, and writeFile::writeFile().

Referenced by declareRunTimeSelectionTable(), volFieldValue::volFieldValue(), and volFieldValue::volFieldValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fieldValue() [2/2]

fieldValue	(	const word &	name,
		const objectRegistry &	obr,
		const dictionary &	dict,
		const word &	valueType )

Construct from objectRegistry and dictionary.

Definition at line 60 of file fieldValue.C.

References dict(), dict_, fields_, fvMeshFunctionObject::fvMeshFunctionObject(), Foam::name(), regionFunctionObject::obr(), regionFunctionObject::obr_, read(), regionName_, scaleFactor_, writeFields_, and writeFile::writeFile().

Here is the call graph for this function:

◆ ~fieldValue()

virtual ~fieldValue ( )

virtualdefault

Destructor.

References dict(), execute(), fields(), Foam::noexcept, read(), regionName(), write(), and writeFields().

Here is the call graph for this function:

Member Function Documentation

◆ combineFields() [1/2]

template<class Type>

void combineFields ( Field< Type > & field )

protected

Combine fields from all processor domains into single field.

Definition at line 29 of file fieldValueTemplates.C.

References Pstream::allGatherList(), Foam::ListListOps::combine(), field(), UPstream::myProcNo(), UPstream::nProcs(), and UPstream::parRun().

Referenced by combineFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ combineFields() [2/2]

template<class Type>

void combineFields ( tmp< Field< Type > > & field )

protected

Combine fields from all processor domains into single field.

Definition at line 49 of file fieldValueTemplates.C.

References combineFields(), and field().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "fieldValue" )

Run-time type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		fieldValue	,
		runTime	,
		(const word &name, const Time &runTime, const dictionary &dict)	,
		(name, runTime, dict)	)

References dict(), fieldValue(), Foam::name(), regionFunctionObject::obr(), and runTime.

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::functionObjects::fieldValue > New	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict,
		const bool	output = true )

static

Return a reference to the selected fieldValue.

Definition at line 27 of file fieldValueNew.C.

References dict(), Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, Foam::GlobalIOList< Tuple2< scalar, vector > >::typeName, Foam::Info, Foam::name(), and runTime.

Here is the call graph for this function:

◆ dict()

const Foam::dictionary & dict ( ) const

inlinenoexcept

Return the reference to the construction dictionary.

Definition at line 24 of file fieldValueI.H.

References dict_, and Foam::noexcept.

Referenced by declareRunTimeSelectionTable(), fieldValue(), fieldValue(), New(), read(), volFieldValue::read(), volFieldValue::TypeName(), volFieldValue::volFieldValue(), volFieldValue::volFieldValue(), ~fieldValue(), and volFieldValue::~volFieldValue().

Here is the caller graph for this function:

◆ regionName()

const Foam::word & regionName ( ) const

inlinenoexcept

Return the region name.

Definition at line 31 of file fieldValueI.H.

References Foam::noexcept, and regionName_.

Referenced by ~fieldValue().

Here is the caller graph for this function:

◆ fields()

const Foam::wordList & fields ( ) const

inlinenoexcept

Return the list of field names.

Definition at line 38 of file fieldValueI.H.

References fields_, and Foam::noexcept.

Referenced by ~fieldValue().

Here is the caller graph for this function:

◆ writeFields()

bool writeFields ( ) const

inlinenoexcept

Return the output field values flag.

Definition at line 45 of file fieldValueI.H.

References Foam::noexcept, and writeFields_.

Referenced by ~fieldValue().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read the function-object dictionary.

Reimplemented from regionFunctionObject.

Reimplemented in volFieldValue.

Definition at line 82 of file fieldValue.C.

References dict(), dict_, fields_, functionObject::read(), writeFile::read(), scaleFactor_, and writeFields_.

Referenced by fieldValue(), fieldValue(), volFieldValue::read(), and ~fieldValue().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ execute()

bool execute ( )

virtual

Execute the function-object operations.

Implements functionObject.

Definition at line 102 of file fieldValue.C.

Referenced by ~fieldValue().

Here is the caller graph for this function:

◆ write()

bool write ( )

virtual

Write the function-object results.

Implements functionObject.

Reimplemented in volFieldValue.

Definition at line 108 of file fieldValue.C.

References Log, name, Foam::nl, and Foam::type().

Referenced by volFieldValue::write(), and ~fieldValue().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ writeFields_

bool writeFields_

protected

Flag to output field values.

Definition at line 121 of file fieldValue.H.

Referenced by fieldValue(), fieldValue(), read(), writeFields(), and volFieldValue::writeValues().

◆ regionName_

word regionName_

protected

Name of region (patch, zone, etc.).

Definition at line 126 of file fieldValue.H.

Referenced by fieldValue(), fieldValue(), and regionName().

◆ scaleFactor_

scalar scaleFactor_

protected

Scaling factor.

Definition at line 131 of file fieldValue.H.

Referenced by fieldValue(), fieldValue(), read(), and volFieldValue::writeValues().

◆ dict_

dictionary dict_

protected

Construction dictionary.

Definition at line 136 of file fieldValue.H.

Referenced by dict(), fieldValue(), fieldValue(), and read().

◆ fields_

wordList fields_

protected

Names of operand fields.

Definition at line 141 of file fieldValue.H.

Referenced by fields(), fieldValue(), fieldValue(), read(), volFieldValue::writeAll(), and volFieldValue::writeFileHeader().

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

src/functionObjects/field/fieldValues/fieldValue/fieldValue.H
src/functionObjects/field/fieldValues/fieldValue/fieldValue.C
src/functionObjects/field/fieldValues/fieldValue/fieldValueI.H
src/functionObjects/field/fieldValues/fieldValue/fieldValueNew.C
src/functionObjects/field/fieldValues/fieldValue/fieldValueTemplates.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ fieldValue() [1/2]

◆ fieldValue() [2/2]

◆ ~fieldValue()

Member Function Documentation

◆ combineFields() [1/2]

◆ combineFields() [2/2]

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ dict()

◆ regionName()

◆ fields()

◆ writeFields()

◆ read()

◆ execute()

◆ write()

Member Data Documentation

◆ writeFields_

◆ regionName_

◆ scaleFactor_

◆ dict_

◆ fields_