Shih's quadratic algebraic Reynolds stress k-epsilon turbulence model for incompressible flows. More...

Inheritance diagram for ShihQuadraticKE:

Collaboration diagram for ShihQuadraticKE:

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

	ShihQuadraticKE (const geometricOneField &alpha, const geometricOneField &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	~ShihQuadraticKE ()=default
	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 nonlinearEddyViscosity< incompressible::RASModel >
	nonlinearEddyViscosity (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	~nonlinearEddyViscosity ()=default
	Destructor. More...

virtual tmp< volSymmTensorField >	R () const
	Return the Reynolds stress tensor. 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 eddyViscosity< 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
virtual void	correctNut ()

virtual void	correctNonlinearStress (const volTensorField &gradU)

virtual void	correctNonlinearStress (const volTensorField &gradU)=0

virtual void	correctNut ()=0

Protected Attributes
dimensionedScalar	Ceps1_

dimensionedScalar	Ceps2_

dimensionedScalar	sigmak_

dimensionedScalar	sigmaEps_

dimensionedScalar	Cmu1_

dimensionedScalar	Cmu2_

dimensionedScalar	Cbeta_

dimensionedScalar	Cbeta1_

dimensionedScalar	Cbeta2_

dimensionedScalar	Cbeta3_

volScalarField	k_

volScalarField	epsilon_

Protected Attributes inherited from nonlinearEddyViscosity< incompressible::RASModel >
volSymmTensorField	nonlinearStress_

Protected Attributes inherited from eddyViscosity< BasicTurbulenceModel >
volScalarField	nut_

Additional Inherited Members
Public Types inherited from nonlinearEddyViscosity< incompressible::RASModel >
typedef BasicTurbulenceModel::alphaField	alphaField

typedef BasicTurbulenceModel::rhoField	rhoField

typedef BasicTurbulenceModel::transportModel	transportModel

Public Types inherited from eddyViscosity< 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

Detailed Description

Shih's quadratic algebraic Reynolds stress k-epsilon turbulence model for incompressible flows.

This turbulence model is described in:

    Shih, T. H., Zhu, J., & Lumley, J. L. (1993).
    A realizable Reynolds stress algebraic equation model.
    NASA technical memorandum 105993.

Implemented according to the specification in: Apsley: Turbulence Models 2002

Source files

Definition at line 72 of file ShihQuadraticKE.H.

Constructor & Destructor Documentation

◆ ShihQuadraticKE()

ShihQuadraticKE	(	const geometricOneField &	alpha,
		const geometricOneField &	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 81 of file ShihQuadraticKE.C.

References Foam::bound(), ShihQuadraticKE::epsilon_, ShihQuadraticKE::k_, and Foam::type().

Here is the call graph for this function:

◆ ~ShihQuadraticKE()

virtual ~ShihQuadraticKE ( )

virtualdefault

Destructor.

Member Function Documentation

◆ correctNut()

void correctNut ( )

protectedvirtual

Implements eddyViscosity< BasicTurbulenceModel >.

Definition at line 50 of file ShihQuadraticKE.C.

References ShihQuadraticKE::correctNonlinearStress(), and Foam::fvc::grad().

Here is the call graph for this function:

◆ correctNonlinearStress()

void correctNonlinearStress ( const volTensorField & gradU )

protectedvirtual

Implements nonlinearEddyViscosity< incompressible::RASModel >.

Definition at line 56 of file ShihQuadraticKE.C.

References ShihQuadraticKE::Cbeta1_, ShihQuadraticKE::Cbeta2_, ShihQuadraticKE::Cbeta3_, ShihQuadraticKE::Cbeta_, ShihQuadraticKE::Cmu1_, ShihQuadraticKE::Cmu2_, GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::dev(), ShihQuadraticKE::epsilon_, Foam::innerSqr(), ShihQuadraticKE::k_, Foam::mag(), nonlinearEddyViscosity< incompressible::RASModel >::nonlinearStress_, eddyViscosity< BasicTurbulenceModel >::nut_, Foam::pow3(), Foam::skew(), Foam::sqr(), Foam::sqrt(), Foam::symm(), and Foam::twoSymm().

Referenced by ShihQuadraticKE::correct(), and ShihQuadraticKE::correctNut().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "ShihQuadraticKE" )

Runtime type information.

◆ read()

bool read ( )

virtual

Re-read model coefficients if they have changed.

Implements eddyViscosity< BasicTurbulenceModel >.

Definition at line 234 of file ShihQuadraticKE.C.

References ShihQuadraticKE::Cbeta1_, ShihQuadraticKE::Cbeta2_, ShihQuadraticKE::Cbeta3_, ShihQuadraticKE::Cbeta_, ShihQuadraticKE::Ceps1_, ShihQuadraticKE::Ceps2_, ShihQuadraticKE::Cmu1_, ShihQuadraticKE::Cmu2_, dimensioned< Type >::readIfPresent(), ShihQuadraticKE::sigmaEps_, and ShihQuadraticKE::sigmak_.

Here is the call graph for this function:

◆ DkEff()

tmp< volScalarField > DkEff ( ) const

inline

Return the effective diffusivity for k.

Definition at line 139 of file ShihQuadraticKE.H.

References nu, eddyViscosity< BasicTurbulenceModel >::nut_, and ShihQuadraticKE::sigmak_.

Referenced by ShihQuadraticKE::correct().

Here is the caller graph for this function:

◆ DepsilonEff()

tmp< volScalarField > DepsilonEff ( ) const

inline

Return the effective diffusivity for epsilon.

Definition at line 148 of file ShihQuadraticKE.H.

References nu, eddyViscosity< BasicTurbulenceModel >::nut_, and ShihQuadraticKE::sigmaEps_.

Referenced by ShihQuadraticKE::correct().

Here is the caller graph for this function:

◆ k()

virtual tmp< volScalarField > k ( ) const

inlinevirtual

Return the turbulence kinetic energy.

Implements eddyViscosity< BasicTurbulenceModel >.

Definition at line 157 of file ShihQuadraticKE.H.

References ShihQuadraticKE::k_.

◆ epsilon()

virtual tmp< volScalarField > epsilon ( ) const

inlinevirtual

Return the turbulence kinetic energy dissipation rate.

Definition at line 163 of file ShihQuadraticKE.H.

References ShihQuadraticKE::epsilon_.

◆ correct()

void correct ( )

virtual

Solve the turbulence equations and correct the turbulence viscosity.

Implements eddyViscosity< BasicTurbulenceModel >.

Definition at line 256 of file ShihQuadraticKE.C.

References Foam::bound(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), ShihQuadraticKE::Ceps1_, ShihQuadraticKE::Ceps2_, kEpsilonLopesdaCosta< BasicTurbulenceModel >::correct(), ShihQuadraticKE::correctNonlinearStress(), Foam::fvm::ddt(), ShihQuadraticKE::DepsilonEff(), Foam::fvm::div(), ShihQuadraticKE::DkEff(), ShihQuadraticKE::epsilon_, Foam::fvc::grad(), ShihQuadraticKE::k_, Foam::fvm::laplacian(), nonlinearEddyViscosity< incompressible::RASModel >::nonlinearStress_, eddyViscosity< BasicTurbulenceModel >::nut_, tmp< T >::ref(), solve(), Foam::fvm::Sp(), Foam::twoSymm(), and GeometricBoundaryField< Type, PatchField, GeoMesh >::updateCoeffs().

Here is the call graph for this function:

Member Data Documentation

◆ Ceps1_

dimensionedScalar Ceps1_

protected

Definition at line 83 of file ShihQuadraticKE.H.

Referenced by ShihQuadraticKE::correct(), and ShihQuadraticKE::read().

◆ Ceps2_

dimensionedScalar Ceps2_

protected

Definition at line 84 of file ShihQuadraticKE.H.

Referenced by ShihQuadraticKE::correct(), and ShihQuadraticKE::read().

◆ sigmak_

dimensionedScalar sigmak_

protected

Definition at line 85 of file ShihQuadraticKE.H.

Referenced by ShihQuadraticKE::DkEff(), and ShihQuadraticKE::read().

◆ sigmaEps_

dimensionedScalar sigmaEps_

protected

Definition at line 86 of file ShihQuadraticKE.H.

Referenced by ShihQuadraticKE::DepsilonEff(), and ShihQuadraticKE::read().

◆ Cmu1_

dimensionedScalar Cmu1_

protected

Definition at line 87 of file ShihQuadraticKE.H.

Referenced by ShihQuadraticKE::correctNonlinearStress(), and ShihQuadraticKE::read().

◆ Cmu2_

dimensionedScalar Cmu2_

protected

Definition at line 88 of file ShihQuadraticKE.H.

Referenced by ShihQuadraticKE::correctNonlinearStress(), and ShihQuadraticKE::read().

◆ Cbeta_

dimensionedScalar Cbeta_

protected

Definition at line 89 of file ShihQuadraticKE.H.

Referenced by ShihQuadraticKE::correctNonlinearStress(), and ShihQuadraticKE::read().

◆ Cbeta1_

dimensionedScalar Cbeta1_

protected

Definition at line 90 of file ShihQuadraticKE.H.

Referenced by ShihQuadraticKE::correctNonlinearStress(), and ShihQuadraticKE::read().

◆ Cbeta2_

dimensionedScalar Cbeta2_

protected

Definition at line 91 of file ShihQuadraticKE.H.

Referenced by ShihQuadraticKE::correctNonlinearStress(), and ShihQuadraticKE::read().

◆ Cbeta3_

dimensionedScalar Cbeta3_

protected

Definition at line 92 of file ShihQuadraticKE.H.

Referenced by ShihQuadraticKE::correctNonlinearStress(), and ShihQuadraticKE::read().

◆ k_

volScalarField k_

protected

Definition at line 97 of file ShihQuadraticKE.H.

Referenced by ShihQuadraticKE::correct(), ShihQuadraticKE::correctNonlinearStress(), ShihQuadraticKE::k(), and ShihQuadraticKE::ShihQuadraticKE().

◆ epsilon_

volScalarField epsilon_

protected

Definition at line 98 of file ShihQuadraticKE.H.

Referenced by ShihQuadraticKE::correct(), ShihQuadraticKE::correctNonlinearStress(), ShihQuadraticKE::epsilon(), and ShihQuadraticKE::ShihQuadraticKE().

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

src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/ShihQuadraticKE/ShihQuadraticKE.H
src/TurbulenceModels/incompressible/turbulentTransportModels/RAS/ShihQuadraticKE/ShihQuadraticKE.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ShihQuadraticKE()

◆ ~ShihQuadraticKE()

Member Function Documentation

◆ correctNut()

◆ correctNonlinearStress()

◆ TypeName()

◆ read()

◆ DkEff()

◆ DepsilonEff()

◆ k()

◆ epsilon()

◆ correct()

Member Data Documentation

◆ Ceps1_

◆ Ceps2_

◆ sigmak_

◆ sigmaEps_

◆ Cmu1_

◆ Cmu2_

◆ Cbeta_

◆ Cbeta1_

◆ Cbeta2_

◆ Cbeta3_

◆ k_

◆ epsilon_