Intermediate class for handling field expression function objects (e.g. add, subtract etc.) whereinto more than one fields are input. More...

Inheritance diagram for fieldsExpression:

[legend]

Collaboration diagram for fieldsExpression:

[legend]

Public Member Functions
	TypeName ("fieldsExpression")
	Runtime type information. More...

	fieldsExpression (const word &name, const Time &runTime, const dictionary &dict, const wordList &fieldNames=wordList::null(), const word &resultName=word::null)
	Construct from Time and dictionary. More...

	fieldsExpression (const fieldsExpression &)=delete
	No copy construct. More...

void	operator= (const fieldsExpression &)=delete
	No copy assignment. More...

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

virtual bool	read (const dictionary &dict)
	Read the fieldsExpression data. More...

virtual bool	execute ()
	Calculate the result fields. More...

virtual bool	write ()
	Write the result fields. More...

virtual bool	clear ()
	Clear the result fields from the objectRegistry. More...

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

	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

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

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

	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from Time and dictionary. More...

	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from the region objectRegistry and dictionary. More...

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

template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
	Deprecated(2018-10) More...

template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
	Deprecated(2018-10) More...

Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
	Construct from components. More...

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

dictionary &	propertyDict ()
	Return access to the property dictionary. More...

bool	foundProperty (const word &entryName) const
	Return true if the property exists. More...

void	clearTrigger ()
	Remove the trigger index from the properties. More...

label	getTrigger () const
	Get the current trigger index. More...

bool	setTrigger (const label triggeri, bool increaseOnly=true)
	Set the trigger index. Normally only if greater than current. More...

bool	getDict (const word &entryName, dictionary &dict) const
	Set dictionary, return true if set. More...

bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
	Set dictionary from named object, return true if set. More...

template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property. More...

template<class Type >
bool	getProperty (const word &entryName, Type &value) const
	Set generic property, return true if set. More...

template<class Type >
void	setProperty (const word &entryName, const Type &value)
	Add generic property. More...

template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from named object. More...

template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
	Set generic property from named object, return true if set. More...

template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
	Add generic property from named object. More...

template<class Type >
void	setResult (const word &entryName, const Type &value)
	Add result. More...

template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
	Add result from named object. More...

template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result. More...

template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve result from named object. More...

template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
	Set result from named object, return true if set. More...

word	resultType (const word &entryName) const
	Retrieve the result type. More...

word	objectResultType (const word &objectName, const word &entryName) const
	Return the type of result. More...

wordList	objectResultEntries () const
	Retrieve the result entries. More...

wordList	objectResultEntries (const word &objectName) const
	Return result entries for named object. More...

void	writeResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

void	writeResultEntries (const word &objectName, Ostream &os) const
	Write the results entries for named object to stream. More...

void	writeAllResultEntries (Ostream &os) const
	Write the results entries for all objects to stream. More...

Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
	Construct from Time. More...

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

const Time &	time () const
	Return time database. More...

objectRegistry &	storedObjects ()

const objectRegistry &	storedObjects () const

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

autoPtr< functionObject >	clone () const
	Return clone. More...

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

virtual const word &	type () const =0
	Runtime type information. More...

const word &	name () const noexcept
	Return the name of this functionObject. More...

bool	useNamePrefix () const noexcept
	Return the flag for adding a scoping name prefix. More...

bool	useNamePrefix (bool on) noexcept
	Modify the flag for adding a scoping name prefix. More...

virtual bool	execute (const label subIndex)
	Execute using the specified subIndex. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual bool	adjustTimeStep ()
	Called at the end of Time::adjustDeltaT() if adjustTime is true. More...

virtual bool	filesModified () const
	Did any file get changed during execution? More...

virtual void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

virtual void	movePoints (const polyMesh &mesh)
	Update for changes of mesh. More...

Protected Member Functions
void	setResultName (const word &typeName, const wordList &defaultArg=wordList::null())

template<class Type , class FOType >
bool	calcFieldTypes (FOType &fo)
	Call 'calcFieldType' for the given functionObject. More...

template<class Type , class FOType >
bool	calcType (FOType &fo)
	Call 'calcFieldTypes' for the given 'Type' and functionObject. More...

template<class FOType >
bool	calcAllTypes (FOType &fo)
	Call 'calcType' for the given functionObject. More...

virtual bool	calc ()=0
	Calculate expression. More...

Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	No copy construct. More...

