FreeFOAM The Cross-Platform CFD Toolkit
fieldMinMax Class Reference

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

#include <fieldFunctionObjects/fieldMinMax.H>


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 67 of file fieldMinMax.H.

+ Collaboration diagram for fieldMinMax:

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 wordname () 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 objectRegistryobr_
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< OFstreamfieldMinMaxFilePtr_
 Min/max file ptr.

Static Protected Attributes

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

Member Enumeration Documentation

enum modeType
Enumerator:
mdMag 
mdCmpt 

Definition at line 71 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 55 of file fieldMinMax.C.

References Foam::endl(), and WarningIn.

~fieldMinMax ( )
virtual

Definition at line 88 of file fieldMinMax.C.


Member Function Documentation

void makeFile ( )
protected

If the output file has not been created create it.

Definition at line 106 of file fieldMinMax.C.

References Foam::endl(), Foam::Info, Pstream::master(), Foam::mkDir(), Pstream::parRun(), fileName::path(), and Foam::type().

void operator= ( const fieldMinMax )
protected

Disallow default bitwise assignment.

void writeFileHeader ( )
protectedvirtual

Output file header information.

Definition at line 149 of file fieldMinMax.C.

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

TypeName ( "fieldMinMax"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the set of field min/max.

Definition at line 150 of file fieldMinMax.H.

References fieldMinMax::name_.

void read ( const dictionary dict)
virtual

Read the field min/max data.

Definition at line 94 of file fieldMinMax.C.

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

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 160 of file fieldMinMax.C.

void end ( )
virtual

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

Definition at line 166 of file fieldMinMax.C.

void write ( )
virtual

Write the fieldMinMax.

Definition at line 172 of file fieldMinMax.C.

References forAll.

virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 172 of file fieldMinMax.H.

virtual void movePoints ( const pointField )
inlinevirtual

Update for changes of mesh.

Definition at line 176 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 84 of file fieldMinMax.H.

Referenced by fieldMinMax::name().

const objectRegistry& obr_
protected

Definition at line 86 of file fieldMinMax.H.

Referenced by fieldMinMax::calcMinMaxFields().

bool active_
protected

on/off switch

Definition at line 89 of file fieldMinMax.H.

Switch log_
protected

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

Definition at line 92 of file fieldMinMax.H.

Referenced by fieldMinMax::calcMinMaxFields().

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

Mode type names.

Definition at line 95 of file fieldMinMax.H.

Referenced by fieldMinMax::calcMinMaxFields().

modeType mode_
protected

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

Definition at line 98 of file fieldMinMax.H.

Referenced by fieldMinMax::calcMinMaxFields().

wordList fieldSet_
protected

Fields to assess min/max.

Definition at line 101 of file fieldMinMax.H.

autoPtr<OFstream> fieldMinMaxFilePtr_
protected

Min/max file ptr.

Definition at line 105 of file fieldMinMax.H.

Referenced by fieldMinMax::calcMinMaxFields().


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