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 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 ()

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.

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 (  ) [protected, virtual]

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  
) [protected, virtual]

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  
) [protected, virtual]

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:
  • src/postProcessing/foamCalcFunctions/field/mag/mag.H
  • src/postProcessing/foamCalcFunctions/field/mag/mag.C
  • src/postProcessing/foamCalcFunctions/field/mag/writeMagField.C