Realizable k-epsilon turbulence model for incompressible and compressible flows. More...

Inheritance diagram for realizableKE< BasicMomentumTransportModel >:

Collaboration diagram for realizableKE< BasicMomentumTransportModel >:

Public Types
typedef BasicMomentumTransportModel::alphaField	alphaField

typedef BasicMomentumTransportModel::rhoField	rhoField

typedef BasicMomentumTransportModel::transportModel	transportModel

Public Types inherited from eddyViscosity< RASModel< BasicMomentumTransportModel > >
typedef RASModel< BasicMomentumTransportModel > ::alphaField	alphaField

typedef RASModel< BasicMomentumTransportModel > ::rhoField	rhoField

typedef RASModel< BasicMomentumTransportModel > ::transportModel	transportModel

Public Types inherited from linearViscousStress< RASModel< BasicMomentumTransportModel > >
typedef RASModel< BasicMomentumTransportModel > ::alphaField	alphaField

typedef RASModel< BasicMomentumTransportModel > ::rhoField	rhoField

typedef RASModel< BasicMomentumTransportModel > ::transportModel	transportModel

Public Types inherited from RASModel< BasicMomentumTransportModel >
typedef BasicMomentumTransportModel::alphaField	alphaField

typedef BasicMomentumTransportModel::rhoField	rhoField

typedef BasicMomentumTransportModel::transportModel	transportModel

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

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

virtual	~realizableKE ()
	Destructor. More...

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

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

tmp< volScalarField >	DepsilonEff () const
	Return the effective diffusivity for epsilon. More...

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

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

virtual void	correct ()
	Solve the turbulence equations and correct the turbulence viscosity. More...

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

virtual	~eddyViscosity ()
	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 >	sigma () const
	Return the Reynolds stress tensor [m^2/s^2]. More...

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

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

virtual	~linearViscousStress ()
	Destructor. More...

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

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

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

Public Member Functions inherited from RASModel< BasicMomentumTransportModel >
	TypeName ("RAS")
	Runtime type information. More...

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

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

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

virtual	~RASModel ()
	Destructor. More...

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

const dimensionedScalar &	epsilonMin () const
	Return the lower allowable limit for epsilon (default: small) More...

const dimensionedScalar &	omegaMin () const
	Return the lower allowable limit for omega (default: small) More...

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

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

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

virtual const dictionary &	coeffDict () const
	Const access to the coefficients dictionary. 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...

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

Protected Member Functions
tmp< volScalarField >	rCmu (const volTensorField &gradU, const volScalarField &S2, const volScalarField &magS)

virtual void	correctNut (const volTensorField &gradU, const volScalarField &S2, const volScalarField &magS)

virtual void	correctNut ()

virtual tmp< fvScalarMatrix >	kSource () const

virtual tmp< fvScalarMatrix >	epsilonSource () const

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

Protected Attributes
dimensionedScalar	A0_

dimensionedScalar	C2_

dimensionedScalar	sigmak_

dimensionedScalar	sigmaEps_

volScalarField	k_

volScalarField	epsilon_

Protected Attributes inherited from eddyViscosity< RASModel< BasicMomentumTransportModel > >
volScalarField	nut_

Protected Attributes inherited from RASModel< BasicMomentumTransportModel >
dictionary	RASDict_
	RAS 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	kMin_
	Lower limit of k. More...

dimensionedScalar	epsilonMin_
	Lower limit of epsilon. More...

dimensionedScalar	omegaMin_
	Lower limit for omega. More...

Additional Inherited Members
Static Public Member Functions inherited from RASModel< BasicMomentumTransportModel >
static autoPtr< RASModel >	New (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)
	Return a reference to the selected RAS model. More...

Detailed Description

template<class BasicMomentumTransportModel>
class Foam::RASModels::realizableKE< BasicMomentumTransportModel >

Realizable k-epsilon turbulence model for incompressible and compressible flows.

