volFieldValue Class Reference

Provides a 'volRegion' specialization of the fieldValue function object. More...

Inheritance diagram for volFieldValue:
[legend]
Collaboration diagram for volFieldValue:
[legend]

Public Types

enum  operationVariant { typeBase = 0, typeScalar = 0x100, typeWeighted = 0x200, typeAbsolute = 0x400 }
 Bitmask values for operation variants. More...
 
enum  operationType {
  opNone = 0, opMin, opMax, opSum,
  opSumMag, opAverage, opVolAverage, opVolIntegrate,
  opCoV, opWeightedSum = (opSum | typeWeighted), opWeightedAverage = (opAverage | typeWeighted), opWeightedVolAverage = (opVolAverage | typeWeighted),
  opWeightedVolIntegrate = (opVolIntegrate | typeWeighted)
}
 Operation type enumeration. More...
 
enum  postOperationType { postOpNone, postOpMag, postOpSqrt }
 Post-operation type enumeration. More...
 
- Public Types inherited from volRegion
enum  regionTypes { vrtAll, vrtCellSet, vrtCellZone }
 Region type enumeration. More...
 

Public Member Functions

 TypeName ("volFieldValue")
 Declare type-name, virtual type (with debug switch) More...
 
 volFieldValue (const word &name, const Time &runTime, const dictionary &dict)
 Construct from name, Time and dictionary. More...
 
 volFieldValue (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from name, objectRegistry and dictionary. More...
 
 volFieldValue (const volFieldValue &)=delete
 No copy construct. More...
 
void operator= (const volFieldValue &)=delete
 No copy assignment. More...
 
virtual ~volFieldValue ()=default
 Destructor. More...
 
virtual bool read (const dictionary &dict)
 Read from dictionary. More...
 
virtual bool write ()
 Calculate and write. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > getFieldValues (const word &fieldName, const bool mustGet) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > filterField (const Field< Type > &field) const
 
- Public Member Functions inherited from fieldValue
 TypeName ("fieldValue")
 Run-time type information. More...
 
 declareRunTimeSelectionTable (autoPtr, fieldValue, dictionary,(const word &name, const objectRegistry &obr, const dictionary &dict),(name, obr, dict))
 
 fieldValue (const word &name, const Time &runTime, const dictionary &dict, const word &valueType)
 Construct from Time and dictionary. More...
 
 fieldValue (const word &name, const objectRegistry &obr, const dictionary &dict, const word &valueType)
 Construct from objectRegistry and dictionary. More...
 
virtual ~fieldValue ()=default
 Destructor. More...
 
const dictionarydict () const
 Return the reference to the construction dictionary. More...
 
const wordregionName () const
 Return the region name. More...
 
const wordListfields () const
 Return the list of field names. More...
 
bool writeFields () const
 Return the output field values flag. More...
 
virtual bool execute ()
 Execute. 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 ()=default
 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 ()=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...
 
- Public Member Functions inherited from stateFunctionObject
 stateFunctionObject (const word &name, const Time &runTime)
 Construct from components. More...
 
virtual ~stateFunctionObject ()=default
 Destructor. More...
 
dictionarypropertyDict ()
 Return access to the property dictionary. More...
 
bool foundProperty (const word &entryName) const
 Return true if the property exists. More...
 
label getTrigger () const
 Get the current trigger index. More...
 
bool setTrigger (const label triggeri)
 Set the current 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...
 
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...
 
List< wordobjectResultEntries () const
 Retrieve the result entries. More...
 
List< wordobjectResultEntries (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...
 
- Public Member Functions inherited from timeFunctionObject
 timeFunctionObject (const word &name, const Time &runTime)
 Construct from Time. More...
 
virtual ~timeFunctionObject ()=default
 Destructor. More...
 
const Timetime () const
 Return time database. More...
 
objectRegistrystoredObjects ()
 
const objectRegistrystoredObjects () const
 
- Public Member Functions inherited from 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)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()=default
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. 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...
 
- Public Member Functions inherited from writeFile
 writeFile (const objectRegistry &obr, const fileName &prefix, const word &name="undefined", const bool writeToFile=true)
 Construct from objectRegistry, prefix, fileName. More...
 
 writeFile (const objectRegistry &obr, const fileName &prefix, const word &name, const dictionary &dict, const bool writeToFile=true)
 
 writeFile (const writeFile &wf)
 Construct copy. More...
 
virtual ~writeFile ()=default
 Destructor. More...
 
virtual OFstreamfile ()
 Return access to the file (if only 1) More...
 
virtual bool writeToFile () const
 Flag to allow writing to file. More...
 
virtual bool canWriteHeader () const
 Flag to allow writing the header. More...
 
virtual label charWidth () const
 Return width of character stream output. More...
 
virtual void writeCommented (Ostream &os, const string &str) const
 Write a commented string to stream. More...
 
virtual void writeTabbed (Ostream &os, const string &str) const
 Write a tabbed string to stream. More...
 
virtual void writeHeader (Ostream &os, const string &str) const
 Write a commented header to stream. More...
 
virtual void writeCurrentTime (Ostream &os) const
 Write the current time to stream. More...
 
virtual void writeBreak (Ostream &os) const
 Write a break marker to the stream. More...
 
template<class Type >
void writeHeaderValue (Ostream &os, const string &property, const Type &value) const
 Write a (commented) header property and value pair. More...
 
- Public Member Functions inherited from volRegion
 TypeName ("volRegion")
 Run-time type information. More...
 
 volRegion (const fvMesh &mesh, const dictionary &dict)
 Construct from fvMesh and dictionary. More...
 
virtual ~volRegion ()=default
 Destructor. More...
 
const regionTypesregionType () const
 Return the region type. More...
 
const labelListcellIDs () const
 Return the local list of cell IDs. More...
 
label nCells () const
 Return the number of cells selected in the region. More...
 
scalar V () const
 Return total volume of the selected region. More...
 
bool update ()
 Update the cached values as required. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &)
 Update for mesh point-motion. More...
 

