OpenFOAM logo
The Open Source CFD Toolbox
  Source Guide OpenCFD Solutions Contact OpenFOAM

fieldMinMax Class Reference

Calculates scalar minimim and maximum field values. More...

Collaboration diagram for fieldMinMax:

Collaboration graph
[legend]

List of all members.


Public Types

enum  modeType { mdMag, mdCmpt }

Public Member Functions

 TypeName ("fieldMinMax")
 Runtime type information.
 fieldMinMax (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary.
virtual ~fieldMinMax ()
virtual const word & name () const
 Return name of the set of field min/max.
virtual void read (const dictionary &)
 Read the field min/max data.
virtual void execute ()
 Execute, currently does nothing.
virtual void end ()
 Execute at the final time-loop, currently does nothing.
template<class Type >
void calcMinMaxFields (const word &fieldName)
 Calculate the field min/max.
virtual void write ()
 Write the fieldMinMax.
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh.
virtual void movePoints (const pointField &)
 Update for changes of mesh.

Protected Member Functions

void makeFile ()
 If the output file has not been created create it.
 fieldMinMax (const fieldMinMax &)
 Disallow default bitwise copy construct.
void operator= (const fieldMinMax &)
 Disallow default bitwise assignment.
virtual void writeFileHeader ()
 Output file header information.

Protected Attributes

word name_
 Name of this set of field min/max.
const objectRegistry & obr_
bool active_
 on/off switch
Switch log_
 Switch to send output to Info as well as to file.
modeType mode_
 Mode for min/max - only applicable for ranks > 0.
wordList fieldSet_
 Fields to assess min/max.
autoPtr< OFstream > fieldMinMaxFilePtr_
 Min/max file ptr.

Static Protected Attributes

static const NamedEnum
< modeType, 2 > 		modeTypeNames_
 Mode type names.

Detailed Description

Calculates scalar minimim and maximum field values.

For variables with rank > 0, computes the magnitude of the min/max values.

Data written to the file <timeDir>/fieldMinMax.dat

Source files

Definition at line 62 of file fieldMinMax.H.

Member Enumeration Documentation

enum modeType

Enumerator:
mdMag 
mdCmpt 

Definition at line 66 of file fieldMinMax.H.

Constructor & Destructor Documentation

fieldMinMax ( const fieldMinMax &   )  [protected]

Disallow default bitwise copy construct.

fieldMinMax ( const word &  name,
const objectRegistry &  obr,
const dictionary &  dict,
const bool  loadFromFiles = false 
)

Construct for given objectRegistry and dictionary.

Allow the possibility to load fields from files

Definition at line 47 of file fieldMinMax.C.

References fieldMinMax::active_, fieldMinMax::obr_, and WarningIn.

~fieldMinMax (  )  [virtual]

Definition at line 80 of file fieldMinMax.C.

Member Function Documentation

void makeFile (  )  [protected]

If the output file has not been created create it.

Definition at line 98 of file fieldMinMax.C.

References fieldMinMax::fieldSet_, fieldMinMax::log_, dictionary::lookup(), dictionary::lookupOrDefault(), fieldMinMax::mode_, and fieldMinMax::modeTypeNames_.

Here is the call graph for this function:

void operator= ( const fieldMinMax &   )  [protected]

Disallow default bitwise assignment.

void writeFileHeader (  )  [protected, virtual]

Output file header information.

Definition at line 141 of file fieldMinMax.C.

TypeName ( "fieldMinMax"   ) 

Runtime type information.

virtual const word& name (  )  const [inline, virtual]

Return name of the set of field min/max.

Definition at line 149 of file fieldMinMax.H.

References fieldMinMax::name_.

void read ( const dictionary &  dict  )  [virtual]

Read the field min/max data.

Definition at line 86 of file fieldMinMax.C.

void execute (  )  [virtual]

Execute, currently does nothing.

Definition at line 152 of file fieldMinMax.C.

References Foam::endl(), fieldMinMax::fieldMinMaxFilePtr_, and Foam::tab.

Here is the call graph for this function:

void end (  )  [virtual]

Execute at the final time-loop, currently does nothing.

Definition at line 158 of file fieldMinMax.C.

void calcMinMaxFields ( const word &  fieldName  )  [inline]

Calculate the field min/max.

Definition at line 26 of file fieldMinMaxTemplates.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorIn, fieldMinMax::fieldMinMaxFilePtr_, objectRegistry::foundObject(), Foam::Info, fieldMinMax::log_, objectRegistry::lookupObject(), Foam::mag(), Pstream::master(), Foam::max(), fieldMinMax::mdCmpt, fieldMinMax::mdMag, Foam::min(), fieldMinMax::mode_, fieldMinMax::modeTypeNames_, Foam::nl, fieldMinMax::obr_, Foam::tab, objectRegistry::time(), and dimensioned< Type >::value().

Here is the call graph for this function:

void write (  )  [virtual]

Write the fieldMinMax.

Definition at line 164 of file fieldMinMax.C.

virtual void updateMesh ( const mapPolyMesh &   )  [inline, virtual]

Update for changes of mesh.

Definition at line 171 of file fieldMinMax.H.

virtual void movePoints ( const pointField &   )  [inline, virtual]

Update for changes of mesh.

Definition at line 175 of file fieldMinMax.H.

Member Data Documentation

word name_ [protected]

Name of this set of field min/max.

Also used as the name of the output directory.

Definition at line 81 of file fieldMinMax.H.

Referenced by fieldMinMax::name().

const objectRegistry& obr_ [protected]

Definition at line 83 of file fieldMinMax.H.

Referenced by fieldMinMax::calcMinMaxFields(), and fieldMinMax::fieldMinMax().

bool active_ [protected]

on/off switch

Definition at line 86 of file fieldMinMax.H.

Referenced by fieldMinMax::fieldMinMax().

Switch log_ [protected]

Switch to send output to Info as well as to file.

Definition at line 89 of file fieldMinMax.H.

Referenced by fieldMinMax::calcMinMaxFields(), and fieldMinMax::makeFile().

const Foam::NamedEnum< Foam::fieldMinMax::modeType, 2 > modeTypeNames_ [static, protected]

Mode type names.

Definition at line 92 of file fieldMinMax.H.

Referenced by fieldMinMax::calcMinMaxFields(), and fieldMinMax::makeFile().

modeType mode_ [protected]

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

Definition at line 95 of file fieldMinMax.H.

Referenced by fieldMinMax::calcMinMaxFields(), and fieldMinMax::makeFile().

wordList fieldSet_ [protected]

Fields to assess min/max.

Definition at line 98 of file fieldMinMax.H.

Referenced by fieldMinMax::makeFile().

autoPtr<OFstream> fieldMinMaxFilePtr_ [protected]

Min/max file ptr.

Definition at line 102 of file fieldMinMax.H.

Referenced by fieldMinMax::calcMinMaxFields(), and fieldMinMax::execute().

The documentation for this class was generated from the following files:
Copyright © 2000-2009 OpenCFD Ltd