From the first field subtract the remaining fields in the list. More...

Inheritance diagram for subtract:

Collaboration diagram for subtract:

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

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

virtual	~subtract ()
	Destructor. More...

template<class GeoFieldType >
Foam::tmp< GeoFieldType >	calcFieldType () const

Public Member Functions inherited from fieldsExpression
	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...

virtual	~fieldsExpression ()
	Destructor. More...

virtual bool	read (const dictionary &)
	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 ()
	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 ()
	Destructor. More...

Public Member Functions inherited from functionObject
virtual const word &	type () const =0
	Runtime type information. More...

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

	functionObject (const word &name)
	Construct from components. More...

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

virtual	~functionObject ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. 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 void	updateMesh (const mapPolyMesh &mpm)
	Update for changes of mesh. More...

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

Friends
class	fieldsExpression

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Static Public Attributes inherited from functionObject
static int	debug

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

Protected Member Functions inherited from fieldsExpression
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...

Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

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

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

Protected Attributes inherited from fieldsExpression
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
const Time &	time_
	Reference to the Time. More...

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

Detailed Description

From the first field subtract the remaining fields in the list.

The operation can be applied to any volume or surface fields generating a volume or surface scalar field.

Example of function object specification:

Tdiff
{
    type            subtract;
    libs            ("libfieldFunctionObjects.so");
    fields          (T Tmean);
    result          Tdiff;
    executeControl  writeTime;
    writeControl    writeTime;
}

See also: Foam::functionObjects::fieldsExpression Foam::functionObjects::fvMeshFunctionObject

Source files

Definition at line 73 of file subtract.H.

Constructor & Destructor Documentation

◆ subtract()

subtract	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 52 of file subtract.C.

◆ ~subtract()

~subtract ( )

virtual

Destructor.

Definition at line 66 of file subtract.C.

Member Function Documentation

◆ TypeName()

TypeName ( "subtract" )

Runtime type information.

◆ calcFieldType()

Foam::tmp<GeoFieldType> calcFieldType ( ) const

Definition at line 30 of file subtractTemplates.C.

References fieldsExpression::fieldNames_, tmp< T >::ref(), and List< T >::size().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ fieldsExpression

friend class fieldsExpression

friend

Definition at line 90 of file subtract.H.

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

src/functionObjects/field/subtract/subtract.H
src/functionObjects/field/subtract/subtract.C
src/functionObjects/field/subtract/subtractTemplates.C

Public Member Functions

Friends

Additional Inherited Members