Static Public Attributes

static const Enum< operationTypeoperationTypeNames_
 Operation type names. More...
 
static const Enum< postOperationTypepostOperationTypeNames_
 Operation type names. More...
 
- Static Public Attributes inherited from functionObject
static int debug
 Flag to execute debug content. More...
 
static bool postProcess
 Global post-processing mode switch. More...
 
static word outputPrefix
 Directory prefix. More...
 
- Static Public Attributes inherited from writeFile
static label addChars = 8
 Additional characters for writing. More...
 
- Static Public Attributes inherited from volRegion
static const Enum< regionTypesregionTypeNames_
 Region type names. More...
 

Protected Member Functions

bool usesVol () const
 True if the operation needs the cell-volume. More...
 
bool usesMag () const
 True if the operation variant uses mag. More...
 
bool usesWeight () const
 True if the operation variant uses a weight-field. More...
 
bool canWeight (const scalarField &weightField) const
 True if operation variant uses a weight-field that is available. More...
 
template<class Type >
bool validField (const word &fieldName) const
 Return true if the field name is valid. More...
 
template<class Type >
tmp< Field< Type > > getFieldValues (const word &fieldName, const bool mustGet=false) const
 Insert field values into values list. More...
 
template<class Type >
Type processValues (const Field< Type > &values, const scalarField &V, const scalarField &weightField) const
 Apply the 'operation' to the values. More...
 
label writeAll (const scalarField &V, const scalarField &weightField)
 Helper function to output field values. More...
 
template<class Type >
bool writeValues (const word &fieldName, const scalarField &V, const scalarField &weightField)
 Templated helper function to output field values. More...
 
template<class Type >
tmp< Field< Type > > filterField (const Field< Type > &field) const
 Filter a field according to cellIds. More...
 
virtual void writeFileHeader (Ostream &os) const
 Output file header information. More...
 
- Protected Member Functions inherited from fieldValue
template<class Type >
void combineFields (Field< Type > &field)
 Combine fields from all processor domains into single field. More...
 
