Free-surface turbulence damping function. More...

Inheritance diagram for VoFTurbulenceDamping:

Collaboration diagram for VoFTurbulenceDamping:

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

	VoFTurbulenceDamping (const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from explicit source name and mesh. More...

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

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

virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const word &fieldName) const
	Add explicit contribution to epsilon or omega equation. More...

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const word &fieldName) const
	Add explicit contribution to phase epsilon or omega 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	movePoints ()
	Update for mesh motion. More...

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

	TypeName ("VoFTurbulenceDamping")
	Runtime type information. More...

	VoFTurbulenceDamping (const word &sourceName, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	Construct from explicit source name and mesh. More...

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

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

virtual void	addSup (fvMatrix< scalar > &eqn, const word &fieldName) const
	Add explicit contribution to epsilon or omega equation. More...

virtual void	addSup (const volScalarField &alpha, const volScalarField &rho, fvMatrix< scalar > &eqn, const word &fieldName) const
	Add explicit contribution to phase epsilon or omega 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	movePoints ()
	Update for mesh motion. More...

void	operator= (const VoFTurbulenceDamping &)=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 dictionary &dict, const fvMesh &mesh),(name, modelType, dict, mesh))

	fvModel (const word &name, const word &modelType, const dictionary &dict, const fvMesh &mesh)
	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...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_SUP)
	Add a source term to an equation. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_RHO_SUP)
	Add a source term to a compressible equation. More...

	FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_ALPHA_RHO_SUP)
	Add a source term to a phase equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field) const
	Return source for an equation. More...

template<class Type >
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for an equation with a specified name. More...

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

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for a compressible equation with a specified name. More...

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

template<class Type >
tmp< fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const
	Return source for a phase equation with a specified name. More...

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

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

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

template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)

template<class Type >
Foam::dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds)

template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field) const

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const

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

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const

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

template<class Type >
Foam::tmp< Foam::fvMatrix< Type > >	source (const volScalarField &alpha, const volScalarField &rho, const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName) const

Additional Inherited Members
Static Public Member Functions inherited from fvModel
template<class Type , class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds, const AlphaRhoFieldType &alphaRho, const AlphaRhoFieldTypes &... alphaRhos)
	Return the dimensions of the matrix of a source term. More...

template<class Type >
static dimensionSet	sourceDims (const GeometricField< Type, fvPatchField, volMesh > &field, const dimensionSet &ds)
	Return the dimensions of the matrix of a source term (base. More...

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

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

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

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

template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > >	source (const GeometricField< Type, fvPatchField, volMesh > &field, const word &fieldName, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhos) const
	Return source for equation with specified name and dimensions. More...

Detailed Description

Free-surface turbulence damping function.

Adds an extra source term to the mixture or phase epsilon or omega equation to reduce turbulence generated near a free-surface. The implementation is based on

Reference:

    Frederix, E. M. A., Mathur, A., Dovizio, D., Geurts, B. J.,
    & Komen, E. M. J. (2018).
    Reynolds-averaged modeling of turbulence damping
    near a large-scale interface in two-phase flow.
    Nuclear engineering and design, 333, 122-130.

but with an improved formulation for the coefficient A appropriate for unstructured meshes including those with split-cell refinement patterns. However the dimensioned length-scale coefficient delta remains and must be set appropriately for the case by performing test runs and comparing with known results. Clearly this model is far from general and more research is needed in order that delta can be obtained directly from the interface flow and turbulence conditions.

Usage

Example usage:

VoFTurbulenceDamping
{
    type    VoFTurbulenceDamping;

    libs    ("libcompressibleVoFTurbulenceDamping.so");

    // Interface turbulence damping length scale
    // This is a required input as described in section 3.3 of the paper
    delta   1e-4;

    // phase   water; // Optional phase name
}

Source files

Adds an extra source term to the mixture or phase epsilon or omega equation to reduce turbulence generated near a free-surface. The implementation is based on

Reference:

    Frederix, E. M. A., Mathur, A., Dovizio, D., Geurts, B. J.,
    & Komen, E. M. J. (2018).
    Reynolds-averaged modeling of turbulence damping
    near a large-scale interface in two-phase flow.
    Nuclear engineering and design, 333, 122-130.

but with an improved formulation for the coefficient A appropriate for unstructured meshes including those with split-cell refinement patterns. However the dimensioned length-scale coefficient delta remains and must be set appropriately for the case by performing test runs and comparing with known results. Clearly this model is far from general and more research is needed in order that delta can be obtained directly from the interface flow and turbulence conditions.

Usage

Example usage:

VoFTurbulenceDamping
{
    type    VoFTurbulenceDamping;

    libs    ("libVoFTurbulenceDamping.so");

    // Interface turbulence damping length scale
    // This is a required input as described in section 3.3 of the paper
    delta   1e-4;

    // phase   water; // Optional phase name
}

Source files

Definition at line 94 of file VoFTurbulenceDamping.H.

Constructor & Destructor Documentation

◆ VoFTurbulenceDamping() [1/4]

VoFTurbulenceDamping	(	const word &	sourceName,
		const word &	modelType,
		const dictionary &	dict,
		const fvMesh &	mesh
	)

Construct from explicit source name and mesh.

◆ VoFTurbulenceDamping() [2/4]

VoFTurbulenceDamping ( const VoFTurbulenceDamping & )

delete

Disallow default bitwise copy construction.

◆ VoFTurbulenceDamping() [3/4]

VoFTurbulenceDamping	(	const word &	sourceName,
		const word &	modelType,
		const dictionary &	dict,
		const fvMesh &	mesh
	)

Construct from explicit source name and mesh.

◆ VoFTurbulenceDamping() [4/4]

VoFTurbulenceDamping ( const VoFTurbulenceDamping & )

delete

Disallow default bitwise copy construction.

Member Function Documentation

◆ TypeName() [1/2]

TypeName ( "VoFTurbulenceDamping" )

Runtime type information.

◆ addSupFields() [1/2]

virtual wordList addSupFields ( ) const

virtual

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

to the transport equation

Reimplemented from fvModel.

◆ addSup() [1/4]

virtual void addSup	(	const volScalarField &	rho,
		fvMatrix< scalar > &	eqn,
		const word &	fieldName
	)		const

virtual

Add explicit contribution to epsilon or omega equation.

◆ addSup() [2/4]

virtual void addSup	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		fvMatrix< scalar > &	eqn,
		const word &	fieldName
	)		const

