Reynolds-stress turbulence model base class. More...

Inheritance diagram for ReynoldsStress< BasicTurbulenceModel >:

Collaboration diagram for ReynoldsStress< BasicTurbulenceModel >:

Public Types
typedef BasicTurbulenceModel::alphaField	alphaField

typedef BasicTurbulenceModel::rhoField	rhoField

typedef BasicTurbulenceModel::transportModel	transportModel

Public Member Functions
	ReynoldsStress (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	~ReynoldsStress ()=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
	Return the turbulence kinetic energy. 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...

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

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

template<class RhoFieldType >
Foam::tmp< Foam::fvVectorMatrix >	DivDevRhoReff (const RhoFieldType &rho, volVectorField &U) const

Protected Member Functions
void	boundNormalStress (volSymmTensorField &R) const

void	correctWallShearStress (volSymmTensorField &R) const

void	checkRealizabilityConditions (const volSymmTensorField &R) const

virtual void	correctNut ()=0
	Update the eddy-viscosity. More...

template<class RhoFieldType >
tmp< fvVectorMatrix >	DivDevRhoReff (const RhoFieldType &rho, volVectorField &U) const
	Return the source term for the momentum equation. More...

Protected Attributes
dimensionedScalar	couplingFactor_

volSymmTensorField	R_

volScalarField	nut_

Detailed Description

template<class BasicTurbulenceModel>
class Foam::ReynoldsStress< BasicTurbulenceModel >

Reynolds-stress turbulence model base class.

Reference:

    Realizability conditions (tag:S):
        Schumann, U. (1977).
        Realizability of Reynolds‐stress turbulence models.
        The Physics of Fluids, 20(5), 721-725.
        DOI:10.1063/1.861942

Source files

Definition at line 62 of file ReynoldsStress.H.

Member Typedef Documentation

◆ alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 101 of file ReynoldsStress.H.

◆ rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 102 of file ReynoldsStress.H.

◆ transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 103 of file ReynoldsStress.H.

Constructor & Destructor Documentation

◆ ReynoldsStress()

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

Definition at line 170 of file ReynoldsStress.C.

◆ ~ReynoldsStress()

virtual ~ReynoldsStress ( )

virtualdefault

Destructor.

Member Function Documentation

◆ boundNormalStress()

void boundNormalStress ( volSymmTensorField & R ) const

protected

Definition at line 37 of file ReynoldsStress.C.

References R.

◆ correctWallShearStress()

void correctWallShearStress ( volSymmTensorField & R ) const

protected

Definition at line 62 of file ReynoldsStress.C.

References forAll, patches, and R.

◆ checkRealizabilityConditions()

void checkRealizabilityConditions ( const volSymmTensorField & R ) const

protected

Definition at line 109 of file ReynoldsStress.C.

References Foam::diff(), Foam::endl(), forAll, Foam::Info, and R.

Here is the call graph for this function:

◆ correctNut()

virtual void correctNut ( )

protectedpure virtual

Update the eddy-viscosity.

Implemented in DeardorffDiffStress< BasicTurbulenceModel >, LRR< BasicTurbulenceModel >, and SSG< BasicTurbulenceModel >.

◆ DivDevRhoReff() [1/2]

tmp< fvVectorMatrix > DivDevRhoReff	(	const RhoFieldType &	rho,
		volVectorField &	U
	)		const

protected

Return the source term for the momentum equation.

◆ read()

bool read

pure virtual

Re-read model coefficients if they have changed.

Implemented in DeardorffDiffStress< BasicTurbulenceModel >, EBRSM< BasicTurbulenceModel >, LRR< BasicTurbulenceModel >, and SSG< BasicTurbulenceModel >.

Definition at line 243 of file ReynoldsStress.C.

References kEpsilonLopesdaCosta< BasicTurbulenceModel >::read().

Here is the call graph for this function:

◆ nut() [1/2]

virtual tmp< volScalarField > nut ( ) const

inlinevirtual

Return the turbulence viscosity.

Definition at line 132 of file ReynoldsStress.H.

References ReynoldsStress< BasicTurbulenceModel >::nut_.

◆ nut() [2/2]

virtual tmp< scalarField > nut ( const label patchi ) const

inlinevirtual

Return the turbulence viscosity on patch.

Definition at line 138 of file ReynoldsStress.H.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), and ReynoldsStress< BasicTurbulenceModel >::nut_.

