PhaseLimitStabilization< Type > Class Template Reference

Stabilization source for phase transport equations of Type, where <Type>=Scalar/Vector/SphericalTensor/SymmTensor/Tensor. More...

#include <PhaseLimitStabilization.H>

Inheritance diagram for PhaseLimitStabilization< Type >:

Collaboration diagram for PhaseLimitStabilization< Type >:

Public Member Functions
	TypeName ("PhaseLimitStabilization")
	Runtime type information.
	PhaseLimitStabilization (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from components.
	PhaseLimitStabilization (const PhaseLimitStabilization &)=delete
	No copy construct.
void	operator= (const PhaseLimitStabilization &)=delete
	No copy assignment.
virtual	~PhaseLimitStabilization ()=default
	Destructor.
virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< Type > &eqn, const label fieldi)
	Source term to compressible phase equation.
virtual bool	read (const dictionary &dict)
	Read dictionary.
Public Member Functions inherited from option
	TypeName ("option")
	Runtime type information.
	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.
autoPtr< option >	clone () const
	Return clone.
virtual	~option ()=default
	Destructor.
const word &	name () const noexcept
	Return const access to the source name.
const fvMesh &	mesh () const noexcept
	Return const access to the mesh database.
const dictionary &	coeffs () const noexcept
	Return dictionary.
bool	active () const noexcept
	True if source is active.
void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi.
bool	active (const bool on) noexcept
	Change source active flag, return previous value.
virtual bool	isActive ()
	Is the source active?
virtual label	applyToField (const word &fieldName) const
	Return index of field name if found in fieldNames list.
virtual void	checkApplied () const
	Check that the source has been applied.
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	correct (surfaceScalarField &field)
virtual void	correct (surfaceVectorField &field)
virtual void	correct (surfaceTensorField &field)
virtual void	postProcessSens (scalarField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessSens (vectorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessSens (tensorField &sensField, const word &fieldName=word::null, const word &designVariablesName=word::null)
virtual void	postProcessAuxSens (const volScalarField &primalField, const volScalarField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volVectorField &primalField, const volVectorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	postProcessAuxSens (const volTensorField &primalField, const volTensorField &adjointField, scalarField &sensField, const word &fieldName=word::null)
virtual void	writeHeader (Ostream &) const
	Write the source header information.
virtual void	writeFooter (Ostream &) const
	Write the source footer information.
virtual void	writeData (Ostream &) const
	Write the source properties.

Additional Inherited Members
Static Public Member Functions inherited from option
static autoPtr< option >	New (const word &name, const dictionary &dict, const fvMesh &mesh)
	Return a reference to the selected fvOption model.
Public Attributes inherited from option
bool	log
	Switch write log to Info.
Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries.
Protected Attributes inherited from option
const word	name_
	Source name.
const word	modelType_
	Model type.
const fvMesh &	mesh_
	Reference to the mesh database.
dictionary	dict_
	Top level source dictionary.
dictionary	coeffs_
	Dictionary containing source coefficients.
wordList	fieldNames_
	Field names to apply source to - populated by derived models.
List< bool >	applied_
	Applied flag list - corresponds to each fieldNames_ entry.
bool	active_
	Source active flag.

Detailed Description

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

Stabilization source for phase transport equations of Type, where <Type>=Scalar/Vector/SphericalTensor/SymmTensor/Tensor.

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

Minimal example by using constant/fvOptions:

\<Type\>PhaseLimitStabilization1
{
    // Mandatory entries (unmodifiable)
    type            \<Type\>PhaseLimitStabilization;
    field           \<fieldName\>;
    rate            \<rateName\>;

    // Mandatory entries (runtime modifiable)
    residualAlpha   1.0;

    // Mandatory/Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
type	Type name: <Type>PhaseLimitStabilization	word	yes	-
field	Name of operand field	word	yes	-
rate	Name of rate field	word	yes	-
residualAlpha	Residual alpha value below which stabilization is applied	scalar	yes	-

The inherited entries are elaborated in:

• fvOption.H

Example usage:

    stabilization
    {
        type            symmTensorPhaseLimitStabilization;

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

Source files

• PhaseLimitStabilization.H
• PhaseLimitStabilization.C

Definition at line 138 of file PhaseLimitStabilization.H.

Constructor & Destructor Documentation

PhaseLimitStabilization() [1/2]

template<class Type>

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

Construct from components.

Definition at line 30 of file PhaseLimitStabilization.C.

References option::coeffs_, dict, option::fieldNames_, option::mesh(), option::name(), option::option(), and option::resetApplied().

Referenced by operator=(), and PhaseLimitStabilization().

Here is the call graph for this function:

Here is the caller graph for this function:

PhaseLimitStabilization() [2/2]

template<class Type>

PhaseLimitStabilization ( const PhaseLimitStabilization< Type > & )

delete

No copy construct.

References PhaseLimitStabilization().

Here is the call graph for this function:

~PhaseLimitStabilization()

template<class Type>

virtual ~PhaseLimitStabilization ( )

virtualdefault

Destructor.

References alpha, dict, and rho.

Member Function Documentation

TypeName()

template<class Type>

TypeName

(

"PhaseLimitStabilization< Type >"

)

Runtime type information.

References dict, option::mesh(), and option::name().

Here is the call graph for this function:

operator=()

template<class Type>

void operator= ( const PhaseLimitStabilization< Type > & )

delete

No copy assignment.

References PhaseLimitStabilization().

Here is the call graph for this function:

addSup()

template<class Type>

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

virtual

Source term to compressible phase equation.

Definition at line 51 of file PhaseLimitStabilization.C.

References alpha, Foam::max(), option::mesh_, fvMatrix< Type >::psi(), psi, rho, and Foam::fvm::Sp().

Here is the call graph for this function:

read()

template<class Type>

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from option.

Definition at line 69 of file PhaseLimitStabilization.C.

References option::coeffs_, dict, and option::read().

Here is the call graph for this function:

---

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

• src/fvOptions/sources/derived/phaseLimitStabilization/PhaseLimitStabilization.H
• src/fvOptions/sources/derived/phaseLimitStabilization/PhaseLimitStabilization.C