fieldExtents Class Reference

Computes the spatial minimum and maximum extents of an input field. More...

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

Public Member Functions

 TypeName ("fieldExtents")
 Runtime type information. More...
 
 fieldExtents (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 fieldExtents (const fieldExtents &)=delete
 No copy construct. More...
 
void operator= (const fieldExtents &)=delete
 No copy assignment. More...
 
virtual ~fieldExtents ()=default
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the field extents data. More...
 
virtual bool execute ()
 Execute, currently does nothing. More...
 
virtual bool write ()
 Write the fieldExtents. More...
 
template<>
Foam::tmp< Foam::volScalarFieldcalcMask (const GeometricField< scalar, fvPatchField, volMesh > &field) const
 
template<>
tmp< volScalarFieldcalcMask (const GeometricField< scalar, fvPatchField, volMesh > &field) const
 
template<class Type >
Foam::tmp< Foam::volScalarFieldcalcMask (const GeometricField< Type, fvPatchField, volMesh > &field) const
 
- 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...
 

Protected Member Functions

virtual void writeFileHeader (Ostream &os)
 Output file header information. More...
 
template<class Type >
tmp< volScalarFieldcalcMask (const GeometricField< Type, fvPatchField, volMesh > &field) const
 Return the field mask. More...
 
template<class Type >
void calcFieldExtents (const word &fieldName, const bool calcMag=false)
 Main calculation. 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 Attributes

bool internalField_
 Flag to write the internal field extents. More...
 
scalar threshold_
 Threshold value. More...
 
point C0_
 Reference position. More...
 
volFieldSelection fieldSet_
 Fields to assess. More...
 
labelHashSet patchIDs_
 Patches to assess. 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...
 

Additional Inherited Members

- 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...
 
- 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...
 

Detailed Description

Computes the spatial minimum and maximum extents of an input field.

The extents are derived from the bound box limits after identifying the locations where field values exceed the user-supplied threshold value.

Operands:

Operand Type Location
input - -
output file dat $FOAM_CASE/postProcessing/<FO>/<time>/<file>
output field - -
Usage
Minimal example by using system/controlDict.functions:
fieldExtents1
{
    // Mandatory entries (unmodifiable)
    type                fieldExtents;
    libs                (fieldFunctionObjects);

    // Mandatory entries (runtime modifiable)
    fields              (<field1> <field2> ... <fieldN>);
    threshold           0.5;

    // Optional entries (runtime modifiable)
    internalField       true;
    referencePosition   (0 0 0);

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property Description Type Req'd Dflt
type Type name: fieldExtents word yes -
libs Library name: fieldFunctionObjects word yes -
threshold Value to identify extents boundary scalar yes -
fields List of operand fields wordList yes -
internalField Flag to process the internal field bool no true
referencePosition Reference position vector no (0 0 0)
patches List of patches to process wordList no <all patches>

The inherited entries are elaborated in:

Usage by the postProcess utility is not available.

Note
For non-scalar fields, the magnitude of the field is employed and compared to the value of threshold.
See also
Source files

Definition at line 183 of file fieldExtents.H.

Constructor & Destructor Documentation

◆ fieldExtents() [1/2]

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

Construct from Time and dictionary.

Definition at line 102 of file fieldExtents.C.

References dict, and Foam::read().

Here is the call graph for this function:

◆ fieldExtents() [2/2]

fieldExtents ( const fieldExtents )
delete

No copy construct.

◆ ~fieldExtents()

virtual ~fieldExtents ( )
virtualdefault

Destructor.

Member Function Documentation

◆ writeFileHeader()

void writeFileHeader ( Ostream os)
protectedvirtual

◆ calcMask() [1/4]

tmp<volScalarField> calcMask ( const GeometricField< Type, fvPatchField, volMesh > &  field) const
protected

Return the field mask.

◆ calcFieldExtents()

void calcFieldExtents ( const word fieldName,
const bool  calcMag = false 
)
protected

Main calculation.

Definition at line 51 of file fieldExtentsTemplates.C.

References boundBox::add(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), C, fvPatch::Cf(), boundBox::empty(), Foam::endl(), forAll, Log, boundBox::max(), boundBox::min(), fvPatch::name(), Foam::nl, fvPatchField< Type >::patch(), and boundBox::reduce().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "fieldExtents"  )

Runtime type information.

◆ operator=()

void operator= ( const fieldExtents )
delete

No copy assignment.

◆ read()

bool read ( const dictionary dict)
virtual

Read the field extents data.

Reimplemented from writeFile.

Definition at line 125 of file fieldExtents.C.

References dict, Foam::endl(), polyBoundaryMesh::findIndices(), forAll, IOWarningInFunction, Foam::name(), patchNames(), regionFunctionObject::read(), and writeFile::read().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Execute, currently does nothing.

Implements functionObject.

Definition at line 175 of file fieldExtents.C.

◆ write()

bool write ( )
virtual

Write the fieldExtents.

Implements functionObject.

Definition at line 181 of file fieldExtents.C.

References Foam::endl(), Log, Foam::name(), Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ calcMask() [2/4]

Foam::tmp<Foam::volScalarField> calcMask ( const GeometricField< scalar, fvPatchField, volMesh > &  field) const

Definition at line 86 of file fieldExtents.C.

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

Here is the call graph for this function:

◆ calcMask() [3/4]

tmp<volScalarField> calcMask ( const GeometricField< scalar, fvPatchField, volMesh > &  field) const

◆ calcMask() [4/4]

Foam::tmp<Foam::volScalarField> calcMask ( const GeometricField< Type, fvPatchField, volMesh > &  field) const

Definition at line 36 of file fieldExtentsTemplates.C.

References field(), Foam::mag(), and Foam::pos().

Here is the call graph for this function:

Member Data Documentation

◆ internalField_

bool internalField_
protected

Flag to write the internal field extents.

Definition at line 194 of file fieldExtents.H.

Referenced by fieldExtents::writeFileHeader().

◆ threshold_

scalar threshold_
protected

Threshold value.

Definition at line 197 of file fieldExtents.H.

Referenced by fieldExtents::writeFileHeader().

◆ C0_

point C0_
protected

Reference position.

Definition at line 200 of file fieldExtents.H.

Referenced by fieldExtents::writeFileHeader().

◆ fieldSet_

volFieldSelection fieldSet_
protected

Fields to assess.

Definition at line 203 of file fieldExtents.H.

Referenced by fieldExtents::writeFileHeader().

◆ patchIDs_

labelHashSet patchIDs_
protected

Patches to assess.

Definition at line 206 of file fieldExtents.H.

Referenced by fieldExtents::writeFileHeader().


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