ReynoldsStress< BasicTurbulenceModel > Class Template Reference | OpenFOAM Source Code Guide

The OpenFOAM Foundation

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

Inheritance diagram for ReynoldsStress< BasicTurbulenceModel >:

Inheritance graph

[legend]

Collaboration diagram for ReynoldsStress< BasicTurbulenceModel >:

Collaboration graph

[legend]

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 ()
	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< 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

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.

Source files

Definition at line 50 of file ReynoldsStress.H.

Member Typedef Documentation

◆ alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 88 of file ReynoldsStress.H.

◆ rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 89 of file ReynoldsStress.H.

◆ transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 90 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 109 of file ReynoldsStress.C.

Referenced by ReynoldsStress< RASModel< BasicTurbulenceModel > >::correctWallShearStress().

Here is the caller graph for this function:

◆ ~ReynoldsStress()

virtual ~ReynoldsStress ( )

inlinevirtual

Destructor.

Definition at line 110 of file ReynoldsStress.H.

Member Function Documentation

◆ boundNormalStress()

void boundNormalStress ( volSymmTensorField & R ) const

protected

Definition at line 35 of file ReynoldsStress.C.

◆ correctWallShearStress()

void correctWallShearStress ( volSymmTensorField & R ) const

protected

Definition at line 60 of file ReynoldsStress.C.

Referenced by ReynoldsStress< RASModel< BasicTurbulenceModel > >::boundNormalStress().

Here is the caller graph for this function:

◆ correctNut()

virtual void correctNut ( )

protectedpure virtual

Update the eddy-viscosity.

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

◆ DivDevRhoReff() [1/2]

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

protected

Return the source term for the momentum equation.

Referenced by ReynoldsStress< RASModel< BasicTurbulenceModel > >::devRhoReff().

Here is the caller graph for this function:

◆ read()

bool read ( )

pure virtual

Re-read model coefficients if they have changed.

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

Definition at line 181 of file ReynoldsStress.C.

Referenced by ReynoldsStress< RASModel< BasicTurbulenceModel > >::~ReynoldsStress().

Here is the caller graph for this function:

◆ nut() [1/2]

virtual tmp<volScalarField> nut ( ) const

inlinevirtual

Return the turbulence viscosity.

Definition at line 120 of file ReynoldsStress.H.

◆ nut() [2/2]

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

inlinevirtual

Return the turbulence viscosity on patch.

Definition at line 126 of file ReynoldsStress.H.

◆ k()

Foam::tmp< Foam::volScalarField > k ( ) const

virtual

Return the turbulence kinetic energy.

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

Definition at line 197 of file ReynoldsStress.C.

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

Here is the caller graph for this function:

◆ R()

Foam::tmp< Foam::volSymmTensorField > R ( ) const

virtual

Return the Reynolds stress tensor.

Definition at line 189 of file ReynoldsStress.C.

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

Here is the caller graph for this function:

◆ devRhoReff()

Foam::tmp< Foam::volSymmTensorField > devRhoReff ( ) const

virtual

Return the effective stress tensor.

Definition at line 207 of file ReynoldsStress.C.

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

Here is the caller 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 280 of file ReynoldsStress.C.

Referenced by ReynoldsStress< RASModel< BasicTurbulenceModel > >::divDevRhoReff(), ReynoldsStress< RASModel< BasicTurbulenceModel > >::DivDevRhoReff(), and ReynoldsStress< RASModel< BasicTurbulenceModel > >::nut().

Here is the caller graph for this function:

◆ 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 291 of file ReynoldsStress.C.

◆ validate()

void validate ( )

virtual

Validate the turbulence fields after construction.

Update turbulence viscosity and other derived fields as requires

Definition at line 301 of file ReynoldsStress.C.

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

Here is the caller graph for this function:

◆ correct()

void correct ( )

pure virtual

Solve the turbulence equations and correct the turbulence viscosity.

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

Definition at line 308 of file ReynoldsStress.C.

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

Here is the caller graph for this function:

◆ DivDevRhoReff() [2/2]

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

Definition at line 233 of file ReynoldsStress.C.

Member Data Documentation

◆ couplingFactor_

dimensionedScalar couplingFactor_

protected

Definition at line 61 of file ReynoldsStress.H.

◆ R_

volSymmTensorField R_

protected

Definition at line 65 of file ReynoldsStress.H.

◆ nut_

volScalarField nut_

protected

Definition at line 66 of file ReynoldsStress.H.

Referenced by ReynoldsStress< RASModel< 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