PhaseLimitStabilization< Type > Class Template Reference

Stabilization source for phase transport equations. More...

Inheritance diagram for PhaseLimitStabilization< Type >:
Collaboration diagram for PhaseLimitStabilization< Type >:

Public Member Functions

 TypeName ("PhaseLimitStabilization")
 Runtime type information. More...
 
 PhaseLimitStabilization (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
 PhaseLimitStabilization (const PhaseLimitStabilization &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~PhaseLimitStabilization ()
 Destructor. More...
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< Type > &eqn, const label fieldi)
 Source term to compressible phase equation. More...
 
virtual bool read (const dictionary &dict)
 Read dictionary. More...
 
void operator= (const PhaseLimitStabilization &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from option
 TypeName ("option")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, option, dictionary,(const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))
 
 option (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
 Construct from components. More...
 
autoPtr< optionclone () const
 Return clone. More...
 
virtual ~option ()
 Destructor. More...
 
const wordname () const
 Return const access to the source name. More...
 
const fvMeshmesh () const
 Return const access to the mesh database. More...
 
const dictionarycoeffs () const
 Return dictionary. More...
 
bool active () const
 Return const access to the source active flag. More...
 
void setApplied (const label fieldi)
 Set the applied flag to true for field index fieldi. More...
 
Switchactive ()
 Return access to the source active flag. More...
 
virtual bool isActive ()
 Is the source active? More...
 
virtual label applyToField (const word &fieldName) const
 Return index of field name if found in fieldNames list. More...
 
virtual void checkApplied () const
 Check that the source has been applied. More...
 
virtual void addSup (fvMatrix< scalar > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< vector > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< scalar > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< vector > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< sphericalTensor > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< symmTensor > &eqn, const label fieldi)
 
virtual void constrain (fvMatrix< tensor > &eqn, const label fieldi)
 
virtual void correct (volScalarField &field)
 
virtual void correct (volVectorField &field)
 
virtual void correct (volSphericalTensorField &field)
 
virtual void correct (volSymmTensorField &field)
 
virtual void correct (volTensorField &field)
 
virtual void writeHeader (Ostream &) const
 Write the source header information. More...
 
virtual void writeFooter (Ostream &) const
 Write the source footer information. More...
 
virtual void writeData (Ostream &) const
 Write the source properties. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from option
static autoPtr< optionNew (const word &name, const dictionary &dict, const fvMesh &mesh)
 Return a reference to the selected fvOption model. More...
 
- Protected Attributes inherited from option
const word name_
 Source name. More...
 
const word modelType_
 Model type. More...
 
const fvMeshmesh_
 Reference to the mesh database. More...
 
dictionary dict_
 Top level source dictionary. More...
 
dictionary coeffs_
 Dictionary containing source coefficients. More...
 
Switch active_
 Source active flag. More...
 
wordList fieldNames_
 Field names to apply source to - populated by derived models. More...
 
List< bool > applied_
 Applied flag list - corresponds to each fieldNames_ entry. More...
 

Detailed Description

template<class Type>
class Foam::fv::PhaseLimitStabilization< Type >

Stabilization source for phase transport equations.

Applies an implicit source to the phase transport equation for the specified field when the phase volume fraction is below residualAlpha. The stabilization rate is provided by the registered uniformDimensionedScalarField rate, which could be extended to also support volScalarField and volScalarField::Internal field types. The field is currently stabilized towards zero in the limit of the phase volume fraction approaching zero but this could be extended to support a specified value or a value or field looked-up from the database.

Usage
Example usage:
stabilization
{
    type            symmTensorPhaseLimitStabilization;

    field           sigma.liquid;
    rate            rLambda.liquid;
    residualAlpha   1e-3;
}
Source files

Definition at line 73 of file PhaseLimitStabilization.H.

Constructor & Destructor Documentation

◆ PhaseLimitStabilization() [1/2]

PhaseLimitStabilization ( const word name,
const word modelType,
const dictionary dict,
const fvMesh mesh 
)

Construct from components.

Definition at line 35 of file PhaseLimitStabilization.C.

References PhaseLimitStabilization< Type >::addSup().

Here is the call graph for this function:

◆ PhaseLimitStabilization() [2/2]

PhaseLimitStabilization ( const PhaseLimitStabilization< Type > &  )
delete

Disallow default bitwise copy construction.

◆ ~PhaseLimitStabilization()

virtual ~PhaseLimitStabilization ( )
inlinevirtual

Destructor.

Definition at line 111 of file PhaseLimitStabilization.H.

References PhaseLimitStabilization< Type >::addSup(), alpha(), PhaseLimitStabilization< Type >::operator=(), PhaseLimitStabilization< Type >::read(), and rho.

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "PhaseLimitStabilization< Type >"  )

Runtime type information.

◆ addSup()

void addSup ( const volScalarField alpha,
const volScalarField rho,
fvMatrix< Type > &  eqn,
const label  fieldi 
)
virtual

Source term to compressible phase equation.

Definition at line 56 of file PhaseLimitStabilization.C.

References Foam::max(), psi, fvMatrix< Type >::psi(), and Sp.

Referenced by PhaseLimitStabilization< Type >::PhaseLimitStabilization(), and PhaseLimitStabilization< Type >::~PhaseLimitStabilization().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ read()

bool read ( const dictionary dict)
virtual

Read dictionary.

Reimplemented from option.

Definition at line 73 of file PhaseLimitStabilization.C.

References Foam::blockMeshTools::read().

Referenced by PhaseLimitStabilization< Type >::~PhaseLimitStabilization().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=()

void operator= ( const PhaseLimitStabilization< Type > &  )
delete

Disallow default bitwise assignment.

Referenced by PhaseLimitStabilization< Type >::~PhaseLimitStabilization().

Here is the caller graph for this function:

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