Public Member Functions | Protected Member Functions | List of all members
magSqr Class Reference

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

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

Public Member Functions

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

Protected Member Functions

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

Additional Inherited Members

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

Detailed Description

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

Source files

Definition at line 51 of file magSqr.H.

Constructor & Destructor Documentation

magSqr ( )

Construct null.

Definition at line 43 of file magSqr.C.

~magSqr ( )
virtual

Destructor.

Definition at line 51 of file magSqr.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 magSqr.C.

References magSqr::preCalc(), and argList::validArgs.

Here is the call graph for this function:

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

References magSqr::calc().

Referenced by magSqr::init().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Time loop calculations.

Reimplemented from calcType.

Definition at line 74 of file magSqr.C.

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

Referenced by magSqr::preCalc().

Here is the call graph for this function:

Here is the caller graph for this function:

void writeMagSqrField ( const IOobject header,
const fvMesh mesh,
bool &  processed 
)
protected

Write component fields.

Definition at line 28 of file writeMagSqrField.C.

References Foam::endl(), IOobject::headerClassName(), Foam::Info, Foam::magSqr(), mesh, IOobject::name(), fvMesh::time(), Time::timeName(), and regIOobject::write().

Here is the call graph for this function:

TypeName ( "magSqr"  )

Runtime type information.


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