Launder and Sharma low-Reynolds k-epsilon turbulence model for incompressible and compressible and combusting flows including rapid distortion theory (RDT) based compression term. More...

Inheritance diagram for LaunderSharmaKE< BasicMomentumTransportModel >:

[legend]

Collaboration diagram for LaunderSharmaKE< BasicMomentumTransportModel >:

[legend]

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 ("LaunderSharmaKE")
	Runtime type information. More...

	LaunderSharmaKE (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...

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

virtual	~LaunderSharmaKE ()
	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...

void	operator= (const LaunderSharmaKE &)=delete
	Disallow default bitwise assignment. 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 >	fMu () const

tmp< volScalarField >	f2 () const

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	Cmu_

dimensionedScalar	C1_

dimensionedScalar	C2_

dimensionedScalar	C3_

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::LaunderSharmaKE< BasicMomentumTransportModel >

Launder and Sharma low-Reynolds k-epsilon turbulence model for incompressible and compressible and combusting flows including rapid distortion theory (RDT) based compression term.

References:

    Launder, B. E., & Sharma, B. I. (1974).
    Application of the energy-dissipation model of turbulence to the
    calculation of flow near a spinning disc.
    Letters in heat and mass transfer, 1(2), 131-137.

    For the RDT-based compression term:
    El Tahry, S. H. (1983).
    k-epsilon equation for compressible reciprocating engine flows.
    Journal of Energy, 7(4), 345-353.

The default model coefficients are

    LaunderSharmaKECoeffs
    {
        Cmu         0.09;
        C1          1.44;
        C2          1.92;
        C3          -0.33;
        alphah      1.0;    // only for compressible
        alphahk     1.0;    // only for compressible
        alphaEps    0.76923;
    }

Source files

Definition at line 81 of file LaunderSharmaKE.H.

Member Typedef Documentation

◆ alphaField

typedef BasicMomentumTransportModel::alphaField alphaField

Definition at line 117 of file LaunderSharmaKE.H.

◆ rhoField

typedef BasicMomentumTransportModel::rhoField rhoField

Definition at line 118 of file LaunderSharmaKE.H.

◆ transportModel

typedef BasicMomentumTransportModel::transportModel transportModel

Definition at line 119 of file LaunderSharmaKE.H.

Constructor & Destructor Documentation

◆ LaunderSharmaKE() [1/2]

LaunderSharmaKE	(	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 101 of file LaunderSharmaKE.C.

References Foam::bound().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LaunderSharmaKE() [2/2]

LaunderSharmaKE ( const LaunderSharmaKE< BasicMomentumTransportModel > & )

delete

Disallow default bitwise copy construction.

◆ ~LaunderSharmaKE()

virtual ~LaunderSharmaKE ( )

inlinevirtual

Destructor.

Definition at line 145 of file LaunderSharmaKE.H.

References LaunderSharmaKE< BasicMomentumTransportModel >::read().

Here is the call graph for this function:

Member Function Documentation

◆ fMu()

tmp< volScalarField > fMu ( ) const

protected

Definition at line 41 of file LaunderSharmaKE.C.

References Foam::exp(), and Foam::sqr().

Here is the call graph for this function:

◆ f2()

tmp< volScalarField > f2 ( ) const

protected

Definition at line 48 of file LaunderSharmaKE.C.

References Foam::exp(), Foam::min(), and Foam::sqr().

Here is the call graph for this function:

◆ correctNut()

void correctNut ( )

protectedvirtual

Implements eddyViscosity< RASModel< BasicMomentumTransportModel > >.

Definition at line 57 of file LaunderSharmaKE.C.

References dictionary::New(), and Foam::sqr().

Here is the call graph for this function:

◆ kSource()

tmp< fvScalarMatrix > kSource ( ) const

protectedvirtual

Definition at line 67 of file LaunderSharmaKE.C.

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

◆ epsilonSource()

tmp< fvScalarMatrix > epsilonSource ( ) const

protectedvirtual

Definition at line 83 of file LaunderSharmaKE.C.

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

Here is the call graph for this function:

◆ TypeName()

TypeName ( "LaunderSharmaKE< BasicMomentumTransportModel >" )

Runtime type information.

◆ read()

bool read ( )

virtual

Re-read model coefficients if they have changed.

Implements eddyViscosity< RASModel< BasicMomentumTransportModel > >.

Definition at line 216 of file LaunderSharmaKE.C.

References Foam::read().

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

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 155 of file LaunderSharmaKE.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 165 of file LaunderSharmaKE.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 175 of file LaunderSharmaKE.H.

References LaunderSharmaKE< BasicMomentumTransportModel >::k_.

◆ epsilon()

virtual tmp<volScalarField> epsilon ( ) const

inlinevirtual

Return the turbulence kinetic energy dissipation rate.

Definition at line 181 of file LaunderSharmaKE.H.

References LaunderSharmaKE< BasicMomentumTransportModel >::correct(), LaunderSharmaKE< BasicMomentumTransportModel >::epsilon_, and LaunderSharmaKE< BasicMomentumTransportModel >::operator=().

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 237 of file LaunderSharmaKE.C.

References Foam::fvc::absolute(), Foam::bound(), tmp< T >::clear(), fvConstraints::constrain(), correct, Foam::fvm::ddt(), Foam::dev(), Foam::fvm::div(), Foam::fvc::div(), divU, fvConstraints, fvModels, Foam::constant::universal::G, Foam::fvc::grad(), Foam::fvm::laplacian(), Foam::magSqr(), Foam::fvc::magSqrGradGrad(), dictionary::New(), nut, phi, tmp< T >::ref(), Foam::solve(), Foam::fvm::Sp(), Foam::sqrt(), Foam::fvm::SuSp(), and Foam::twoSymm().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const LaunderSharmaKE< BasicMomentumTransportModel > & )

delete

Disallow default bitwise assignment.

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

Here is the caller graph for this function:

Member Data Documentation

◆ Cmu_

dimensionedScalar Cmu_

protected

Definition at line 91 of file LaunderSharmaKE.H.

◆ C1_

dimensionedScalar C1_

protected

Definition at line 92 of file LaunderSharmaKE.H.

◆ C2_

dimensionedScalar C2_

protected

Definition at line 93 of file LaunderSharmaKE.H.

◆ C3_

dimensionedScalar C3_

protected

Definition at line 94 of file LaunderSharmaKE.H.

◆ sigmak_

dimensionedScalar sigmak_

protected

Definition at line 95 of file LaunderSharmaKE.H.

◆ sigmaEps_

dimensionedScalar sigmaEps_

protected

Definition at line 96 of file LaunderSharmaKE.H.

◆ k_

volScalarField k_

protected

Definition at line 101 of file LaunderSharmaKE.H.

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

◆ epsilon_

volScalarField epsilon_

protected

Definition at line 102 of file LaunderSharmaKE.H.

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

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

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

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ alphaField

◆ rhoField

◆ transportModel

Constructor & Destructor Documentation

◆ LaunderSharmaKE() [1/2]

◆ LaunderSharmaKE() [2/2]

◆ ~LaunderSharmaKE()

Member Function Documentation

◆ fMu()

◆ f2()

◆ correctNut()

◆ kSource()

◆ epsilonSource()

◆ TypeName()

◆ read()

◆ DkEff()

◆ DepsilonEff()

◆ k()

◆ epsilon()

◆ correct()

◆ operator=()

Member Data Documentation

◆ Cmu_

◆ C1_

◆ C2_

◆ C3_

◆ sigmak_

◆ sigmaEps_

◆ k_

◆ epsilon_

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