Stabilisation source for phase transport equations. More...

Inheritance diagram for phaseLimitStabilisation:

Collaboration diagram for phaseLimitStabilisation:

Public Member Functions
	TypeName ("phaseLimitStabilisation")
	Runtime type information. More...

	phaseLimitStabilisation (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from components. More...

	phaseLimitStabilisation (const phaseLimitStabilisation &)=delete
	Disallow default bitwise copy construction. More...

virtual	~phaseLimitStabilisation ()
	Destructor. More...

virtual wordList	addSupFields () const
	Return the list of fields for which the fvModel adds source term. More...

virtual bool	movePoints ()
	Add a source term to an incompressible phase equation. More...

virtual void	topoChange (const polyTopoChangeMap &)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

virtual bool	read (const dictionary &dict)
	Read dictionary. More...

void	operator= (const phaseLimitStabilisation &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from fvModel
	TypeName ("fvModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, fvModel, dictionary,(const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict),(name, modelType, mesh, dict))

	fvModel (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
	Construct from components. More...

autoPtr< fvModel >	clone () const
	Return clone. More...

virtual	~fvModel ()
	Destructor. More...

const word &	name () const
	Return const access to the source name. More...

const fvMesh &	mesh () const
	Return const access to the mesh database. More...

const dictionary &	coeffs () const
	Return dictionary. More...

virtual bool	addsSupToField (const word &fieldName) const
	Return true if the fvModel adds a source term to the given. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

virtual void	addSup (fvMatrix< scalar > &eqn) const
	Add a source term to a field-less proxy equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const
	Add a source term to an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const VolField< Type > &field) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a compressible equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
	Return source for a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const
	Return source for an equation with a second time derivative. More...

virtual void	preUpdateMesh ()
	Prepare for mesh update. More...

virtual void	correct ()
	Correct the fvModel. More...

virtual bool	write (const bool write=true) const
	Write fvModel data. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)

template<class AlphaRhoFieldType >
const Foam::word &	fieldName (const AlphaRhoFieldType &alphaRhoField)

template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	d2dt2 (const VolField< Type > &field) const

Additional Inherited Members
Static Public Member Functions inherited from fvModel
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet	sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the dimensions of the matrix of a source term. More...

static const dimensionSet &	sourceDims (const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...

template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
	Return the name of the field associated with a source term. More...

template<class AlphaRhoFieldType >
static const word &	fieldName (const AlphaRhoFieldType &alphaRhoField)
	Return the name of the field associated with a source term (base. More...

static const word &	fieldName ()
	Return the name of the field associated with a source term. Special. More...

static autoPtr< fvModel >	New (const word &name, const fvMesh &mesh, const dictionary &dict)
	Return a reference to the selected fvModel. More...

Protected Member Functions inherited from fvModel
template<class Type >
void	addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to an equation. More...

template<class Type >
void	addSupType (const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a compressible equation. More...

template<class Type >
void	addSupType (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
	Add a source term to a phase equation. More...

template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const
	Return a source for an equation. More...

Detailed Description

Stabilisation 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 stabilisation 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 stabilised 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:

stabilisation
{
    type            phaseLimitStabilisation;

    field           sigma.liquid;

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

Source files

Definition at line 73 of file phaseLimitStabilisation.H.

Constructor & Destructor Documentation

◆ phaseLimitStabilisation() [1/2]

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

Construct from components.

Definition at line 93 of file phaseLimitStabilisation.C.

◆ phaseLimitStabilisation() [2/2]

phaseLimitStabilisation ( const phaseLimitStabilisation & )

delete

Disallow default bitwise copy construction.

◆ ~phaseLimitStabilisation()

virtual ~phaseLimitStabilisation ( )

inlinevirtual

Destructor.

Definition at line 136 of file phaseLimitStabilisation.H.

Member Function Documentation

◆ TypeName()

TypeName ( "phaseLimitStabilisation" )

Runtime type information.

◆ addSupFields()

Foam::wordList addSupFields ( ) const

virtual

Return the list of fields for which the fvModel adds source term.

to the transport equation

Reimplemented from fvModel.

Definition at line 112 of file phaseLimitStabilisation.C.

◆ movePoints()

virtual bool movePoints ( )

virtual

Add a source term to an incompressible phase equation.

Add a source term to a phase equation Update for mesh motion

Implements fvModel.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & )

virtual

Update topology using the given map.

Implements fvModel.

Definition at line 138 of file phaseLimitStabilisation.C.

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Implements fvModel.

Definition at line 142 of file phaseLimitStabilisation.C.

◆ distribute()

void distribute ( const polyDistributionMap & )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

Definition at line 146 of file phaseLimitStabilisation.C.

◆ read()

bool read ( const dictionary & dict )

virtual

Read dictionary.

Reimplemented from fvModel.

Definition at line 153 of file phaseLimitStabilisation.C.

References dict, and fvModel::read().

Here is the call graph for this function:

◆ operator=()

void operator= ( const phaseLimitStabilisation & )

delete

Disallow default bitwise assignment.

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

src/fvModels/general/phaseLimitStabilisation/phaseLimitStabilisation.H
src/fvModels/general/phaseLimitStabilisation/phaseLimitStabilisation.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ phaseLimitStabilisation() [1/2]

◆ phaseLimitStabilisation() [2/2]

◆ ~phaseLimitStabilisation()

Member Function Documentation

◆ TypeName()

◆ addSupFields()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ read()

◆ operator=()