template<class Type >
void combineFields (tmp< Field< Type >> &)
 Combine fields from all processor domains into single field. More...
 
- Protected Member Functions inherited from fvMeshFunctionObject
 fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
 No copy construct. More...
 
void operator= (const fvMeshFunctionObject &)=delete
 No copy assignment. More...
 
- Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistryobr () 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
 
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
 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...
 
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...
 
- Protected Member Functions inherited from stateFunctionObject
const IOdictionarystateDict () const
 Return a const reference to the state dictionary. More...
 
IOdictionarystateDict ()
 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...
 
- Protected Member Functions inherited from timeFunctionObject
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...
 
- Protected Member Functions inherited from functionObject
word scopedName (const word &name) const
 Return a scoped name, e.g. used to construct local field names. More...
 
- Protected Member Functions inherited from writeFile
void initStream (Ostream &os) const
 Initialise the output stream for writing. More...
 
fileName baseFileDir () const
 Return the base directory for output. More...
 
fileName baseTimeDir () const
 Return the base directory for the current time value. More...
 
virtual autoPtr< OFstreamcreateFile (const word &name, scalar timeValue) const
 Return autoPtr to a new file for a given time. More...
 
virtual autoPtr< OFstreamcreateFile (const word &name) const
 Return autoPtr to a new file using the simulation start time. More...
 
virtual void resetFile (const word &name)
 Reset internal file pointer to new file with new name. More...
 
Omanip< int > valueWidth (const label offset=0) const
 Return the value width when writing to stream with optional offset. More...
 
void operator= (const writeFile &)=delete
 No copy assignment. More...
 
- Protected Member Functions inherited from volRegion
void writeFileHeader (const writeFile &wf, Ostream &file) const
 Output file header information. More...
 

Protected Attributes

operationType operation_
 Operation to apply to values. More...
 
postOperationType postOperation_
 Optional post-evaluation operation. More...
 
word weightFieldName_
 Weight field name - only used for weighted modes. More...
 
- Protected Attributes inherited from fieldValue
bool writeFields_
 Flag to output field values. More...
 
word regionName_
 Name of region (patch, zone, etc.) More...
 
scalar scaleFactor_
 Scaling factor. More...
 
dictionary dict_
 Construction dictionary. More...
 
wordList fields_
 Names of operand fields. More...
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
word subRegistryName_
 Name for alternative object registry. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 
const objectRegistryobrPtr_
 Pointer to alternative (eg, sub-region) objectRegistry. More...
 
- Protected Attributes inherited from timeFunctionObject
const Timetime_
 Reference to the time database. More...
 
- Protected Attributes inherited from writeFile
const objectRegistryfileObr_
 Reference to the region objectRegistry. More...
 
const fileName prefix_
 Prefix. More...
 
word fileName_
 Name of file. More...
 
autoPtr< OFstreamfilePtr_
 File pointer. More...
 
label writePrecision_
 Write precision. More...
 
bool writeToFile_
 Flag to enable/disable writing to file. More...
 
bool updateHeader_
 
bool writtenHeader_
 Flag to identify whether the header has been written. More...
 
bool useUserTime_
 
scalar startTime_
 Start time value. More...
 
- Protected Attributes inherited from volRegion
regionTypes regionType_
 Region type. More...
 
word regionName_
 Region name (cellSet, cellZone, ...) More...
 
label regionID_
 Region ID (zone ID, ...) More...
 

Additional Inherited Members

- Static Public Member Functions inherited from fieldValue
static autoPtr< fieldValueNew (const word &name, const objectRegistry &obr, const dictionary &dict, const bool output=true)
 Return a reference to the selected fieldValue. More...
 
- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &runTime, const dictionary &dict)
 Select from dictionary, based on its "type" entry. More...
 
- Public Attributes inherited from functionObject
bool log
 Flag to write log into Info. More...
 

Detailed Description

Provides a 'volRegion' specialization of the fieldValue function object.

