Subtracts a given list of (at least one or more) fields from a field and produces a new field, where the fields possess the same sizes and dimensions. More...

Inheritance diagram for subtract:

[legend]

Collaboration diagram for subtract:

[legend]

Public Member Functions
	TypeName ("subtract")

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

	subtract (const subtract &)=delete

void	operator= (const subtract &)=delete

virtual	~subtract ()=default

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

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

Friends
class	fieldsExpression

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

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)

template<class Type , class FOType >
bool	calcType (FOType &fo)

template<class FOType >
bool	calcAllTypes (FOType &fo)

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 inherited from fieldsExpression
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_

Detailed Description

Subtracts a given list of (at least one or more) fields from a field and produces a new field, where the fields possess the same sizes and dimensions.

    fieldResult = field1 - field2 - ... - fieldN

Operands:

Operand	Type	Location
`input`	{vol,surface}<Type>Field(s)	$FOAM_CASE/<time>/<inpField>s
`output` file	-	-
`output` field	{vol,surface}<Type>Field	$FOAM_CASE/<time>/<outField>

where <Type>=Scalar/Vector/SphericalTensor/SymmTensor/Tensor.

Usage

Minimal example by using system/controlDict.functions:

subtract1
{
    // Mandatory entries (unmodifiable)
    type            subtract;
    libs            (fieldFunctionObjects);

    // Mandatory (inherited) entry (runtime modifiable)
    fields          (<field1> <field2> ... <fieldN>);

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
`type`	Type name: subtract	word	yes	-
`libs`	Library name: fieldFunctionObjects	word	yes	-
`fields`	Names of the operand fields	wordList	yes	-

The inherited entries are elaborated in:

Minimal example by using the postProcess utility:

        postProcess -func "subtract(<field1>, <field2>, ..., <fieldN>)"

See also

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

Source files

Definition at line 155 of file subtract.H.

Constructor & Destructor Documentation

◆ subtract() [1/2]

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

Definition at line 48 of file subtract.C.

◆ subtract() [2/2]

subtract ( const subtract & )

delete

◆ ~subtract()

virtual ~subtract ( )

virtualdefault

Member Function Documentation

◆ TypeName()

TypeName ( "subtract" )

◆ operator=()

void operator= ( const subtract & )

delete

◆ calcFieldType()

Foam::tmp<GeoFieldType> calcFieldType ( ) const

Definition at line 26 of file subtractTemplates.C.

References fieldsExpression::fieldNames_, and tmp::ref().

Here is the call graph for this function:

Friends And Related Function Documentation

◆ fieldsExpression

friend class fieldsExpression

friend

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