Dynamic one equation eddy-viscosity model. More...

Inheritance diagram for dynamicKEqn< BasicTurbulenceModel >:

Collaboration diagram for dynamicKEqn< BasicTurbulenceModel >:

Public Types
typedef BasicTurbulenceModel::alphaField	alphaField

typedef BasicTurbulenceModel::rhoField	rhoField

typedef BasicTurbulenceModel::transportModel	transportModel

Public Types inherited from LESeddyViscosity< BasicTurbulenceModel >
typedef BasicTurbulenceModel::alphaField	alphaField

typedef BasicTurbulenceModel::rhoField	rhoField

typedef BasicTurbulenceModel::transportModel	transportModel

Public Types inherited from eddyViscosity< LESModel< BasicTurbulenceModel > >
typedef LESModel< BasicTurbulenceModel > ::alphaField	alphaField

typedef LESModel< BasicTurbulenceModel > ::rhoField	rhoField

typedef LESModel< BasicTurbulenceModel > ::transportModel	transportModel

Public Types inherited from linearViscousStress< LESModel< BasicTurbulenceModel > >
typedef LESModel< BasicTurbulenceModel > ::alphaField	alphaField

typedef LESModel< BasicTurbulenceModel > ::rhoField	rhoField

typedef LESModel< BasicTurbulenceModel > ::transportModel	transportModel

Public Types inherited from LESModel< BasicTurbulenceModel >
typedef BasicTurbulenceModel::alphaField	alphaField

typedef BasicTurbulenceModel::rhoField	rhoField

typedef BasicTurbulenceModel::transportModel	transportModel

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

	dynamicKEqn (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName=turbulenceModel::propertiesName, const word &type=typeName)
	Construct from components. More...

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

virtual bool	read ()
	Read model coefficients if they have changed. More...

virtual tmp< volScalarField >	k () const
	Return SGS kinetic energy. More...

tmp< volScalarField >	DkEff () const
	Return the effective diffusivity for k. More...

virtual void	correct ()
	Correct Eddy-Viscosity and related properties. More...

Public Member Functions inherited from LESeddyViscosity< BasicTurbulenceModel >
	LESeddyViscosity (const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName=turbulenceModel::propertiesName)
	Construct from components. More...

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

Public Member Functions inherited from eddyViscosity< LESModel< BasicTurbulenceModel > >
	eddyViscosity (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName)
	Construct from components. More...

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

virtual tmp< volScalarField >	nut () const
	Return the turbulence viscosity. More...

virtual tmp< scalarField >	nut (const label patchi) const
	Return the turbulence viscosity on patch. More...

virtual tmp< volSymmTensorField >	R () const
	Return the Reynolds stress tensor. More...

virtual void	validate ()
	Validate the turbulence fields after construction. More...

Public Member Functions inherited from linearViscousStress< LESModel< BasicTurbulenceModel > >
	linearViscousStress (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName)
	Construct from components. More...

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

virtual tmp< volSymmTensorField >	devRhoReff () const
	Return the effective stress tensor. More...

virtual tmp< volSymmTensorField >	devRhoReff (const volVectorField &U) const
	Return the effective stress tensor based on a given velocity field. More...

virtual tmp< fvVectorMatrix >	divDevRhoReff (volVectorField &U) const
	Return the source term for the momentum equation. More...

virtual tmp< fvVectorMatrix >	divDevRhoReff (const volScalarField &rho, volVectorField &U) const
	Return the source term for the momentum equation. More...

Public Member Functions inherited from LESModel< BasicTurbulenceModel >
	TypeName ("LES")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, LESModel, dictionary,(const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName),(alpha, rho, U, alphaRhoPhi, phi, transport, propertiesName))

	LESModel (const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName)
	Construct from components. More...

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

virtual const dictionary &	coeffDict () const
	Const access to the coefficients dictionary. More...

const dimensionedScalar &	Ce () const noexcept

const dimensionedScalar &	kMin () const
	Return the lower allowable limit for k (default: SMALL) More...

dimensionedScalar &	kMin ()
	Allow kMin to be changed. More...

const volScalarField &	delta () const
	Access function to filter width. More...

virtual tmp< volScalarField >	nuEff () const
	Return the effective viscosity. More...

virtual tmp< scalarField >	nuEff (const label patchi) const
	Return the effective viscosity on patch. More...

virtual tmp< volScalarField >	epsilon () const
	Return the turbulence kinetic energy dissipation rate. More...

virtual tmp< volScalarField >	omega () const
	Return the specific dissipation rate. More...

