subtract Class Reference

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...
 
- 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...
 
 fieldsExpression (const fieldsExpression &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~fieldsExpression ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the fieldsExpression data. More...
 
virtual wordList fields () const
 Return the list of fields required. 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...
 
void operator= (const fieldsExpression &)=delete
 Disallow default bitwise assignment. 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...
 
 fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~fvMeshFunctionObject ()
 Destructor. More...
 
void operator= (const fvMeshFunctionObject &)=delete
 Disallow default bitwise assignment. 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...
 
 regionFunctionObject (const regionFunctionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~regionFunctionObject ()
 Destructor. More...
 
void operator= (const regionFunctionObject &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from functionObject
 ClassName ("functionObject")
 
virtual const wordtype () 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, const Time &runTime)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
 functionObject (const functionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool executeAtStart () const
 Return true if the functionObject should be executed at the start. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual scalar timeToNextAction ()
 Called by Time::adjustTimeStep(). Allows the functionObject to. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update topology using the given map. More...
 
virtual void topoChange (const polyTopoChangeMap &map)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
void operator= (const functionObject &)=delete
 Disallow default bitwise assignment. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (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...
 
Switch executeAtStart_
 Switch write log to Info. More...
 
- Static Public Attributes inherited from functionObject
static bool postProcess
 Global post-processing mode switch. More...
 
- Protected Member Functions inherited from fieldsExpression
void setResultName (const word &functionName, const wordList &defaultFieldNames=wordList::null())
 Set the result name. More...
 
template<template< class > class GeoField, template< class ... > class Op, class TypeA , class TypeB , class Enable = Op<TypeA, TypeB>>
bool opAndStore (const GeoField< TypeA > &a, const GeoField< TypeB > &b)
 Operate on the fields and store the result. Supported overload. More...
 
template<template< class > class GeoField, template< class ... > class Op, class ... Args>
bool opAndStore (const Args &...)
 Operate on the fields and store the result. Not-supported overload. More...
 
template<template< class > class GeoField, template< class ... > class Op, class TypeA , class TypeB >
bool foldAB (const label i)
 Fold the fields expression up one place. More...
 
template<template< class > class GeoField, template< class ... > class Op, class TypeA >
bool foldA (const label i)
 Fold the fields expression up one place. More...
 
template<template< class > class GeoField, template< class ... > class Op>
bool fold (const label i)
 Fold the fields expression up one place. More...
 
template<template< class > class GeoField, template< class ... > class Op>
bool calcGeoFieldOp ()
 Calculate and store the fields expression for the given geometric. More...
 
template<template< class ... > class Op>
bool calcOp ()
 Calculate and store the fields expression for the given operation. 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 >
void cannotFindObject (const word &fieldName)
 Prints a warning message that fieldName cannot be found. More...
 
void cannotFindObject (const word &fieldName)
 Prints a warning message that fieldName cannot be found. 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 (const tmp< ObjectType > &tfield)
 Store the given field in the objectRegistry. More...
 
template<class ObjectType >
bool store (const 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 fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 
- Protected Attributes inherited from functionObject
const Timetime_
 Reference to time. 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 70 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 68 of file subtract.C.

References fieldsExpression::setResultName().

Here is the call graph for this function:

◆ ~subtract()

~subtract ( )
virtual

Destructor.

Definition at line 83 of file subtract.C.

Member Function Documentation

◆ TypeName()

TypeName ( "subtract"  )

Runtime type information.


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