FreeFOAM The Cross-Platform CFD Toolkit
mag Class Reference

Calculates and writes the magnitude of a field for each time. More...

#include <foamCalcFunctions/mag.H>


Detailed Description

Calculates and writes the magnitude of a field for each time.

Source files

Definition at line 52 of file mag.H.

+ Inheritance diagram for mag:
+ Collaboration diagram for mag:

List of all members.

Public Member Functions

 TypeName ("mag")
 Runtime type information.
 mag ()
 Construct null.
virtual ~mag ()
- Public Member Functions inherited from calcType
 TypeName ("calcType")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, calcType, dictionary,(),())
 calcType ()
 Construct null.
virtual ~calcType ()
void tryInit ()
 Initialise - typically setting static variables,.
void tryPreCalc (const argList &args, const Time &runTime, const fvMesh &mesh)
 Pre-time loop calculations.
void tryCalc (const argList &args, const Time &runTime, const fvMesh &mesh)
 Time loop calculations.
void tryPostCalc (const argList &args, const Time &runTime, const fvMesh &mesh)
 Post-time loop calculations.

Protected Member Functions

virtual void init ()
 Initialise - typically setting static variables,.
virtual void preCalc (const argList &args, const Time &runTime, const fvMesh &mesh)
 Pre-time loop calculations.
virtual void calc (const argList &args, const Time &runTime, const fvMesh &mesh)
 Time loop calculations.
template<class Type >
void writeMagField (const IOobject &header, const fvMesh &mesh, bool &processed)
 Write component fields.
- Protected Member Functions inherited from calcType
virtual void postCalc (const argList &args, const Time &runTime, const fvMesh &mesh)
 Post-time loop calculations.

Additional Inherited Members

- Static Public Member Functions inherited from calcType
static autoPtr< calcTypeNew (const word &calcTypeName)

Constructor & Destructor Documentation

mag ( )

Construct null.

Definition at line 43 of file mag.C.

~mag ( )
virtual

Definition at line 51 of file mag.C.


Member Function Documentation

void init ( )
protectedvirtual

Initialise - typically setting static variables,.

e.g. command line arguments

Reimplemented from calcType.

Definition at line 57 of file mag.C.

References LList< LListBase, T >::append(), and argList::validArgs.

void preCalc ( const argList args,
const Time runTime,
const fvMesh mesh 
)
protectedvirtual

Pre-time loop calculations.

Reimplemented from calcType.

Definition at line 65 of file mag.C.

void calc ( const argList args,
const Time runTime,
const fvMesh mesh 
)
protectedvirtual

Time loop calculations.

Reimplemented from calcType.

Definition at line 74 of file mag.C.

References argList::additionalArgs(), Foam::endl(), Foam::exit(), Foam::FatalError, Foam::Info, mesh, IOobject::MUST_READ, Foam::nl, and Time::timeName().

void writeMagField ( const IOobject header,
const fvMesh mesh,
bool &  processed 
)
protected
TypeName ( "mag"  )

Runtime type information.


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