Public Member Functions | List of all members
CourantNo Class Reference

This function object calculates and outputs the Courant number as a volScalarField. The field is stored on the mesh database so that it can be retrieved and used for other applications. More...

Public Member Functions

 TypeName ("CourantNo")
 Runtime type information. More...
 
 CourantNo (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~CourantNo ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the set of CourantNo. More...
 
virtual void read (const dictionary &)
 Read the CourantNo 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 CourantNo 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 and outputs the Courant number as a volScalarField. The field is stored on the mesh database so that it can be retrieved and used for other applications.

Source files

Definition at line 60 of file CourantNo.H.

Constructor & Destructor Documentation

CourantNo ( 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 60 of file CourantNo.C.

References Foam::dimless, Foam::endl(), mesh, Foam::nl, IOobject::NO_READ, IOobject::NO_WRITE, Foam::read(), fvMesh::time(), Time::timeName(), Foam::type(), and WarningIn.

Here is the call graph for this function:

~CourantNo ( )
virtual

Destructor.

Definition at line 121 of file CourantNo.C.

Member Function Documentation

TypeName ( "CourantNo"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the set of CourantNo.

Definition at line 121 of file CourantNo.H.

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

Here is the call graph for this function:

void read ( const dictionary dict)
virtual

Read the CourantNo data.

Definition at line 127 of file CourantNo.C.

References dictionary::lookupOrDefault().

Referenced by CourantNo::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 137 of file CourantNo.C.

References TimeState::deltaT(), GeometricField< Type, PatchField, GeoMesh >::dimensionedInternalField(), objectRegistry::lookupObject(), Foam::mag(), mesh, phi, Foam::fvc::surfaceSum(), fvMesh::time(), Foam::type(), and fvMesh::V().

Referenced by CourantNo::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 163 of file CourantNo.C.

Referenced by CourantNo::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 172 of file CourantNo.C.

Referenced by CourantNo::name().

Here is the caller graph for this function:

void write ( )
virtual

Calculate the CourantNo and write.

Definition at line 176 of file CourantNo.C.

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

Referenced by CourantNo::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 142 of file CourantNo.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 146 of file CourantNo.H.


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