FreeFOAM The Cross-Platform CFD Toolkit
Hosted by SourceForge:
Get FreeFOAM at SourceForge.net.
            Fast, secure and Free Open Source software downloads

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

#include <foamCalcFunctions/magSqr.H>


Detailed Description

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

Source files

Definition at line 52 of file magSqr.H.

Inheritance diagram for magSqr:
Collaboration diagram for magSqr:

List of all members.

Public Member Functions

 TypeName ("magSqr")
 Runtime type information.
 magSqr ()
 Construct null.
virtual  ~magSqr ()

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  writeMagSqrField (const IOobject &header, const fvMesh &mesh, bool &processed)
 Write component fields.

Constructor & Destructor Documentation

magSqr (  )

Construct null.

Definition at line 43 of file magSqr.C.

~magSqr (  ) [virtual]

Definition at line 51 of file magSqr.C.


Member Function Documentation

void init (  ) [protected, virtual]

Initialise - typically setting static variables,.

e.g. command line arguments

Reimplemented from calcType.

Definition at line 57 of file magSqr.C.

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

void preCalc ( const argList &   args,
const Time &   runTime,
const fvMesh &   mesh  
) [protected, virtual]

Pre-time loop calculations.

Reimplemented from calcType.

Definition at line 65 of file magSqr.C.

void calc ( const argList &   args,
const Time &   runTime,
const fvMesh &   mesh  
) [protected, virtual]

Time loop calculations.

Reimplemented from calcType.

Definition at line 74 of file magSqr.C.

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

void writeMagSqrField ( const IOobject &   header,
const fvMesh &   mesh,
bool &   processed  
) [protected]
TypeName ( "magSqr"    )

Runtime type information.


The documentation for this class was generated from the following files:
  • src/postProcessing/foamCalcFunctions/field/magSqr/magSqr.H
  • src/postProcessing/foamCalcFunctions/field/magSqr/magSqr.C
  • src/postProcessing/foamCalcFunctions/field/magSqr/writeMagSqrField.C