Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
fieldMinMax Class Reference

Calculates the value and location of scalar minimum and maximum for a list of user-specified fields. More...

Inheritance diagram for fieldMinMax:
Inheritance graph
[legend]
Collaboration diagram for fieldMinMax:
Collaboration graph
[legend]

Public Types

enum  modeType { mag, cmpt }
 

Public Member Functions

 TypeName ("fieldMinMax")
 Runtime type information. More...
 
 fieldMinMax (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
virtual ~fieldMinMax ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read the field min/max data. More...
 
virtual bool execute ()
 Execute, currently does nothing. More...
 
virtual bool write ()
 Write the fieldMinMax. 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 ()
 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 ()
 Destructor. More...
 
- 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 ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual bool setTimeStep ()
 Called by Time::setDeltaT(). Allows the function object to override. More...
 
virtual scalar timeToNextWrite ()
 Called by Time::adjustTimeStep(). Allows the function object to. 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 logFiles
 logFiles (const objectRegistry &obr, const word &prefix)
 Construct from objectRegistry and prefix. More...
 
virtual ~logFiles ()
 Destructor. More...
 
const wordListnames () const
 Return const access to the names. More...
 
PtrList< OFstream > & files ()
 Return access to the files. More...
 
OFstreamfile ()
 Return access to the file (if only 1) More...
 
OFstreamfile (const label i)
 Return file 'i'. More...
 
- Public Member Functions inherited from writeFile
 writeFile (const objectRegistry &obr, const word &prefix)
 Construct from objectRegistry and prefix. More...
 
 ~writeFile ()
 Destructor. More...
 
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...
 
Omanip< int > valueWidth (const label offset=0) const
 Return the value width when writing to stream with optional offset. More...
 
void writeCommented (Ostream &os, const string &str) const
 Write a commented string to stream. More...
 
void writeTabbed (Ostream &os, const string &str) const
 Write a tabbed string to stream. More...
 
void writeHeader (Ostream &os, const string &str) const
 Write a commented header to stream. More...
 
void writeTime (Ostream &os) const
 Write the current time to 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...
 
label charWidth () const
 Return width of character stream output. More...
 

Protected Member Functions

template<class Type >
void output (const word &fieldName, const word &outputName, const label minCell, const label maxCell, const vector &minC, const vector &maxC, const label minProci, const label maxProci, const Type &minValue, const Type &maxValue)
 Helper function to write the output. More...
 
 fieldMinMax (const fieldMinMax &)
 Disallow default bitwise copy construct. More...
 
void operator= (const fieldMinMax &)
 Disallow default bitwise assignment. More...
 
template<class Type >
void calcMinMaxFields (const word &fieldName, const modeType &mode)
 Calculate the field min/max. More...
 
virtual void writeFileHeader (const label i)
 Output file header information. 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 >
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 (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 Member Functions inherited from logFiles
virtual void createFiles ()
 Create the output file. More...
 
virtual void resetNames (const wordList &names)
 Reset the list of names from a wordList. More...
 
virtual void resetName (const word &name)
 Reset the list of names to a single name entry. More...
 

Protected Attributes

Switch location_
 Switch to write location of min/max values. More...
 
modeType mode_
 Mode for min/max - only applicable for ranks > 0. More...
 
wordList fieldSet_
 Fields to assess min/max. More...
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 
- Protected Attributes inherited from logFiles
wordList names_
 File names. More...
 
PtrList< OFstreamfilePtrs_
 File pointer. More...
 
- Protected Attributes inherited from writeFile
const objectRegistryfileObr_
 Reference to the region objectRegistry. More...
 
const word prefix_
 Prefix. More...
 

Static Protected Attributes

static const NamedEnum< modeType, 2 > modeTypeNames_
 Mode type names. 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...
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 Global post-processing mode switch. More...
 
- Static Public Attributes inherited from writeFile
static const word outputPrefix
 Directory prefix. More...
 
static label addChars = 8
 Additional characters for writing. More...
 

Detailed Description

Calculates the value and location of scalar minimum and maximum for a list of user-specified fields.

For variables with a rank greater than zero, either the min/max of a component value or the magnitude is reported. When operating in parallel, the processor owning the value is also given.

Example of function object specification:

fieldMinMax1
{
    type        fieldMinMax;
    libs        ("libfieldFunctionObjects.so");
    ...
    write       yes;
    log         yes;
    location    yes;
    mode        magnitude;
    fields
    (
        U
        p
    );
}
Usage
Property Description Required Default value
type type name: fieldMinMax yes
write write min/max data to file no yes
log write min/max data to standard output no no
location write location of the min/max value no yes
mode calculation mode: magnitude or component no magnitude

Output data is written to the file <timeDir>/fieldMinMax.dat

See also
Foam::functionObjects::fvMeshFunctionObject Foam::functionObjects::logFiles
Source files

Definition at line 122 of file fieldMinMax.H.

Member Enumeration Documentation

◆ modeType

enum modeType
strong
Enumerator
mag 
cmpt 

Definition at line 129 of file fieldMinMax.H.

Constructor & Destructor Documentation

◆ fieldMinMax() [1/2]

fieldMinMax ( const fieldMinMax )
protected

Disallow default bitwise copy construct.

Referenced by fieldMinMax::writeFileHeader().

Here is the caller graph for this function:

◆ fieldMinMax() [2/2]

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

Construct from Time and dictionary.

Definition at line 100 of file fieldMinMax.C.

References Foam::read().

Here is the call graph for this function:

◆ ~fieldMinMax()

~fieldMinMax ( )
virtual

Destructor.

Definition at line 119 of file fieldMinMax.C.

Member Function Documentation

◆ output()

void output ( const word fieldName,
const word outputName,
const label  minCell,
const label  maxCell,
const vector minC,
const vector maxC,
const label  minProci,
const label  maxProci,
const Type &  minValue,
const Type &  maxValue 
)
protected

Helper function to write the output.

Definition at line 33 of file fieldMinMaxTemplates.C.

References fieldMinMax::calcMinMaxFields(), Foam::endl(), Foam::file, Log, maxValue, Foam::nl, and Foam::tab.

Here is the call graph for this function:

◆ operator=()

void operator= ( const fieldMinMax )
protected

Disallow default bitwise assignment.

◆ calcMinMaxFields()

void calcMinMaxFields ( const word fieldName,
const modeType mode 
)
protected

Calculate the field min/max.

Definition at line 104 of file fieldMinMaxTemplates.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::findMax(), Foam::findMin(), forAll, Foam::mag(), patchi, List< T >::size(), and List< Type >::size().

Referenced by fieldMinMax::output().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ writeFileHeader()

void writeFileHeader ( const label  i)
protectedvirtual

Output file header information.

Implements logFiles.

Definition at line 57 of file fieldMinMax.C.

References Foam::endl(), fieldMinMax::fieldMinMax(), Foam::file, forAll, and UPstream::parRun().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "fieldMinMax"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read the field min/max data.

Reimplemented from regionFunctionObject.

Definition at line 125 of file fieldMinMax.C.

References dictionary::lookup(), dictionary::lookupOrDefault(), and regionFunctionObject::read().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Execute, currently does nothing.

Implements functionObject.

Definition at line 138 of file fieldMinMax.C.

◆ write()

bool write ( )
virtual

Write the fieldMinMax.

Reimplemented from logFiles.

Definition at line 144 of file fieldMinMax.C.

References Foam::endl(), Foam::file, forAll, Log, UPstream::master(), Foam::name(), Foam::nl, Foam::type(), and logFiles::write().

Here is the call graph for this function:

Member Data Documentation

◆ modeTypeNames_

const Foam::NamedEnum< Foam::functionObjects::fieldMinMax::modeType, 2 > modeTypeNames_
staticprotected

Mode type names.

Definition at line 140 of file fieldMinMax.H.

Referenced by NamedEnum< directionType, 3 >::names().

◆ location_

Switch location_
protected

Switch to write location of min/max values.

Definition at line 143 of file fieldMinMax.H.

◆ mode_

modeType mode_
protected

Mode for min/max - only applicable for ranks > 0.

Definition at line 146 of file fieldMinMax.H.

◆ fieldSet_

wordList fieldSet_
protected

Fields to assess min/max.

Definition at line 149 of file fieldMinMax.H.


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