Public Member Functions | List of all members

This function object calculates the magnitude of a field. The operation can be applied to any volume or surface fieldsm and the output is a volume or surface scalar field. More...

Public Member Functions

 TypeName ("calcMag")
 Runtime type information. More...
 
 calcMag (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~calcMag ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the set of calcMag. More...
 
virtual void read (const dictionary &)
 Read the calcMag data. More...
 
virtual void execute ()
 Execute, currently does nothing. More...
 
virtual void end ()
 Execute at the final time-loop, currently does nothing. More...
 
virtual void timeSet ()
 Called when time was set at the end of the Time::operator++. More...
 
virtual void write ()
 Calculate the calcMag and write. More...
 
virtual void updateMesh (const mapPolyMesh &)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &)
 Update for changes of mesh. More...
 

Detailed Description

This function object calculates the magnitude of a field. The operation can be applied to any volume or surface fieldsm and the output is a volume or surface scalar field.

Source files

Definition at line 65 of file calcMag.H.

Constructor & Destructor Documentation

calcMag ( 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 42 of file calcMag.C.

References Foam::endl(), Foam::nl, Foam::read(), and WarningIn.

Here is the call graph for this function:

~calcMag ( )
virtual

Destructor.

Definition at line 78 of file calcMag.C.

Member Function Documentation

TypeName ( "calcMag"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the set of calcMag.

Definition at line 133 of file calcMag.H.

References calcMag::end(), calcMag::execute(), calcMag::read(), calcMag::timeSet(), and calcMag::write().

Here is the call graph for this function:

void read ( const dictionary dict)
virtual

Read the calcMag data.

Definition at line 84 of file calcMag.C.

References dictionary::lookup().

Referenced by calcMag::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void execute ( )
virtual

Execute, currently does nothing.

Definition at line 99 of file calcMag.C.

References Foam::endl(), and WarningIn.

Referenced by calcMag::name().

Here is the call graph for this function:

Here is the caller graph for this function:

void end ( )
virtual

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

Definition at line 120 of file calcMag.C.

Referenced by calcMag::name().

Here is the caller graph for this function:

void timeSet ( )
virtual

Called when time was set at the end of the Time::operator++.

Definition at line 129 of file calcMag.C.

Referenced by calcMag::name().

Here is the caller graph for this function:

void write ( )
virtual

Calculate the calcMag and write.

Definition at line 135 of file calcMag.C.

References Foam::endl(), Foam::Info, IOobject::name(), Foam::nl, Foam::type(), and regIOobject::write().

Referenced by calcMag::name().

Here is the call graph for this function:

Here is the caller graph for this function:

virtual void updateMesh ( const mapPolyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 154 of file calcMag.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 158 of file calcMag.H.


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