void	operator= (const fvMeshFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
	The region or sub-region registry being used. More...

template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find object (eg, a field) in the (sub) objectRegistry. More...

template<class ObjectType >
const ObjectType *	cfindObject (const word &fieldName) const

template<class ObjectType >
const ObjectType *	findObject (const word &fieldName) const

template<class ObjectType >
ObjectType *	findObject (const word &fieldName)

template<class ObjectType >
ObjectType *	getObjectPtr (const word &fieldName) const

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
	Lookup and return object (eg, a field) from the (sub) objectRegistry. More...

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

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

bool	writeObject (const word &fieldName)
	Write field if present in the (sub) objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the (sub) objectRegistry if present. More...

void	clearObjects (const wordList &objNames)
	Clear fields from the (sub) objectRegistry if present. More...

	regionFunctionObject (const regionFunctionObject &)=delete
	No copy construct. More...

void	operator= (const regionFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
	Return a const reference to the state dictionary. More...

functionObjects::properties &	stateDict ()
	Return non-const access to the state dictionary. More...

	stateFunctionObject (const stateFunctionObject &)=delete
	No copy construct. More...

void	operator= (const stateFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	Remove specified items from "functionObjectObjects". More...

	timeFunctionObject (const timeFunctionObject &)=delete
	No copy construct. More...

void	operator= (const timeFunctionObject &)=delete
	No copy assignment. More...

Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const
	Return a scoped (prefixed) name. More...

Protected Attributes
wordList	fieldNames_
	Names of fields to process. More...

word	resultName_
	Name of result fields. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
	Name for alternative object registry. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

const objectRegistry *	obrPtr_
	Pointer to alternative (eg, sub-region) objectRegistry. More...

Protected Attributes inherited from timeFunctionObject
const Time &	time_
	Reference to the time database. More...

Additional Inherited Members
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. More...

Public Attributes inherited from functionObject
bool	log
	Flag to write log into Info. More...

Static Public Attributes inherited from functionObject
static int	debug
	Flag to execute debug content. More...

static bool	postProcess
	Global post-processing mode switch. More...

static bool	defaultUseNamePrefix
	Global default for useNamePrefix. More...

static word	outputPrefix
	Directory prefix. More...

Detailed Description

Intermediate class for handling field expression function objects (e.g. add, subtract etc.) whereinto more than one fields are input.

Usage

Minimal example by using system/controlDict.functions:

<userDefinedSubDictName1>
{
    // Mandatory and other optional entries
    ...

    // Optional (inherited) entries (runtime modifiable)
    fields            (<field1> <field2> ... <fieldN>);
    result            <fieldResult>;
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`fields`	Names of operand fields	wordList	yes	-
`result`	Names of output fields	wordList	no	<FO>(<f1>,...)

See also

Foam::functionObject
Foam::functionObjects::fvMeshFunctionObject
ExtendedCodeGuide::functionObjects::field::fieldsExpression

Source files

Definition at line 103 of file fieldsExpression.H.

Constructor & Destructor Documentation

◆ fieldsExpression() [1/2]

fieldsExpression	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict,
		const wordList &	fieldNames = `wordList::null()`,
		const word &	resultName = `word::null`
	)

Construct from Time and dictionary.

Definition at line 78 of file fieldsExpression.C.

References dict, Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::name(), and Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ fieldsExpression() [2/2]

fieldsExpression ( const fieldsExpression & )

delete

No copy construct.

◆ ~fieldsExpression()

virtual ~fieldsExpression ( )

virtualdefault

Destructor.

Member Function Documentation

◆ setResultName()

void setResultName	(	const word &	typeName,
		const wordList &	defaultArg = `wordList::null()`
	)

protected

Definition at line 46 of file fieldsExpression.C.

◆ calcFieldTypes()

bool calcFieldTypes ( FOType & fo )

protected

Call 'calcFieldType' for the given functionObject.

for 'volField' and 'surfaceField' field types

Definition at line 36 of file fieldsExpressionTemplates.C.

References fieldsExpression::fieldNames_, fieldsExpression::resultName_, and regionFunctionObject::store().

Here is the call graph for this function:

◆ calcType()

bool calcType ( FOType & fo )

protected

Call 'calcFieldTypes' for the given 'Type' and functionObject.

Definition at line 72 of file fieldsExpressionTemplates.C.

◆ calcAllTypes()

bool calcAllTypes ( FOType & fo )

protected

Call 'calcType' for the given functionObject.

for each primitive type

Definition at line 79 of file fieldsExpressionTemplates.C.

◆ calc()

virtual bool calc ( )

protectedpure virtual

Calculate expression.

◆ TypeName()

TypeName ( "fieldsExpression" )

Runtime type information.

◆ operator=()

void operator= ( const fieldsExpression & )

delete

No copy assignment.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the fieldsExpression data.

Reimplemented from regionFunctionObject.

Definition at line 105 of file fieldsExpression.C.

References dict, fieldsExpression::fieldNames_, regionFunctionObject::read(), and fieldsExpression::resultName_.

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Calculate the result fields.

Implements functionObject.

Definition at line 120 of file fieldsExpression.C.

References clear(), Foam::endl(), Foam::name(), Foam::type(), and Foam::Warning.

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the result fields.

Implements functionObject.

Definition at line 138 of file fieldsExpression.C.

◆ clear()

bool clear ( )

virtual

Clear the result fields from the objectRegistry.

Definition at line 144 of file fieldsExpression.C.

Member Data Documentation

◆ fieldNames_

wordList fieldNames_

protected

Names of fields to process.

Definition at line 112 of file fieldsExpression.H.

Referenced by add::calcFieldType(), subtract::calcFieldType(), fieldsExpression::calcFieldTypes(), and fieldsExpression::read().

◆ resultName_

word resultName_

protected

Name of result fields.

Definition at line 115 of file fieldsExpression.H.

Referenced by fieldsExpression::calcFieldTypes(), and fieldsExpression::read().

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

src/functionObjects/field/fieldsExpression/fieldsExpression.H
src/functionObjects/field/fieldsExpression/fieldsExpression.C
src/functionObjects/field/fieldsExpression/fieldsExpressionTemplates.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ fieldsExpression() [1/2]

◆ fieldsExpression() [2/2]

◆ ~fieldsExpression()

Member Function Documentation

◆ setResultName()

◆ calcFieldTypes()

◆ calcType()

◆ calcAllTypes()

◆ calc()

◆ TypeName()

◆ operator=()

◆ read()

◆ execute()

◆ write()

◆ clear()

Member Data Documentation

◆ fieldNames_

◆ resultName_