virtual

Add explicit contribution to phase epsilon or omega equation.

◆ topoChange() [1/2]

virtual void topoChange ( const polyTopoChangeMap & )

virtual

Update topology using the given map.

Implements fvModel.

◆ mapMesh() [1/2]

virtual void mapMesh ( const polyMeshMap & )

virtual

Update from another mesh using the given map.

Implements fvModel.

◆ distribute() [1/2]

virtual void distribute ( const polyDistributionMap & )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

◆ movePoints() [1/2]

virtual bool movePoints ( )

virtual

Update for mesh motion.

Implements fvModel.

◆ operator=() [1/2]

void operator= ( const VoFTurbulenceDamping & )

delete

Disallow default bitwise assignment.

◆ TypeName() [2/2]

TypeName ( "VoFTurbulenceDamping" )

Runtime type information.

◆ addSupFields() [2/2]

virtual wordList addSupFields ( ) const

virtual

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

to the transport equation

Reimplemented from fvModel.

◆ addSup() [3/4]

virtual void addSup	(	fvMatrix< scalar > &	eqn,
		const word &	fieldName
	)		const

virtual

Add explicit contribution to epsilon or omega equation.

◆ addSup() [4/4]

virtual void addSup	(	const volScalarField &	alpha,
		const volScalarField &	rho,
		fvMatrix< scalar > &	eqn,
		const word &	fieldName
	)		const

virtual

Add explicit contribution to phase epsilon or omega equation.

◆ topoChange() [2/2]

virtual void topoChange ( const polyTopoChangeMap & )

virtual

Update topology using the given map.

Implements fvModel.

◆ mapMesh() [2/2]

virtual void mapMesh ( const polyMeshMap & )

virtual

Update from another mesh using the given map.

Implements fvModel.

◆ distribute() [2/2]

virtual void distribute ( const polyDistributionMap & )

virtual

Redistribute or update using the given distribution map.

Implements fvModel.

◆ movePoints() [2/2]

virtual bool movePoints ( )

virtual

Update for mesh motion.

Implements fvModel.

◆ operator=() [2/2]

void operator= ( const VoFTurbulenceDamping & )

delete

Disallow default bitwise assignment.

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

applications/solvers/multiphase/compressibleInterFoam/VoFTurbulenceDamping/VoFTurbulenceDamping.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ VoFTurbulenceDamping() [1/4]

◆ VoFTurbulenceDamping() [2/4]

◆ VoFTurbulenceDamping() [3/4]

◆ VoFTurbulenceDamping() [4/4]

Member Function Documentation

◆ TypeName() [1/2]

◆ addSupFields() [1/2]

◆ addSup() [1/4]

◆ addSup() [2/4]

◆ topoChange() [1/2]

◆ mapMesh() [1/2]

◆ distribute() [1/2]

◆ movePoints() [1/2]

◆ operator=() [1/2]

◆ TypeName() [2/2]

◆ addSupFields() [2/2]

◆ addSup() [3/4]

◆ addSup() [4/4]

◆ topoChange() [2/2]

◆ mapMesh() [2/2]

◆ distribute() [2/2]

◆ movePoints() [2/2]

◆ operator=() [2/2]