kEqn< BasicTurbulenceModel > Class Template Reference

One equation eddy-viscosity model. More...

Inheritance diagram for kEqn< BasicTurbulenceModel >:

Collaboration diagram for kEqn< 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 BasicTurbulenceModel::alphaField	alphaField
typedef BasicTurbulenceModel::rhoField	rhoField
typedef BasicTurbulenceModel::transportModel	transportModel
Public Types inherited from linearViscousStress< BasicTurbulenceModel >
typedef BasicTurbulenceModel::alphaField	alphaField
typedef BasicTurbulenceModel::rhoField	rhoField
typedef BasicTurbulenceModel::transportModel	transportModel

Public Member Functions
	TypeName ("kEqn")
	Runtime type information. More...
	kEqn (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)
	Constructor from components. More...
virtual	~kEqn ()=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...
virtual bool	read ()
	Read model coefficients if they have changed. 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 bool	read ()=0
	Re-read model coefficients if they have changed. 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< volScalarField >	k () const=0
	Return the turbulence kinetic energy. More...
virtual tmp< volSymmTensorField >	R () const
	Return the Reynolds stress tensor. More...
virtual void	validate ()
	Validate the turbulence fields after construction. More...
virtual void	correct ()=0
	Solve the turbulence equations and correct the turbulence viscosity. More...
Public Member Functions inherited from linearViscousStress< 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 bool	read ()=0
	Re-read model coefficients if they have changed. 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...
virtual void	correct ()=0
	Solve the turbulence equations and correct the turbulence viscosity. More...

Protected Member Functions
	kEqn (const kEqn &)=delete
	No copy construct. More...
void	operator= (const kEqn &)=delete
	No copy assignment. More...
virtual void	correctNut ()
virtual tmp< fvScalarMatrix >	kSource () const
virtual void	correctNut ()=0

Protected Attributes
volScalarField	k_
dimensionedScalar	Ck_
Protected Attributes inherited from eddyViscosity< LESModel< BasicTurbulenceModel > >
volScalarField	nut_

Detailed Description

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

One equation eddy-viscosity model.

Eddy viscosity SGS model using a modeled balance equation to simulate the behaviour of k.

Reference:

    Yoshizawa, A. (1986).
    Statistical theory for compressible turbulent shear flows,
    with the application to subgrid modeling.
    Physics of Fluids (1958-1988), 29(7), 2152-2164.

The default model coefficients are

    kEqnCoeffs
    {
        Ck                  0.094;
        Ce                  1.048;
    }

Source files

• kEqn.H
• kEqn.C

Definition at line 77 of file kEqn.H.

Member Typedef Documentation

alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 110 of file kEqn.H.

rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 111 of file kEqn.H.

transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 112 of file kEqn.H.

Constructor & Destructor Documentation

kEqn() [1/2]

kEqn ( const kEqn< BasicTurbulenceModel > &  )

protecteddelete

No copy construct.

kEqn() [2/2]

kEqn	(	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
	)

Constructor from components.

Definition at line 70 of file kEqn.C.

References Foam::bound(), kEqn< BasicTurbulenceModel >::k_, and Foam::type().

Here is the call graph for this function:

~kEqn()

virtual ~kEqn ( )

virtualdefault

Destructor.

Member Function Documentation

operator=()

void operator= ( const kEqn< BasicTurbulenceModel > &  )

protecteddelete

No copy assignment.

correctNut()

void correctNut

protectedvirtual

Implements eddyViscosity< LESModel< BasicTurbulenceModel > >.

Reimplemented in NicenoKEqn< BasicTurbulenceModel >.

Definition at line 42 of file kEqn.C.

References delta, Time::New(), and Foam::sqrt().

Here is the call graph for this function:

kSource()

tmp< fvScalarMatrix > kSource

protectedvirtual

Reimplemented in continuousGasKEqn< BasicTurbulenceModel >, and NicenoKEqn< BasicTurbulenceModel >.

Definition at line 53 of file kEqn.C.

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

TypeName()

TypeName

(

"kEqn< BasicTurbulenceModel >"

)

Runtime type information.

read()

bool read

virtual

Read model coefficients if they have changed.

Reimplemented from LESeddyViscosity< BasicTurbulenceModel >.

Reimplemented in continuousGasKEqn< BasicTurbulenceModel >, and NicenoKEqn< BasicTurbulenceModel >.

Definition at line 129 of file kEqn.C.

k()

virtual tmp< volScalarField > k ( ) const

inlinevirtual

Return SGS kinetic energy.

Implements eddyViscosity< LESModel< BasicTurbulenceModel > >.

Definition at line 145 of file kEqn.H.

References kEqn< BasicTurbulenceModel >::k_.

DkEff()

tmp< volScalarField > DkEff ( ) const

inline

Return the effective diffusivity for k.

Definition at line 151 of file kEqn.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 143 of file kEqn.C.

References Foam::fvc::absolute(), alpha, Foam::bound(), tmp< T >::clear(), kEpsilonLopesdaCosta< BasicTurbulenceModel >::correct(), Foam::fvm::ddt(), delta, Foam::dev(), Foam::fvc::div(), Foam::fvm::div(), divU, fvOptions, Foam::fvc::grad(), Foam::fvm::laplacian(), Time::New(), nut, phi, rho, solve(), Foam::fvm::Sp(), Foam::sqrt(), Foam::fvm::SuSp(), Foam::twoSymm(), and U.

Here is the call graph for this function:

Member Data Documentation

k_

volScalarField k_

protected

Definition at line 87 of file kEqn.H.

Referenced by kEqn< BasicTurbulenceModel >::k(), and kEqn< BasicTurbulenceModel >::kEqn().

Ck_

dimensionedScalar Ck_

protected

Definition at line 92 of file kEqn.H.

---

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

• src/TurbulenceModels/turbulenceModels/LES/kEqn/kEqn.H
• src/TurbulenceModels/turbulenceModels/LES/kEqn/kEqn.C