References:

    Shih, T. H., Liou, W. W., Shabbir, A., Yang, Z., & Zhu, J. (1994).
    A new k-epsilon eddy viscosity model for high Reynolds number
    turbulent flows: Model development and validation.
    NASA STI/Recon Technical Report N, 95, 11442.

    Shih, T. H., Liou, W. W., Shabbir, A., Yang, Z., & Zhu, J. (1995).
    A New k-epsilon Eddy Viscosity Model for High Reynolds Number
    Turbulent Flows.
    Computers and Fluids, 24(3), 227-238.

The default model coefficients are

    realizableKECoeffs
    {
        A0          4.0;
        C2          1.9;
        sigmak      1.0;
        sigmaEps    1.2;
    }

Source files

Definition at line 77 of file realizableKE.H.

Member Typedef Documentation

◆ alphaField

typedef BasicMomentumTransportModel::alphaField alphaField

Definition at line 127 of file realizableKE.H.

◆ rhoField

typedef BasicMomentumTransportModel::rhoField rhoField

Definition at line 128 of file realizableKE.H.

◆ transportModel

typedef BasicMomentumTransportModel::transportModel transportModel

Definition at line 129 of file realizableKE.H.

Constructor & Destructor Documentation

◆ realizableKE()

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

Construct from components.

Definition at line 132 of file realizableKE.C.

References Foam::bound().

Referenced by realizableKE< BasicMomentumTransportModel >::epsilonSource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ~realizableKE()

virtual ~realizableKE ( )

inlinevirtual

Destructor.

Definition at line 151 of file realizableKE.H.

References realizableKE< BasicMomentumTransportModel >::read().

Here is the call graph for this function:

Member Function Documentation

◆ rCmu()

tmp< volScalarField > rCmu	(	const volTensorField &	gradU,
		const volScalarField &	S2,
		const volScalarField &	magS
	)

protected

Definition at line 41 of file realizableKE.C.

References Foam::acos(), tmp< T >::clear(), realizableKE< BasicMomentumTransportModel >::correctNut(), Foam::cos(), Foam::dev(), Foam::magSqr(), Foam::max(), Foam::min(), Foam::skew(), Foam::sqrt(), Foam::symm(), and W().

Here is the call graph for this function:

◆ correctNut() [1/2]

void correctNut	(	const volTensorField &	gradU,
		const volScalarField &	S2,
		const volScalarField &	magS
	)

protectedvirtual

Definition at line 74 of file realizableKE.C.

References optionList::correct(), options::New(), and Foam::sqr().

Here is the call graph for this function:

◆ correctNut() [2/2]

void correctNut ( )

protectedvirtual

Implements eddyViscosity< RASModel< BasicMomentumTransportModel > >.

Definition at line 87 of file realizableKE.C.

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

Referenced by realizableKE< BasicMomentumTransportModel >::rCmu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ kSource()

tmp< fvScalarMatrix > kSource ( ) const

protectedvirtual

Definition at line 98 of file realizableKE.C.

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

◆ epsilonSource()

tmp< fvScalarMatrix > epsilonSource ( ) const

protectedvirtual

Definition at line 114 of file realizableKE.C.

References Foam::dimTime, Foam::dimVolume, and realizableKE< BasicMomentumTransportModel >::realizableKE().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "realizableKE< BasicMomentumTransportModel >" )

Runtime type information.

◆ read()

bool read ( )

virtual

Re-read model coefficients if they have changed.

Implements eddyViscosity< RASModel< BasicMomentumTransportModel > >.

Definition at line 227 of file realizableKE.C.

References Foam::read().

Referenced by realizableKE< BasicMomentumTransportModel >::~realizableKE().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DkEff()

tmp<volScalarField> DkEff ( ) const

inline

Return the effective diffusivity for k.

Definition at line 161 of file realizableKE.H.

References GeometricField< scalar, fvPatchField, volMesh >::New(), and eddyViscosity< RASModel< BasicMomentumTransportModel > >::nut_.