Given a list of user-specified fields and a 'volRegion', a number of operations can be performed, such as sums, averages and integrations.

Usage
Minimal example by using system/controlDict.functions:
volFieldValue1
{
    // Mandatory entries (unmodifiable)
    type            volFieldValue;
    libs            (fieldFunctionObjects);

    // Mandatory entries (runtime modifiable)
    fields          (<field1> <field2> ... <fieldN>);
    operation       <operationType>;
    regionType      <volRegion>;

    // Optional entries (runtime modifiable)
    postOperation   none;
    weightField     alpha1;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property Description Type Req'd Dflt
type Type name: volFieldValue word yes -
libs Library name: fieldFunctionObjects word yes -
fields Names of operand fields wordList yes -
regionType Face regionType: see below word yes -
name Name for regionType word yes -
operation Operation type: see below word yes -
postOperation Post-operation type: see below word no none
weightField Name of field to apply weighting word no none

The inherited entries are elaborated in:

Options for the regionType entry:

cellZone : requires a 'name' entry to specify the cellZone
all : all cells

Options for the operation entry:

none : No operation
min : Minimum
max : Maximum
sum : Sum
sumMag : Sum of component magnitudes
average : Ensemble average
volAverage : Volume weighted average
volIntegrate : Volume integral
CoV : Coefficient of variation: standard deviation/mean
weightedSum : Weighted sum
weightedAverage : Weighted average
weightedVolAverage : Weighted volume average
weightedVolIntegrate : Weighted volume integral

Options for the postOperation entry:

none : No additional operation after calculation
mag : Component-wise mag() after normal operation
sqrt : Component-wise sqrt() after normal operation

Usage by the postProcess utility is not available.

See also
Source files

Definition at line 266 of file volFieldValue.H.

Member Enumeration Documentation

◆ operationVariant

Bitmask values for operation variants.

Enumerator
typeBase 

Base operation.

typeScalar 

Operation returns a scalar.

typeWeighted 

Operation using weighting.

typeAbsolute 

Operation using mag (eg, for weighting)

Definition at line 276 of file volFieldValue.H.

◆ operationType

Operation type enumeration.

Enumerator
opNone 

No operation.

opMin 

Minimum value.

opMax 

Maximum value.

opSum 

Sum of values.

opSumMag 

Sum of component magnitudes.

opAverage 

Ensemble average.

opVolAverage 

Volume average.

opVolIntegrate 

Volume integral.

opCoV 

Coefficient of variation.

opWeightedSum 

Weighted sum.

opWeightedAverage 

Weighted average.

opWeightedVolAverage 

Weighted volume average.

opWeightedVolIntegrate 

Weighted volume integral.

Definition at line 285 of file volFieldValue.H.

◆ postOperationType

Post-operation type enumeration.

Enumerator
postOpNone 

No additional operation after calculation.

postOpMag 

Component-wise mag after normal operation.

postOpSqrt 

Component-wise sqrt after normal operation.

Definition at line 321 of file volFieldValue.H.

Constructor & Destructor Documentation

◆ volFieldValue() [1/3]

volFieldValue ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from name, Time and dictionary.

Definition at line 194 of file volFieldValue.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ volFieldValue() [2/3]

volFieldValue ( const word name,
const objectRegistry obr,
const dictionary dict 
)

Construct from name, objectRegistry and dictionary.

Definition at line 221 of file volFieldValue.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ volFieldValue() [3/3]

volFieldValue ( const volFieldValue )
delete

No copy construct.

◆ ~volFieldValue()

virtual ~volFieldValue ( )
virtualdefault

Destructor.

Member Function Documentation

◆ usesVol()

bool usesVol ( ) const
protected

◆ usesMag()

bool usesMag ( ) const
protected

True if the operation variant uses mag.

Definition at line 105 of file volFieldValue.C.

◆ usesWeight()

bool usesWeight ( ) const
protected

True if the operation variant uses a weight-field.

Definition at line 112 of file volFieldValue.C.

◆ canWeight()

bool canWeight ( const scalarField weightField) const
inlineprotected

True if operation variant uses a weight-field that is available.

Checks for availability on any processor.

Definition at line 120 of file volFieldValue.C.

References Foam::returnReduce().

Here is the call graph for this function:

◆ validField()

bool validField ( const word fieldName) const
protected

Return true if the field name is valid.

Definition at line 36 of file volFieldValueTemplates.C.

◆ getFieldValues() [1/2]

tmp<Field<Type> > getFieldValues ( const word fieldName,
const bool  mustGet = false 
) const
protected

Insert field values into values list.

◆ processValues()

Type processValues ( const Field< Type > &  values,
const scalarField V,
const scalarField weightField 
) const
protected

Apply the 'operation' to the values.

Definition at line 89 of file volFieldValueTemplates.C.

References Foam::cmptMag(), Foam::component(), Foam::gMax(), Foam::gMin(), Foam::gSum(), n, Foam::returnReduce(), Foam::setComponent(), Foam::sqr(), Foam::sqrt(), Foam::HashTableOps::values(), and Foam::Zero.

Here is the call graph for this function:

◆ writeAll()

Foam::label writeAll ( const scalarField V,
const scalarField weightField 
)
protected

Helper function to output field values.

Definition at line 158 of file volFieldValue.C.

References Foam::endl(), and WarningInFunction.

Here is the call graph for this function:

◆ writeValues()

bool writeValues ( const word fieldName,
const scalarField V,
const scalarField weightField 
)
protected

Templated helper function to output field values.

Definition at line 203 of file volFieldValueTemplates.C.

References Foam::component(), Foam::endl(), Log, Foam::mag(), Foam::setComponent(), Foam::sqrt(), Foam::tab, and Foam::HashTableOps::values().

Here is the call graph for this function:

◆ filterField() [1/2]

tmp<Field<Type> > filterField ( const Field< Type > &  field) const
protected

Filter a field according to cellIds.

◆ writeFileHeader()

void writeFileHeader ( Ostream os) const
protectedvirtual

Output file header information.

Definition at line 133 of file volFieldValue.C.

References Foam::endl(), Foam::tab, and volRegion::writeFileHeader().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "volFieldValue"  )

