Public Member Functions | List of all members
blendingFactor Class Reference

This function object calculates and outputs the blendingFactor as used by the bended convection schemes. The output is a volume field (cells) whose value is calculated via the maximum blending factor for any cell face. More...

Public Member Functions

 TypeName ("blendingFactor")
 Runtime type information. More...
 
 blendingFactor (const word &name, const objectRegistry &, const dictionary &, const bool loadFromFiles=false)
 Construct for given objectRegistry and dictionary. More...
 
virtual ~blendingFactor ()
 Destructor. More...
 
virtual const wordname () const
 Return name of the set of blendingFactor. More...
 
virtual void read (const dictionary &)
 Read the blendingFactor 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 blendingFactor 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...
 
template<class Type >
Foam::volScalarFieldfactor (const GeometricField< Type, fvPatchField, volMesh > &field)
 

Detailed Description

This function object calculates and outputs the blendingFactor as used by the bended convection schemes. The output is a volume field (cells) whose value is calculated via the maximum blending factor for any cell face.

Source files

Definition at line 64 of file blendingFactor.H.

Constructor & Destructor Documentation

blendingFactor ( 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 40 of file blendingFactor.C.

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

Here is the call graph for this function:

~blendingFactor ( )
virtual

Destructor.

Definition at line 76 of file blendingFactor.C.

Member Function Documentation

TypeName ( "blendingFactor"  )

Runtime type information.

virtual const word& name ( ) const
inlinevirtual

Return name of the set of blendingFactor.

Definition at line 130 of file blendingFactor.H.

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

Here is the call graph for this function:

void read ( const dictionary dict)
virtual

Read the blendingFactor data.

Definition at line 82 of file blendingFactor.C.

References dictionary::lookup(), and dictionary::lookupOrDefault().

Referenced by blendingFactor::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 92 of file blendingFactor.C.

Referenced by blendingFactor::name().

Here is the caller graph for this function:

void end ( )
virtual

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

Definition at line 102 of file blendingFactor.C.

Referenced by blendingFactor::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 110 of file blendingFactor.C.

Referenced by blendingFactor::name().

Here is the caller graph for this function:

void write ( )
virtual

Calculate the blendingFactor and write.

Definition at line 116 of file blendingFactor.C.

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

Referenced by blendingFactor::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 151 of file blendingFactor.H.

virtual void movePoints ( const polyMesh )
inlinevirtual

Update for changes of mesh.

Definition at line 155 of file blendingFactor.H.

Foam::volScalarField& factor ( const GeometricField< Type, fvPatchField, volMesh > &  field)

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