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

Inheritance diagram for ReynoldsStress< BasicMomentumTransportModel >:

Collaboration diagram for ReynoldsStress< BasicMomentumTransportModel >:

Public Types
typedef BasicMomentumTransportModel::alphaField	alphaField

typedef BasicMomentumTransportModel::rhoField	rhoField

typedef BasicMomentumTransportModel::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)
	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 >	sigma () const
	Return the Reynolds stress tensor [m^2/s^2]. 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...

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

virtual tmp< fvSymmTensorMatrix >	RSource () const
	Source term for the R equation. 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 BasicMomentumTransportModel>
class Foam::ReynoldsStress< BasicMomentumTransportModel >

Reynolds-stress turbulence model base class.

Source files

Definition at line 47 of file ReynoldsStress.H.

Member Typedef Documentation

◆ alphaField

typedef BasicMomentumTransportModel::alphaField alphaField

Definition at line 88 of file ReynoldsStress.H.

◆ rhoField

typedef BasicMomentumTransportModel::rhoField rhoField

Definition at line 89 of file ReynoldsStress.H.

◆ transportModel

typedef BasicMomentumTransportModel::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
	)

Construct from components.

Definition at line 124 of file ReynoldsStress.C.

Referenced by ReynoldsStress< LESModel< BasicMomentumTransportModel > >::RSource().

Here is the caller graph for this function:

◆ ~ReynoldsStress()

virtual ~ReynoldsStress ( )

inlinevirtual

Destructor.

Definition at line 109 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< LESModel< BasicMomentumTransportModel > >::boundNormalStress().

Here is the caller graph for this function:

◆ correctNut()

virtual void correctNut ( )

protectedpure virtual

Update the eddy-viscosity.

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

◆ RSource()

Foam::tmp< Foam::fvSymmTensorMatrix > RSource ( ) const

protectedvirtual

Source term for the R equation.

Definition at line 107 of file ReynoldsStress.C.

◆ DivDevRhoReff() [1/2]

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

protected

Return the source term for the momentum equation.

Referenced by ReynoldsStress< LESModel< BasicMomentumTransportModel > >::devTau().

Here is the caller graph for this function:

◆ read()

bool read ( )

pure virtual

Re-read model coefficients if they have changed.

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

Definition at line 194 of file ReynoldsStress.C.

Referenced by ReynoldsStress< LESModel< BasicMomentumTransportModel > >::~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 119 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 125 of file ReynoldsStress.H.

◆ k()

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

virtual

Return the turbulence kinetic energy.

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

Definition at line 210 of file ReynoldsStress.C.

Referenced by ReynoldsStress< LESModel< BasicMomentumTransportModel > >::nut().

Here is the caller graph for this function:

◆ sigma()

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

virtual

Return the Reynolds stress tensor [m^2/s^2].

Definition at line 202 of file ReynoldsStress.C.

Referenced by ReynoldsStress< LESModel< BasicMomentumTransportModel > >::nut().

Here is the caller graph for this function:

◆ devTau()

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

virtual

Return the effective stress tensor.

Definition at line 220 of file ReynoldsStress.C.

Referenced by ReynoldsStress< LESModel< BasicMomentumTransportModel > >::nut().

Here is the caller graph for this function:

◆ divDevTau() [1/2]

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

virtual

Return the source term for the momentum equation.

Definition at line 283 of file ReynoldsStress.C.

Referenced by ReynoldsStress< LESModel< BasicMomentumTransportModel > >::DivDevRhoReff(), ReynoldsStress< LESModel< BasicMomentumTransportModel > >::divDevTau(), and ReynoldsStress< LESModel< BasicMomentumTransportModel > >::nut().

Here is the caller graph for this function:

◆ divDevTau() [2/2]

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

virtual

Return the source term for the momentum equation.

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

Referenced by ReynoldsStress< LESModel< BasicMomentumTransportModel > >::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< BasicMomentumTransportModel >, SSG< BasicMomentumTransportModel >, and DeardorffDiffStress< BasicMomentumTransportModel >.

Definition at line 311 of file ReynoldsStress.C.

Referenced by ReynoldsStress< LESModel< BasicMomentumTransportModel > >::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 236 of file ReynoldsStress.C.

Member Data Documentation

◆ couplingFactor_

dimensionedScalar couplingFactor_

protected

Definition at line 58 of file ReynoldsStress.H.

◆ R_

volSymmTensorField R_

protected

Definition at line 62 of file ReynoldsStress.H.

◆ nut_

volScalarField nut_

protected

Definition at line 63 of file ReynoldsStress.H.

Referenced by ReynoldsStress< LESModel< BasicMomentumTransportModel > >::nut().

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

src/MomentumTransportModels/momentumTransportModels/ReynoldsStress/ReynoldsStress.H
src/MomentumTransportModels/momentumTransportModels/ReynoldsStress/ReynoldsStress.C

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class BasicMomentumTransportModel> class Foam::ReynoldsStress< BasicMomentumTransportModel >

Member Typedef Documentation

◆ alphaField

◆ rhoField

◆ transportModel

Constructor & Destructor Documentation

◆ ReynoldsStress()

◆ ~ReynoldsStress()

Member Function Documentation

◆ boundNormalStress()

◆ correctWallShearStress()

◆ correctNut()

◆ RSource()

◆ DivDevRhoReff() [1/2]

◆ read()

◆ nut() [1/2]

◆ nut() [2/2]

◆ k()

◆ sigma()

◆ devTau()

◆ divDevTau() [1/2]

◆ divDevTau() [2/2]

◆ validate()

◆ correct()

◆ DivDevRhoReff() [2/2]

Member Data Documentation

◆ couplingFactor_

◆ R_

◆ nut_

template<class BasicMomentumTransportModel>
class Foam::ReynoldsStress< BasicMomentumTransportModel >