#include <SpalartAllmarasBase.H>

Inheritance diagram for SpalartAllmarasBase< BasicEddyViscosityModel >:

[legend]

Collaboration diagram for SpalartAllmarasBase< BasicEddyViscosityModel >:

[legend]

Public Types
typedef BasicEddyViscosityModel::alphaField	alphaField
typedef BasicEddyViscosityModel::rhoField	rhoField
typedef BasicEddyViscosityModel::transportModel	transportModel

Public Member Functions
	SpalartAllmarasBase (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.
virtual	~SpalartAllmarasBase ()=default
	Destructor.
virtual bool	read ()
	Re-read model coefficients if they have changed.
tmp< volScalarField >	DnuTildaEff () const
	Return the effective diffusivity for nuTilda.
virtual tmp< volScalarField >	k () const
	Return the (estimated) turbulent kinetic energy.
virtual tmp< volScalarField >	epsilon () const
	Return the (estimated) turbulent kinetic energy dissipation rate.
virtual tmp< volScalarField >	omega () const
	Return the (estimated) specific dissipation rate.
tmp< volScalarField >	nuTilda () const
	Return the modified kinematic viscosity.
virtual void	correct ()
	Correct nuTilda and related properties.

Protected Member Functions
tmp< volScalarField >	chi () const
tmp< volScalarField >	fv1 (const volScalarField &chi) const
tmp< volScalarField >	fv2 (const volScalarField &chi, const volScalarField &fv1) const
tmp< volScalarField >	ft2 (const volScalarField &chi) const
tmp< volScalarField >	Omega (const volTensorField &gradU) const
tmp< volScalarField >	r (const volScalarField &nur, const volScalarField &Stilda, const volScalarField &dTilda) const
tmp< volScalarField::Internal >	fw (const volScalarField &Stilda, const volScalarField &dTilda) const
virtual tmp< volScalarField >	Stilda (const volScalarField &chi, const volScalarField &fv1, const volTensorField &gradU, const volScalarField &dTilda) const
virtual tmp< volScalarField >	dTilda (const volScalarField &chi, const volScalarField &fv1, const volTensorField &gradU) const =0
	Length scale.
void	correctNut (const volScalarField &fv1)
virtual void	correctNut ()

Protected Attributes
dimensionedScalar	sigmaNut_
dimensionedScalar	kappa_
dimensionedScalar	Cb1_
dimensionedScalar	Cb2_
dimensionedScalar	Cw1_
dimensionedScalar	Cw2_
dimensionedScalar	Cw3_
dimensionedScalar	Cv1_
dimensionedScalar	Cs_
dimensionedScalar	ck_
Switch	ft2_
dimensionedScalar	Ct3_
dimensionedScalar	Ct4_
volScalarField	nuTilda_
	Modified kinematic viscosity [m^2/s].
const volScalarField &	y_
	Wall distance.

Detailed Description

template<class BasicEddyViscosityModel>
class Foam::SpalartAllmarasBase< BasicEddyViscosityModel >

Definition at line 76 of file SpalartAllmarasBase.H.

Member Typedef Documentation

◆ alphaField

template<class BasicEddyViscosityModel>

typedef BasicEddyViscosityModel::alphaField alphaField

Definition at line 185 of file SpalartAllmarasBase.H.

◆ rhoField

template<class BasicEddyViscosityModel>

typedef BasicEddyViscosityModel::rhoField rhoField

Definition at line 186 of file SpalartAllmarasBase.H.

◆ transportModel

template<class BasicEddyViscosityModel>

typedef BasicEddyViscosityModel::transportModel transportModel

Definition at line 187 of file SpalartAllmarasBase.H.

Constructor & Destructor Documentation

◆ SpalartAllmarasBase()

template<class BasicEddyViscosityModel>

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

Definition at line 175 of file SpalartAllmarasBase.C.

References alpha.

◆ ~SpalartAllmarasBase()

template<class BasicEddyViscosityModel>

virtual ~SpalartAllmarasBase ( )

virtualdefault

Destructor.

Member Function Documentation

◆ chi()

template<class BasicEddyViscosityModel>

tmp< volScalarField > chi ( ) const

protected

Definition at line 35 of file SpalartAllmarasBase.C.

References nu, and nuTilda_.

Referenced by correct(), SpalartAllmaras< Foam::EddyDiffusivity< Foam::fluidThermoCompressibleTurbulenceModel > >::dTilda(), dTilda(), epsilon(), ft2(), fv1(), fv2(), and k().

Here is the caller graph for this function:

◆ fv1()

template<class BasicEddyViscosityModel>

tmp< volScalarField > fv1 ( const volScalarField & chi ) const

protected

Definition at line 42 of file SpalartAllmarasBase.C.

References chi(), Cv1_, and Foam::pow3().

Referenced by correct(), correctNut(), SpalartAllmaras< Foam::EddyDiffusivity< Foam::fluidThermoCompressibleTurbulenceModel > >::dTilda(), dTilda(), epsilon(), fv2(), and k().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fv2()

template<class BasicEddyViscosityModel>

tmp< volScalarField > fv2	(	const volScalarField &	chi,
		const volScalarField &	fv1 ) const

protected

Definition at line 53 of file SpalartAllmarasBase.C.

References chi(), and fv1().

Here is the call graph for this function:

◆ ft2()

template<class BasicEddyViscosityModel>

tmp< volScalarField > ft2 ( const volScalarField & chi ) const

protected

Definition at line 64 of file SpalartAllmarasBase.C.

References chi(), Ct3_, Ct4_, Foam::dimless, Foam::exp(), ft2_, tmp< T >::New(), IOobjectOption::NO_READ, IOobjectOption::NO_WRITE, Foam::sqr(), and Foam::Zero.

Referenced by correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Omega()

template<class BasicEddyViscosityModel>

tmp< volScalarField > Omega ( const volTensorField & gradU ) const

protected

Definition at line 91 of file SpalartAllmarasBase.C.

References Foam::mag(), Foam::skew(), and Foam::sqrt().

Here is the call graph for this function:

◆ r()

template<class BasicEddyViscosityModel>

tmp< volScalarField > r	(	const volScalarField &	nur,
		const volScalarField &	Stilda,
		const volScalarField &	dTilda ) const

protected

Definition at line 101 of file SpalartAllmarasBase.C.

References dTilda(), kappa_, Foam::max(), Foam::min(), Foam::sqr(), Stilda(), and Foam::tr().

Referenced by fw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fw()

template<class BasicEddyViscosityModel>

tmp< volScalarField::Internal > fw	(	const volScalarField &	Stilda,
		const volScalarField &	dTilda ) const

protected

Definition at line 120 of file SpalartAllmarasBase.C.

References Cw2_, Cw3_, dTilda(), g, nuTilda_, Foam::pow(), Foam::pow6(), r(), and Stilda().

Referenced by correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Stilda()

template<class BasicEddyViscosityModel>

tmp< volScalarField > Stilda	(	const volScalarField &	chi,
		const volScalarField &	fv1,
		const volTensorField &	gradU,
		const volScalarField &	dTilda ) const

protectedvirtual

Definition at line 134 of file SpalartAllmarasBase.C.

Referenced by correct(), fw(), and r().

Here is the caller graph for this function:

◆ dTilda()

template<class BasicEddyViscosityModel>

virtual tmp< volScalarField > dTilda	(	const volScalarField &	chi,
		const volScalarField &	fv1,
		const volTensorField &	gradU ) const

protectedpure virtual

Length scale.

Implemented in SpalartAllmaras< BasicTurbulenceModel >, SpalartAllmaras< EddyDiffusivity< fluidThermoCompressibleTurbulenceModel > >, and SpalartAllmaras< Foam::EddyDiffusivity< Foam::fluidThermoCompressibleTurbulenceModel > >.

References chi(), and fv1().

Referenced by correct(), fw(), and r().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correctNut() [1/2]

template<class BasicEddyViscosityModel>

void correctNut ( const volScalarField & fv1 )

protected

Definition at line 154 of file SpalartAllmarasBase.C.

Referenced by correct(), and correctNut().

Here is the caller graph for this function:

◆ correctNut() [2/2]

template<class BasicEddyViscosityModel>

void correctNut ( )

protectedvirtual

Reimplemented in SpalartAllmaras< EddyDiffusivity< fluidThermoCompressibleTurbulenceModel > >, and SpalartAllmaras< Foam::EddyDiffusivity< Foam::fluidThermoCompressibleTurbulenceModel > >.

Definition at line 166 of file SpalartAllmarasBase.C.

References correctNut(), and fv1().

Referenced by SpalartAllmaras< BasicTurbulenceModel >::correctNut().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

template<class BasicEddyViscosityModel>

bool read ( )

virtual

Re-read model coefficients if they have changed.

Definition at line 338 of file SpalartAllmarasBase.C.

References Cb1_, Cb2_, ck_, Cs_, Ct3_, Ct4_, Cv1_, Cw1_, Cw2_, Cw3_, ft2_, Foam::Info, kappa_, Foam::nl, sigmaNut_, and Foam::sqr().

Here is the call graph for this function:

◆ DnuTildaEff()

template<class BasicEddyViscosityModel>

tmp< volScalarField > DnuTildaEff ( ) const

Return the effective diffusivity for nuTilda.

Definition at line 376 of file SpalartAllmarasBase.C.

References IOobject::groupName(), tmp< T >::New(), nuTilda_, and sigmaNut_.

Referenced by correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ k()

template<class BasicEddyViscosityModel>

tmp< volScalarField > k ( ) const

virtual

Return the (estimated) turbulent kinetic energy.

Definition at line 387 of file SpalartAllmarasBase.C.

References Foam::cbrt(), chi(), fv1(), Foam::fvc::grad(), IOobject::groupName(), Foam::mag(), tmp< T >::New(), nuTilda_, Foam::sqrt(), and Foam::symm().

Here is the call graph for this function:

◆ epsilon()

template<class BasicEddyViscosityModel>

tmp< volScalarField > epsilon ( ) const

virtual

Return the (estimated) turbulent kinetic energy dissipation rate.

Definition at line 402 of file SpalartAllmarasBase.C.

References chi(), fv1(), IOobject::groupName(), k, tmp< T >::New(), nuTilda_, Foam::sqr(), and Foam::sqrt().

Here is the call graph for this function:

◆ omega()

template<class BasicEddyViscosityModel>

tmp< volScalarField > omega ( ) const

virtual

Return the (estimated) specific dissipation rate.

Definition at line 418 of file SpalartAllmarasBase.C.

References Foam::dimLength, Foam::dimTime, IOobject::groupName(), tmp< T >::New(), and Foam::sqr().

Here is the call graph for this function:

◆ nuTilda()

template<class BasicEddyViscosityModel>

tmp< volScalarField > nuTilda ( ) const

inline

Return the modified kinematic viscosity.

Definition at line 244 of file SpalartAllmarasBase.H.

References nuTilda_.

◆ correct()

template<class BasicEddyViscosityModel>

void correct ( )

virtual

Correct nuTilda and related properties.

Definition at line 433 of file SpalartAllmarasBase.C.

References alpha, Foam::bound(), Cb1_, Cb2_, chi(), tmp< T >::clear(), correctNut(), Cw1_, Foam::fvm::ddt(), Foam::fvm::div(), DnuTildaEff(), dTilda(), ft2(), fv1(), fvOptions, fw(), Foam::fvc::grad(), kappa_, Foam::fvm::laplacian(), Foam::magSqr(), options::New(), nuTilda_, tmp< T >::ref(), rho, sigmaNut_, solve(), Foam::fvm::Sp(), Foam::sqr(), Stilda(), U, and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ sigmaNut_

template<class BasicEddyViscosityModel>

dimensionedScalar sigmaNut_

protected

Definition at line 99 of file SpalartAllmarasBase.H.

Referenced by correct(), DnuTildaEff(), and read().

◆ kappa_

template<class BasicEddyViscosityModel>

dimensionedScalar kappa_

protected

Definition at line 100 of file SpalartAllmarasBase.H.

Referenced by correct(), r(), and read().

◆ Cb1_

template<class BasicEddyViscosityModel>

dimensionedScalar Cb1_

protected

Definition at line 102 of file SpalartAllmarasBase.H.

Referenced by correct(), and read().

◆ Cb2_

template<class BasicEddyViscosityModel>

dimensionedScalar Cb2_

protected

Definition at line 103 of file SpalartAllmarasBase.H.

Referenced by correct(), and read().

◆ Cw1_

template<class BasicEddyViscosityModel>

dimensionedScalar Cw1_

protected

Definition at line 104 of file SpalartAllmarasBase.H.

Referenced by correct(), and read().

◆ Cw2_

template<class BasicEddyViscosityModel>

dimensionedScalar Cw2_

protected

Definition at line 105 of file SpalartAllmarasBase.H.

Referenced by fw(), and read().

◆ Cw3_

template<class BasicEddyViscosityModel>

dimensionedScalar Cw3_

protected

Definition at line 106 of file SpalartAllmarasBase.H.

Referenced by fw(), and read().

◆ Cv1_

template<class BasicEddyViscosityModel>

dimensionedScalar Cv1_

protected

Definition at line 107 of file SpalartAllmarasBase.H.

Referenced by fv1(), and read().

◆ Cs_

template<class BasicEddyViscosityModel>

dimensionedScalar Cs_

protected

Definition at line 108 of file SpalartAllmarasBase.H.

Referenced by read().

◆ ck_

template<class BasicEddyViscosityModel>

dimensionedScalar ck_

protected

Definition at line 109 of file SpalartAllmarasBase.H.

Referenced by read().

◆ ft2_

template<class BasicEddyViscosityModel>

Switch ft2_

protected

Definition at line 111 of file SpalartAllmarasBase.H.

Referenced by ft2(), and read().

◆ Ct3_

template<class BasicEddyViscosityModel>

dimensionedScalar Ct3_

protected

Definition at line 112 of file SpalartAllmarasBase.H.

Referenced by ft2(), and read().

◆ Ct4_

template<class BasicEddyViscosityModel>

dimensionedScalar Ct4_

protected

Definition at line 113 of file SpalartAllmarasBase.H.

Referenced by ft2(), and read().

◆ nuTilda_

template<class BasicEddyViscosityModel>

volScalarField nuTilda_

protected

Modified kinematic viscosity [m^2/s].

Definition at line 121 of file SpalartAllmarasBase.H.

Referenced by chi(), correct(), DnuTildaEff(), epsilon(), fw(), k(), and nuTilda().

◆ y_

template<class BasicEddyViscosityModel>

const volScalarField& y_

protected

Wall distance.

Note: different to wall distance in parent RASModel which is for near-wall cells only

Definition at line 129 of file SpalartAllmarasBase.H.

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

src/TurbulenceModels/turbulenceModels/Base/SpalartAllmaras/SpalartAllmarasBase.H
src/TurbulenceModels/turbulenceModels/Base/SpalartAllmaras/SpalartAllmarasBase.C

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ alphaField

◆ rhoField

◆ transportModel

Constructor & Destructor Documentation

◆ SpalartAllmarasBase()

◆ ~SpalartAllmarasBase()

Member Function Documentation

◆ chi()

◆ fv1()

◆ fv2()

◆ ft2()

◆ Omega()

◆ r()

◆ fw()

◆ Stilda()

◆ dTilda()

◆ correctNut() [1/2]

◆ correctNut() [2/2]

◆ read()

◆ DnuTildaEff()

◆ k()

◆ epsilon()

◆ omega()

◆ nuTilda()

◆ correct()

Member Data Documentation

◆ sigmaNut_

◆ kappa_

◆ Cb1_

◆ Cb2_

◆ Cw1_

◆ Cw2_

◆ Cw3_

◆ Cv1_

◆ Cs_

◆ ck_

◆ ft2_

◆ Ct3_

◆ Ct4_

◆ nuTilda_

◆ y_