Protected Member Functions
volScalarField	Ck (const volSymmTensorField &D, const volScalarField &KK) const
	Calculate Ck by filtering the velocity field U. More...

volScalarField	Ce (const volSymmTensorField &D, const volScalarField &KK) const
	Calculate Ce by filtering the velocity field U. More...

volScalarField	Ce () const

void	correctNut (const volSymmTensorField &D, const volScalarField &KK)
	Update sub-grid eddy-viscosity. More...

virtual void	correctNut ()

virtual tmp< fvScalarMatrix >	kSource () const

Protected Member Functions inherited from LESModel< BasicTurbulenceModel >
virtual void	printCoeffs (const word &type)
	Print model coefficients. More...

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

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

Protected Attributes
volScalarField	k_

simpleFilter	simpleFilter_

autoPtr< LESfilter >	filterPtr_

LESfilter &	filter_

Protected Attributes inherited from eddyViscosity< LESModel< BasicTurbulenceModel > >
volScalarField	nut_

Protected Attributes inherited from LESModel< BasicTurbulenceModel >
dictionary	LESDict_
	LES coefficients dictionary. More...

Switch	turbulence_
	Turbulence on/off flag. More...

Switch	printCoeffs_
	Flag to print the model coeffs at run-time. More...

dictionary	coeffDict_
	Model coefficients dictionary. More...

dimensionedScalar	Ce_
	Empirical model constant. More...

dimensionedScalar	kMin_
	Lower limit of k. More...

dimensionedScalar	epsilonMin_
	Lower limit of epsilon. More...

dimensionedScalar	omegaMin_
	Lower limit for omega. More...

autoPtr< Foam::LESdelta >	delta_
	Run-time selectable delta model. More...

Additional Inherited Members
Static Public Member Functions inherited from LESModel< BasicTurbulenceModel >
static autoPtr< LESModel >	New (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName=turbulenceModel::propertiesName)
	Return a reference to the selected LES model. More...

Detailed Description

template<class BasicTurbulenceModel>
class Foam::LESModels::dynamicKEqn< BasicTurbulenceModel >

Dynamic one equation eddy-viscosity model.

Eddy viscosity SGS model using a modeled balance equation to simulate the behaviour of k in which a dynamic procedure is applied to evaluate the coefficients.

Reference:

    Kim, W and Menon, S. (1995).
    A new dynamic one-equation subgrid-scale model for
    large eddy simulation.
    In 33rd Aerospace Sciences Meeting and Exhibit, Reno, NV, 1995.

There are no default model coefficients but the filter used for KK must be supplied, e.g.

    dynamicKEqnCoeffs
    {
        filter simple;
    }

Source files

Definition at line 79 of file dynamicKEqn.H.

Member Typedef Documentation

◆ alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 140 of file dynamicKEqn.H.

◆ rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 141 of file dynamicKEqn.H.

◆ transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 142 of file dynamicKEqn.H.

Constructor & Destructor Documentation

◆ dynamicKEqn()

dynamicKEqn	(	const alphaField &	alpha,
		const rhoField &	rho,
		const volVectorField &	U,
		const surfaceScalarField &	alphaRhoPhi,
		const surfaceScalarField &	phi,
		const transportModel &	transport,
		const word &	propertiesName = `turbulenceModel::propertiesName`,
		const word &	type = `typeName`
	)

Construct from components.

Definition at line 157 of file dynamicKEqn.C.

References Foam::bound(), and Foam::type().

Here is the call graph for this function:

◆ ~dynamicKEqn()

virtual ~dynamicKEqn ( )

virtualdefault

Destructor.

Member Function Documentation

◆ Ck()

volScalarField Ck	(	const volSymmTensorField &	D,
		const volScalarField &	KK
	)		const

protected

Calculate Ck by filtering the velocity field U.

Definition at line 43 of file dynamicKEqn.C.

References D, delta, Foam::dev(), Foam::mag(), Foam::magSqr(), Foam::max(), Foam::sqr(), Foam::sqrt(), and Foam::Zero.

Here is the call graph for this function:

◆ Ce() [1/2]

volScalarField Ce	(	const volSymmTensorField &	D,
		const volScalarField &	KK
	)		const

protected

Calculate Ce by filtering the velocity field U.

Definition at line 80 of file dynamicKEqn.C.

References D, delta, Foam::mag(), Foam::magSqr(), and Foam::pow().

Here is the call graph for this function:

◆ Ce() [2/2]

volScalarField Ce ( ) const

protected

Definition at line 97 of file dynamicKEqn.C.

