Applies corrections to the turbulent kinetic energy equation (i.e. k) and turbulent viscosity field (i.e. nut) for incompressible multiphase flow cases. More...

Inheritance diagram for multiphaseStabilizedTurbulence:

[legend]

Collaboration diagram for multiphaseStabilizedTurbulence:

[legend]

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

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

	multiphaseStabilizedTurbulence (const multiphaseStabilizedTurbulence &)=delete
	No copy construct. More...

void	operator= (const multiphaseStabilizedTurbulence &)=delete
	No copy assignment. More...

virtual	~multiphaseStabilizedTurbulence ()=default
	Destructor. More...

virtual void	addSup (const volScalarField &rho, fvMatrix< scalar > &eqn, const label fieldi)
	Add explicit contribution to compressible k equation. More...

virtual void	addSup (fvMatrix< scalar > &eqn, const label fieldi)
	Add explicit contribution to incompressible k equation. More...

virtual void	correct (volScalarField &field)
	Correct the turbulent viscosity. More...

virtual bool	read (const dictionary &dict)
	Read source dictionary. 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< option >	clone () const
	Return clone. More...

virtual	~option ()=default
	Destructor. More...

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

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

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

bool	active () const noexcept
	True if source is active. More...

void	setApplied (const label fieldi)
	Set the applied flag to true for field index fieldi. More...

bool	active (const bool on) noexcept
	Change source active flag, return previous value. 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	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	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...

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

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. More...

Public Attributes inherited from option
bool	log
	Switch write log to Info. More...

Protected Member Functions inherited from option
void	resetApplied ()
	Resize/reset applied flag list for all fieldNames_ entries. More...

Protected Attributes inherited from option
const word	name_
	Source name. More...

const word	modelType_
	Model type. More...

const fvMesh &	mesh_
	Reference to the mesh database. More...

dictionary	dict_
	Top level source dictionary. More...

dictionary	coeffs_
	Dictionary containing source coefficients. 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...

bool	active_
	Source active flag. More...

Detailed Description

Applies corrections to the turbulent kinetic energy equation (i.e. k) and turbulent viscosity field (i.e. nut) for incompressible multiphase flow cases.

Turbulent kinetic energy is over-predicted in VOF solvers at the phase interface and throughout the water column in nearly-potential flow regions beneath surface waves.

References:

    Buoyancy source term in turbulent kinetic energy equation:
        Devolder, B., Rauwoens, P., and Troch, P. (2017).
        Application of a buoyancy-modified k-w SST turbulence model to
        simulate wave run-up around a monopile subjected to regular waves
        using OpenFOAM.
        Coastal Engineering, 125, 81-94.
        DOI:10.1016/j.coastaleng.2017.04.004

    Correction to turbulent viscosity:
        Larsen, B.E. and Fuhrman, D.R. (2018).
        On the over-production of turbulence beneath surface waves in
        Reynolds-averaged Navier-Stokes models
        J. Fluid Mech, 853, 419-460.
        DOI:10.1017/jfm.2018.577

Sources applied to:

  k         | Turbulent kinetic energy                   [m2/s2]
  nut       | Turbulent viscosity                        [m/s2]

Required fields:

  epsilon   | Turbulent kinetic energy dissipation rate  [m2/s3]
  k         | Turbulent kinetic energy                   [m2/s2]
  nut       | Turbulent viscosity                        [m/s2]

Usage

Minimal example by using constant/fvOptions:

multiphaseStabilizedTurbulence1
{
    // Mandatory entries (unmodifiable)
    type                 multiphaseStabilizedTurbulence;

    // Optional entries (unmodifiable)
    rho             <rhoName>;
    Cmu             0.09;  // from k-epsilon model
    C               1.51;  // from k-omega model
    lambda2         0.1;   // A value of 0 sets the nut correction to 0
    alpha           1.36;  // 1/Prt

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

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: multiphaseStabilizedTurbulence	word	yes	-
`rho`	Name of operand density field	word	yes	rho
`Cmu`	Model coefficient	scalar	no	0.09
`C`	Model coefficient	scalar	no	1.51
`lambda2`	Ratio of nut correction	scalar	no	0.1
`alpha`	Inverse of turbulent Prandtl number	scalar	no	1.36

The inherited entries are elaborated in:

fvOption.H

Note

The model C coefficient for the k-epsilon model equates to C2/C1 = 1.33; the (default) value of 1.51 comes from the k-omega model and is more conservative.
Only applicable to epsilon-based turbulence closure models.

Source files

Definition at line 175 of file multiphaseStabilizedTurbulence.H.

Constructor & Destructor Documentation

◆ multiphaseStabilizedTurbulence() [1/2]

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

Construct from explicit source name and mesh.

Definition at line 52 of file multiphaseStabilizedTurbulence.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, option::fieldNames_, objectRegistry::findObject(), Log, option::mesh_, turbulenceModel::propertiesName, option::resetApplied(), and List< T >::resize().

Here is the call graph for this function:

◆ multiphaseStabilizedTurbulence() [2/2]

multiphaseStabilizedTurbulence ( const multiphaseStabilizedTurbulence & )

delete

No copy construct.

◆ ~multiphaseStabilizedTurbulence()

virtual ~multiphaseStabilizedTurbulence ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "multiphaseStabilizedTurbulence" )

Runtime type information.

◆ operator=()

void operator= ( const multiphaseStabilizedTurbulence & )

delete

No copy assignment.

◆ addSup() [1/2]

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

virtual

Add explicit contribution to compressible k equation.

Reimplemented from option.

Definition at line 132 of file multiphaseStabilizedTurbulence.C.

References NotImplemented.

◆ addSup() [2/2]

void addSup	(	fvMatrix< scalar > &	eqn,
		const label	fieldi
	)

virtual

Add explicit contribution to incompressible k equation.

Reimplemented from option.

Definition at line 144 of file multiphaseStabilizedTurbulence.C.

References Foam::endl(), epsilon, Foam::exit(), Foam::FatalError, FatalErrorInFunction, g, Foam::fvc::grad(), k, Log, Foam::name(), Time::New(), turbulenceModel::propertiesName, fvMatrix< Type >::psi(), rho, and Foam::fvm::SuSp().

Here is the call graph for this function:

◆ correct()

void correct ( volScalarField & field )

virtual

Correct the turbulent viscosity.

Reimplemented from option.

Definition at line 196 of file multiphaseStabilizedTurbulence.C.

References Foam::dimless, Foam::dimTime, Foam::endl(), epsilon, field(), Foam::fvc::grad(), k, Log, Foam::magSqr(), Foam::max(), IOobject::name(), Foam::name(), turbulenceModel::propertiesName, Foam::skew(), Foam::sqr(), Foam::symm(), and U.

Here is the call graph for this function:

◆ read()

virtual bool read ( const dictionary & dict )

inlinevirtual

Read source dictionary.

Reimplemented from option.

Definition at line 254 of file multiphaseStabilizedTurbulence.H.

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

src/fvOptions/sources/derived/multiphaseStabilizedTurbulence/multiphaseStabilizedTurbulence.H
src/fvOptions/sources/derived/multiphaseStabilizedTurbulence/multiphaseStabilizedTurbulence.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ multiphaseStabilizedTurbulence() [1/2]

◆ multiphaseStabilizedTurbulence() [2/2]

◆ ~multiphaseStabilizedTurbulence()

Member Function Documentation

◆ TypeName()

◆ operator=()

◆ addSup() [1/2]

◆ addSup() [2/2]

◆ correct()

◆ read()