Here is the call graph for this function:

◆ k()

Foam::tmp< Foam::volScalarField > k

virtual

Return the turbulence kinetic energy.

Reimplemented in LRR< BasicTurbulenceModel >, and SSG< BasicTurbulenceModel >.

Definition at line 259 of file ReynoldsStress.C.

References tmp< T >::ref(), and Foam::tr().

Here is the call graph for this function:

◆ R()

Foam::tmp< Foam::volSymmTensorField > R

virtual

Return the Reynolds stress tensor.

Definition at line 251 of file ReynoldsStress.C.

◆ devRhoReff() [1/2]

Foam::tmp< Foam::volSymmTensorField > devRhoReff

virtual

Return the effective stress tensor.

Definition at line 269 of file ReynoldsStress.C.

◆ devRhoReff() [2/2]

Foam::tmp< Foam::volSymmTensorField > devRhoReff ( const volVectorField & U ) const

virtual

Return the effective stress tensor based on a given velocity field.

Definition at line 277 of file ReynoldsStress.C.

References Foam::dev(), Foam::twoSymm(), and U.

Here is the call graph for this function:

◆ divDevRhoReff() [1/2]

Foam::tmp< Foam::fvVectorMatrix > divDevRhoReff ( volVectorField & U ) const

virtual

Return the source term for the momentum equation.

Definition at line 352 of file ReynoldsStress.C.

References U.

◆ divDevRhoReff() [2/2]

Foam::tmp< Foam::fvVectorMatrix > divDevRhoReff	(	const volScalarField &	rho,
		volVectorField &	U
	)		const

virtual

Return the source term for the momentum equation.

Definition at line 363 of file ReynoldsStress.C.

References rho, and U.

◆ validate()

void validate

virtual

Validate the turbulence fields after construction.

Update turbulence viscosity and other derived fields as requires

Definition at line 374 of file ReynoldsStress.C.

◆ correct()

void correct

pure virtual

Solve the turbulence equations and correct the turbulence viscosity.

Implemented in DeardorffDiffStress< BasicTurbulenceModel >, EBRSM< BasicTurbulenceModel >, LRR< BasicTurbulenceModel >, and SSG< BasicTurbulenceModel >.

Definition at line 381 of file ReynoldsStress.C.

References kEpsilonLopesdaCosta< BasicTurbulenceModel >::correct().

Here is the call graph for this function:

◆ DivDevRhoReff() [2/2]

Foam::tmp< Foam::fvVectorMatrix > DivDevRhoReff	(	const RhoFieldType &	rho,
		volVectorField &	U
	)		const

Definition at line 305 of file ReynoldsStress.C.

References Foam::dev2(), nu, nut, rho, T, and U.

Here is the call graph for this function:

Member Data Documentation

◆ couplingFactor_

dimensionedScalar couplingFactor_

protected

Definition at line 73 of file ReynoldsStress.H.

◆ R_

volSymmTensorField R_

protected

Definition at line 77 of file ReynoldsStress.H.

◆ nut_

volScalarField nut_

protected

Definition at line 78 of file ReynoldsStress.H.

Referenced by ReynoldsStress< BasicTurbulenceModel >::nut().

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

src/TurbulenceModels/turbulenceModels/ReynoldsStress/ReynoldsStress.H
src/TurbulenceModels/turbulenceModels/ReynoldsStress/ReynoldsStress.C

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ alphaField

◆ rhoField

◆ transportModel

Constructor & Destructor Documentation

◆ ReynoldsStress()

◆ ~ReynoldsStress()

Member Function Documentation

◆ boundNormalStress()

◆ correctWallShearStress()

◆ checkRealizabilityConditions()

◆ correctNut()

◆ DivDevRhoReff() [1/2]

◆ read()

◆ nut() [1/2]

◆ nut() [2/2]

◆ k()

◆ R()

◆ devRhoReff() [1/2]

◆ devRhoReff() [2/2]

◆ divDevRhoReff() [1/2]

◆ divDevRhoReff() [2/2]

◆ validate()

◆ correct()

◆ DivDevRhoReff() [2/2]

Member Data Documentation

◆ couplingFactor_

◆ R_

◆ nut_