Here is the call graph for this function:

◆ DepsilonEff()

tmp<volScalarField> DepsilonEff ( ) const

inline

Return the effective diffusivity for epsilon.

Definition at line 171 of file realizableKE.H.

References GeometricField< scalar, fvPatchField, volMesh >::New(), and eddyViscosity< RASModel< BasicMomentumTransportModel > >::nut_.

Here is the call graph for this function:

◆ k()

virtual tmp<volScalarField> k ( ) const

inlinevirtual

Return the turbulence kinetic energy.

Implements eddyViscosity< RASModel< BasicMomentumTransportModel > >.

Definition at line 181 of file realizableKE.H.

References realizableKE< BasicMomentumTransportModel >::k_.

◆ epsilon()

virtual tmp<volScalarField> epsilon ( ) const

inlinevirtual

Return the turbulence kinetic energy dissipation rate.

Definition at line 187 of file realizableKE.H.

References realizableKE< BasicMomentumTransportModel >::correct(), and realizableKE< BasicMomentumTransportModel >::epsilon_.

Here is the call graph for this function:

◆ correct()

void correct ( )

virtual

Solve the turbulence equations and correct the turbulence viscosity.

Implements eddyViscosity< RASModel< BasicMomentumTransportModel > >.

Definition at line 246 of file realizableKE.C.

References Foam::fvc::absolute(), alpha(), Foam::bound(), optionList::constrain(), correct, optionList::correct(), Foam::fvm::ddt(), Foam::dev(), Foam::fvm::div(), Foam::fvc::div(), divU, fvOptions, Foam::constant::universal::G, Foam::fvc::grad(), Foam::fvm::laplacian(), Foam::magSqr(), Foam::max(), options::New(), nut, phi, tmp< T >::ref(), rho, Foam::solve(), Foam::fvm::Sp(), Foam::sqrt(), Foam::fvm::SuSp(), Foam::symm(), and Foam::twoSymm().

Referenced by realizableKE< BasicMomentumTransportModel >::epsilon().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ A0_

dimensionedScalar A0_

protected

Definition at line 92 of file realizableKE.H.

◆ C2_

dimensionedScalar C2_

protected

Definition at line 93 of file realizableKE.H.

◆ sigmak_

dimensionedScalar sigmak_

protected

Definition at line 94 of file realizableKE.H.

◆ sigmaEps_

dimensionedScalar sigmaEps_

protected

Definition at line 95 of file realizableKE.H.

◆ k_

volScalarField k_

protected

Definition at line 100 of file realizableKE.H.

Referenced by realizableKE< BasicMomentumTransportModel >::k().

◆ epsilon_

volScalarField epsilon_

protected

Definition at line 101 of file realizableKE.H.

Referenced by realizableKE< BasicMomentumTransportModel >::epsilon().

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

src/MomentumTransportModels/momentumTransportModels/RAS/realizableKE/realizableKE.H
src/MomentumTransportModels/momentumTransportModels/RAS/realizableKE/realizableKE.C

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class BasicMomentumTransportModel> class Foam::RASModels::realizableKE< BasicMomentumTransportModel >

Member Typedef Documentation

◆ alphaField

◆ rhoField

◆ transportModel

Constructor & Destructor Documentation

◆ realizableKE()

◆ ~realizableKE()

Member Function Documentation

◆ rCmu()

◆ correctNut() [1/2]

◆ correctNut() [2/2]

◆ kSource()

◆ epsilonSource()

◆ TypeName()

◆ read()

◆ DkEff()

◆ DepsilonEff()

◆ k()

◆ epsilon()

◆ correct()

Member Data Documentation

◆ A0_

◆ C2_

◆ sigmak_

◆ sigmaEps_

◆ k_

◆ epsilon_

template<class BasicMomentumTransportModel>
class Foam::RASModels::realizableKE< BasicMomentumTransportModel >