fieldsExpression Class Reference

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:

Collaboration diagram for fieldsExpression:

Public Member Functions
	TypeName ("fieldsExpression")
	fieldsExpression (const word &name, const Time &runTime, const dictionary &dict, const wordList &fieldNames=wordList::null(), const word &resultName=word::null)
	fieldsExpression (const fieldsExpression &)=delete
void	operator= (const fieldsExpression &)=delete
virtual	~fieldsExpression ()=default
virtual bool	read (const dictionary &dict)
virtual bool	execute ()
virtual bool	write ()
virtual bool	clear ()
Public Member Functions inherited from fvMeshFunctionObject
	TypeName ("fvMeshFunctionObject")
	fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
virtual	~fvMeshFunctionObject ()=default
Public Member Functions inherited from regionFunctionObject
	TypeName ("regionFunctionObject")
	regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
	regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
virtual	~regionFunctionObject ()=default
template<class ObjectType >
const ObjectType *	lookupObjectPtr (const word &fieldName) const
template<class ObjectType >
ObjectType *	lookupObjectRefPtr (const word &fieldName) const
Public Member Functions inherited from stateFunctionObject
	stateFunctionObject (const word &name, const Time &runTime)
virtual	~stateFunctionObject ()=default
dictionary &	propertyDict ()
bool	foundProperty (const word &entryName) const
void	clearTrigger ()
label	getTrigger () const
bool	setTrigger (const label triggeri, bool increaseOnly=true)
bool	getDict (const word &entryName, dictionary &dict) const
bool	getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
template<class Type >
Type	getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
bool	getProperty (const word &entryName, Type &value) const
template<class Type >
void	setProperty (const word &entryName, const Type &value)
template<class Type >
Type	getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
bool	getObjectProperty (const word &objectName, const word &entryName, Type &value) const
template<class Type >
void	setObjectProperty (const word &objectName, const word &entryName, const Type &value)
template<class Type >
void	setResult (const word &entryName, const Type &value)
template<class Type >
void	setObjectResult (const word &objectName, const word &entryName, const Type &value)
template<class Type >
Type	getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
Type	getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
template<class Type >
bool	getObjectResult (const word &objectName, const word &entryName, Type &value) const
word	resultType (const word &entryName) const
word	objectResultType (const word &objectName, const word &entryName) const
wordList	objectResultEntries () const
wordList	objectResultEntries (const word &objectName) const
void	writeResultEntries (Ostream &os) const
void	writeResultEntries (const word &objectName, Ostream &os) const
void	writeAllResultEntries (Ostream &os) const
Public Member Functions inherited from timeFunctionObject
	timeFunctionObject (const word &name, const Time &runTime)
virtual	~timeFunctionObject ()=default
const Time &	time () const
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)
autoPtr< functionObject >	clone () const
virtual	~functionObject ()=default
virtual const word &	type () const =0
const word &	name () const noexcept
bool	useNamePrefix () const noexcept
bool	useNamePrefix (bool on) noexcept
virtual bool	execute (const label subIndex)
virtual bool	end ()
virtual bool	adjustTimeStep ()
virtual bool	filesModified () const
virtual void	updateMesh (const mapPolyMesh &mpm)
virtual void	movePoints (const polyMesh &mesh)

Protected Member Functions
void	setResultName (const word &typeName, const wordList &defaultArg=wordList::null())
template<class Type , class FOType >
bool	calcFieldTypes (FOType &fo)
template<class Type , class FOType >
bool	calcType (FOType &fo)
template<class FOType >
bool	calcAllTypes (FOType &fo)
virtual bool	calc ()=0
Protected Member Functions inherited from fvMeshFunctionObject
	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
void	operator= (const fvMeshFunctionObject &)=delete
Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry &	obr () const
template<class ObjectType >
bool	foundObject (const word &fieldName) const
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
template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName) const
template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
template<class ObjectType >
bool	storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
bool	writeObject (const word &fieldName)
bool	clearObject (const word &fieldName)
void	clearObjects (const wordList &objNames)
	regionFunctionObject (const regionFunctionObject &)=delete
void	operator= (const regionFunctionObject &)=delete
Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties &	stateDict () const
functionObjects::properties &	stateDict ()
	stateFunctionObject (const stateFunctionObject &)=delete
void	operator= (const stateFunctionObject &)=delete
Protected Member Functions inherited from timeFunctionObject
void	clearOutputObjects (const wordList &objNames)
	timeFunctionObject (const timeFunctionObject &)=delete
void	operator= (const timeFunctionObject &)=delete
Protected Member Functions inherited from functionObject
word	scopedName (const word &name) const

Protected Attributes
wordList	fieldNames_
word	resultName_
Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
Protected Attributes inherited from regionFunctionObject
word	subRegistryName_
const objectRegistry &	obr_
const objectRegistry *	obrPtr_
Protected Attributes inherited from timeFunctionObject
const Time &	time_

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &runTime, const dictionary &dict)
Public Attributes inherited from functionObject
bool	log
Static Public Attributes inherited from functionObject
static int	debug
static bool	postProcess
static bool	defaultUseNamePrefix
static word	outputPrefix

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

• fieldsExpression.H
• fieldsExpression.C
• fieldsExpressionTemplates.C

Definition at line 99 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
	)

Definition at line 71 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

~fieldsExpression()

virtual ~fieldsExpression ( )

virtualdefault

Member Function Documentation

setResultName()

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

protected

Definition at line 39 of file fieldsExpression.C.

calcFieldTypes()

bool calcFieldTypes ( FOType &  fo )

protected

Definition at line 29 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

Definition at line 65 of file fieldsExpressionTemplates.C.

calcAllTypes()

bool calcAllTypes ( FOType &  fo )

protected

Definition at line 72 of file fieldsExpressionTemplates.C.

calc()

virtual bool calc ( )

protectedpure virtual

TypeName()

TypeName

(

"fieldsExpression"

)

operator=()

void operator= ( const fieldsExpression &  )

delete

read()

bool read ( const dictionary &  dict )

virtual

Reimplemented from regionFunctionObject.

Definition at line 98 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

Implements functionObject.

Definition at line 113 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

Implements functionObject.

Definition at line 131 of file fieldsExpression.C.

clear()

bool clear ( )

virtual

Definition at line 137 of file fieldsExpression.C.

Member Data Documentation

fieldNames_

wordList fieldNames_

protected

Definition at line 108 of file fieldsExpression.H.

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

resultName_

word resultName_

protected

Definition at line 111 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