Declare type-name, virtual type (with debug switch)

◆ operator=()

void operator= ( const volFieldValue )
delete

No copy assignment.

◆ read()

bool read ( const dictionary dict)
virtual

Read from dictionary.

Reimplemented from volRegion.

Definition at line 249 of file volFieldValue.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::Info, Foam::nl, and fieldValue::read().

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Calculate and write.

Reimplemented from fieldValue.

Definition at line 282 of file volFieldValue.C.

References Foam::endl(), Log, UPstream::master(), fvMeshFunctionObject::mesh_, volRegion::update(), and fieldValue::write().

Here is the call graph for this function:

◆ getFieldValues() [2/2]

Foam::tmp<Foam::Field<Type> > getFieldValues ( const word fieldName,
const bool  mustGet 
) const

Definition at line 59 of file volFieldValueTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::New(), and Foam::Zero.

Here is the call graph for this function:

◆ filterField() [2/2]

Foam::tmp<Foam::Field<Type> > filterField ( const Field< Type > &  field) const

Definition at line 344 of file volFieldValueTemplates.C.

References field(), and Foam::New().

Here is the call graph for this function:

Member Data Documentation

◆ operationTypeNames_

Operation type names.

Definition at line 317 of file volFieldValue.H.

◆ postOperationTypeNames_

Operation type names.

Definition at line 329 of file volFieldValue.H.

◆ operation_

operationType operation_
protected

Operation to apply to values.

Definition at line 337 of file volFieldValue.H.

Referenced by volFieldValue::usesVol().

◆ postOperation_

postOperationType postOperation_
protected

Optional post-evaluation operation.

Definition at line 340 of file volFieldValue.H.

◆ weightFieldName_

word weightFieldName_
protected

Weight field name - only used for weighted modes.

Definition at line 343 of file volFieldValue.H.


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