Public Member Functions | List of all members

This function object calculates and outputs the Peclet number as a surfaceScalarField. More...

Public Member Functions

 TypeName ("Peclet")
 Runtime type information. More...
 
 Peclet (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~Peclet ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the set of Peclet. More...
 
virtual void read (const dictionary &)
 Read the Peclet 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 Peclet 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 Peclet number as a surfaceScalarField.

Source files

Definition at line 62 of file Peclet.H.

Constructor & Destructor Documentation

Peclet ( 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 45 of file Peclet.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:

~Peclet ( )
virtual

Destructor.

Definition at line 105 of file Peclet.C.

Member Function Documentation

TypeName ( "Peclet"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the set of Peclet.

Definition at line 117 of file Peclet.H.

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

Here is the call graph for this function:

void read ( const dictionary dict)
virtual

Read the Peclet data.

Definition at line 111 of file Peclet.C.

References dictionary::lookupOrDefault().

Referenced by Peclet::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 121 of file Peclet.C.

References Foam::exit(), Foam::FatalError, FatalErrorIn, objectRegistry::foundObject(), Foam::fvc::interpolate(), dictionary::lookup(), objectRegistry::lookupObject(), Foam::mag(), fvMesh::magSf(), mesh, IOobject::NO_READ, IOobject::NO_WRITE, phi, turbulenceModel::propertiesName, rho, fvMesh::time(), Time::timeName(), and Foam::type().

Referenced by Peclet::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 207 of file Peclet.C.

Referenced by Peclet::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 215 of file Peclet.C.

Referenced by Peclet::name().

Here is the caller graph for this function:

void write ( )
virtual

Calculate the Peclet and write.

Definition at line 221 of file Peclet.C.

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

Referenced by Peclet::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 138 of file Peclet.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 142 of file Peclet.H.


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