Sums a given list of (at least two or more) fields and outputs the result into a new field, where the fields possess the same sizes and dimensions:
More...
|
| TypeName ("add") |
| Runtime type information. More...
|
|
| add (const word &name, const Time &runTime, const dictionary &dict) |
| Construct from Time and dictionary. More...
|
|
| add (const add &)=delete |
| No copy construct. More...
|
|
void | operator= (const add &)=delete |
| No copy assignment. More...
|
|
virtual | ~add ()=default |
| Destructor. More...
|
|
template<class GeoFieldType > |
Foam::tmp< GeoFieldType > | calcFieldType () const |
|
| 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...
|
|
| 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...
|
|
| 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...
|
|
| 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) |
| Set new trigger index. 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...
|
|
bool | getObjectResultDict (const word &objectName, dictionary &dict) const |
|
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...
|
|
| 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 () |
| Write access to the output objects ("functionObjectObjects") registered on Time. More...
|
|
const objectRegistry & | storedObjects () const |
| Const access to the output objects ("functionObjectObjects") registered on Time. More...
|
|
| 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...
|
|
|
static autoPtr< functionObject > | New (const word &name, const Time &runTime, const dictionary &dict) |
| Select from dictionary, based on its "type" entry. More...
|
|
bool | log |
| Flag to write log into Info. More...
|
|
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...
|
|
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...
|
|
| fvMeshFunctionObject (const fvMeshFunctionObject &)=delete |
| No copy construct. More...
|
|
void | operator= (const fvMeshFunctionObject &)=delete |
| No copy assignment. More...
|
|
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 |
| Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More...
|
|
template<class ObjectType > |
const ObjectType * | findObject (const word &fieldName) const |
| Return const pointer to the object (eg, a field) in the (sub) objectRegistry. More...
|
|
template<class ObjectType > |
ObjectType * | findObject (const word &fieldName) |
| Return non-const pointer to the object of the given Type, (sub) objectRegistry. More...
|
|
template<class ObjectType > |
ObjectType * | getObjectPtr (const word &fieldName) const |
| Return non-const pointer to the object of the given Type, using a const-cast to have it behave like a mutable. More...
|
|
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...
|
|
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...
|
|
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...
|
|
word | scopedName (const word &name) const |
| Return a scoped (prefixed) name. More...
|
|
wordList | fieldNames_ |
| Names of fields to process. More...
|
|
word | resultName_ |
| Name of result fields. More...
|
|
const fvMesh & | mesh_ |
| Reference to the fvMesh. More...
|
|
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...
|
|
const Time & | time_ |
| Reference to the time database. More...
|
|
Sums a given list of (at least two or more) fields and outputs the result into 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
: add1
{
// Mandatory entries (unmodifiable)
type add;
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: add | 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 "add(<field1>, <field2>, ..., <fieldN>)"
- See also
-
- Source files
-
Definition at line 154 of file add.H.