References D, Foam::dev(), Foam::fvc::grad(), Foam::magSqr(), GeometricField< Type, PatchField, GeoMesh >::max(), and Foam::symm().

Here is the call graph for this function:

◆ correctNut() [1/2]

void correctNut	(	const volSymmTensorField &	D,
		const volScalarField &	KK
	)

protected

Update sub-grid eddy-viscosity.

Definition at line 113 of file dynamicKEqn.C.

References optionList::correct(), D, delta, options::New(), and Foam::sqrt().

Here is the call graph for this function:

◆ correctNut() [2/2]

void correctNut ( )

protectedvirtual

Implements eddyViscosity< LESModel< BasicTurbulenceModel > >.

Definition at line 127 of file dynamicKEqn.C.

References Foam::fvc::grad(), Foam::magSqr(), and Foam::symm().

Here is the call graph for this function:

◆ kSource()

tmp< fvScalarMatrix > kSource ( ) const

protectedvirtual

Definition at line 139 of file dynamicKEqn.C.

References Foam::dimTime, and Foam::dimVolume.

◆ TypeName()

TypeName ( "dynamicKEqn< BasicTurbulenceModel >" )

Runtime type information.

◆ read()

bool read ( )

virtual

Read model coefficients if they have changed.

Reimplemented from LESeddyViscosity< BasicTurbulenceModel >.

Definition at line 209 of file dynamicKEqn.C.

◆ k()

virtual tmp<volScalarField> k ( ) const

inlinevirtual

Return SGS kinetic energy.

Implements eddyViscosity< LESModel< BasicTurbulenceModel > >.

Definition at line 175 of file dynamicKEqn.H.

References dynamicKEqn< BasicTurbulenceModel >::k_.

◆ DkEff()

tmp<volScalarField> DkEff ( ) const

inline

Return the effective diffusivity for k.

Definition at line 181 of file dynamicKEqn.H.

References nu, and eddyViscosity< LESModel< BasicTurbulenceModel > >::nut_.

◆ correct()

void correct ( )

virtual

Correct Eddy-Viscosity and related properties.

Implements eddyViscosity< LESModel< BasicTurbulenceModel > >.

Definition at line 223 of file dynamicKEqn.C.

References Foam::fvc::absolute(), Foam::constant::atomic::alpha, Foam::bound(), tmp< T >::clear(), eddyViscosity< LESModel< BasicTurbulenceModel > >::correct(), D, Foam::fvm::ddt(), delta, Foam::dev(), Foam::fvm::div(), Foam::fvc::div(), divU, fvOptions, Foam::constant::universal::G, Foam::fvc::grad(), Foam::fvm::laplacian(), Foam::magSqr(), GeometricField< Type, PatchField, GeoMesh >::max(), options::New(), nut, phi, rho, Foam::solve(), Foam::fvm::Sp(), Foam::sqrt(), Foam::fvm::SuSp(), Foam::symm(), and U.

Here is the call graph for this function:

Member Data Documentation

◆ k_

volScalarField k_

protected

Definition at line 98 of file dynamicKEqn.H.

Referenced by dynamicKEqn< BasicTurbulenceModel >::k().

◆ simpleFilter_

simpleFilter simpleFilter_

protected

Definition at line 103 of file dynamicKEqn.H.

◆ filterPtr_

autoPtr<LESfilter> filterPtr_

protected

Definition at line 104 of file dynamicKEqn.H.

◆ filter_

LESfilter& filter_

protected

Definition at line 105 of file dynamicKEqn.H.

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

src/TurbulenceModels/turbulenceModels/LES/dynamicKEqn/dynamicKEqn.H
src/TurbulenceModels/turbulenceModels/LES/dynamicKEqn/dynamicKEqn.C

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class BasicTurbulenceModel> class Foam::LESModels::dynamicKEqn< BasicTurbulenceModel >

Member Typedef Documentation

◆ alphaField

◆ rhoField

◆ transportModel

Constructor & Destructor Documentation

◆ dynamicKEqn()

◆ ~dynamicKEqn()

Member Function Documentation

◆ Ck()

◆ Ce() [1/2]

◆ Ce() [2/2]

◆ correctNut() [1/2]

◆ correctNut() [2/2]

◆ kSource()

◆ TypeName()

◆ read()

◆ k()

◆ DkEff()

◆ correct()

Member Data Documentation

◆ k_

◆ simpleFilter_

◆ filterPtr_

◆ filter_

template<class BasicTurbulenceModel>
class Foam::LESModels::dynamicKEqn< BasicTurbulenceModel >