SSG< BasicMomentumTransportModel > Class Template Reference

Speziale, Sarkar and Gatski Reynolds-stress turbulence model for incompressible and compressible flows. More...

Inheritance diagram for SSG< BasicMomentumTransportModel >:

Collaboration diagram for SSG< BasicMomentumTransportModel >:

Public Types
typedef BasicMomentumTransportModel::alphaField	alphaField
typedef BasicMomentumTransportModel::rhoField	rhoField
Public Types inherited from ReynoldsStress< RASModel< BasicMomentumTransportModel > >
typedef RASModel< BasicMomentumTransportModel > ::alphaField	alphaField
typedef RASModel< BasicMomentumTransportModel > ::rhoField	rhoField
Public Types inherited from RASModel< BasicMomentumTransportModel >
typedef BasicMomentumTransportModel::alphaField	alphaField
typedef BasicMomentumTransportModel::rhoField	rhoField

Public Member Functions
	TypeName ("SSG")
	Runtime type information. More...
	SSG (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity, const word &type=typeName)
	Construct from components. More...
	SSG (const SSG &)=delete
	Disallow default bitwise copy construction. More...
virtual	~SSG ()
	Destructor. More...
virtual bool	read ()
	Read model coefficients if they have changed. 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 tmp< volScalarField >	omega () const
	Return the turbulence specific dissipation rate. More...
tmp< volSymmTensorField >	DREff () const
	Return the effective diffusivity for R. More...
tmp< volSymmTensorField >	DepsilonEff () const
	Return the effective diffusivity for epsilon. More...
virtual void	correct ()
	Solve the turbulence equations and correct eddy-Viscosity and. More...
void	operator= (const SSG &)=delete
	Disallow default bitwise assignment. More...
Public Member Functions inherited from ReynoldsStress< RASModel< BasicMomentumTransportModel > >
Foam::tmp< Foam::fvVectorMatrix >	DivDevRhoReff (const RhoFieldType &rho, volVectorField &U) const
	ReynoldsStress (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
	Construct from components. More...
virtual	~ReynoldsStress ()
	Destructor. 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< 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...
Public Member Functions inherited from RASModel< BasicMomentumTransportModel >
	TypeName ("RAS")
	Runtime type information. More...
	declareRunTimeSelectionTable (autoPtr, RASModel, dictionary,(const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity),(alpha, rho, U, alphaRhoPhi, phi, viscosity))
	RASModel (const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
	Construct from components. More...
	RASModel (const RASModel &)=delete
	Disallow default bitwise copy construction. More...
virtual	~RASModel ()
	Destructor. More...
const dimensionedScalar &	kMin () const
	Return the lower allowable limit for k (default: small) More...
const dimensionedScalar &	epsilonMin () const
	Return the lower allowable limit for epsilon (default: small) More...
const dimensionedScalar &	omegaMin () const
	Return the lower allowable limit for omega (default: small) More...
dimensionedScalar &	kMin ()
	Allow kMin to be changed. More...
dimensionedScalar &	epsilonMin ()
	Allow epsilonMin to be changed. More...
dimensionedScalar &	omegaMin ()
	Allow omegaMin to be changed. More...
virtual const dictionary &	coeffDict () const
	Const access to the coefficients dictionary. More...
virtual tmp< volScalarField >	nu () const
	Return the laminar viscosity. More...
virtual tmp< scalarField >	nu (const label patchi) const
	Return the laminar viscosity on patchi. More...
virtual tmp< volScalarField >	nuEff () const
	Return the effective viscosity. More...
virtual tmp< scalarField >	nuEff (const label patchi) const
	Return the effective viscosity on patch. More...
void	operator= (const RASModel &)=delete
	Disallow default bitwise assignment. More...

Protected Member Functions
virtual void	correctNut ()
	Update the eddy-viscosity. More...
virtual tmp< fvScalarMatrix >	epsilonSource () const
	Source term for the epsilon equation. More...
Protected Member Functions inherited from ReynoldsStress< RASModel< BasicMomentumTransportModel > >
void	boundNormalStress (volSymmTensorField &R) const
void	correctWallShearStress (volSymmTensorField &R) const
virtual tmp< fvSymmTensorMatrix >	RSource () const
	Source term for the R equation. More...
tmp< fvVectorMatrix >	DivDevRhoReff (const RhoFieldType &rho, volVectorField &U) const
	Return the source term for the momentum equation. More...
Protected Member Functions inherited from RASModel< BasicMomentumTransportModel >
virtual void	printCoeffs (const word &type)
	Print model coefficients. More...

Protected Attributes
dimensionedScalar	Cmu_
dimensionedScalar	C1_
dimensionedScalar	C1s_
dimensionedScalar	C2_
dimensionedScalar	C3_
dimensionedScalar	C3s_
dimensionedScalar	C4_
dimensionedScalar	C5_
dimensionedScalar	Ceps1_
dimensionedScalar	Ceps2_
dimensionedScalar	Cs_
dimensionedScalar	Ceps_
volScalarField	k_
volScalarField	epsilon_
Protected Attributes inherited from ReynoldsStress< RASModel< BasicMomentumTransportModel > >
dimensionedScalar	couplingFactor_
volSymmTensorField	R_
volScalarField	nut_
Protected Attributes inherited from RASModel< BasicMomentumTransportModel >
dictionary	RASDict_
	RAS coefficients dictionary. More...
Switch	turbulence_
	Turbulence on/off flag. More...
Switch	printCoeffs_
	Flag to print the model coeffs at run-time. More...
dictionary	coeffDict_
	Model coefficients dictionary. More...
dimensionedScalar	kMin_
	Lower limit of k. More...
dimensionedScalar	epsilonMin_
	Lower limit of epsilon. More...
dimensionedScalar	omegaMin_
	Lower limit for omega. More...
autoPtr< laminarModels::generalisedNewtonianViscosityModel >	viscosityModel_
	Run-time selectable generalised Newtonian viscosity model. More...

Additional Inherited Members
Static Public Member Functions inherited from RASModel< BasicMomentumTransportModel >
static autoPtr< RASModel >	New (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
	Return a reference to the selected RAS model. More...

Detailed Description

template<class BasicMomentumTransportModel>
class Foam::RASModels::SSG< BasicMomentumTransportModel >

Speziale, Sarkar and Gatski Reynolds-stress turbulence model for incompressible and compressible flows.

Reference:

    Speziale, C. G., Sarkar, S., & Gatski, T. B. (1991).
    Modelling the pressure–strain correlation of turbulence:
    an invariant dynamical systems approach.
    Journal of Fluid Mechanics, 227, 245-272.

Including the generalised gradient diffusion model of Daly and Harlow:

    Daly, B. J., & Harlow, F. H. (1970).
    Transport equations in turbulence.
    Physics of Fluids (1958-1988), 13(11), 2634-2649.

The default model coefficients are:

    SSGCoeffs
    {
        Cmu             0.09;

        C1              3.4;
        C1s             1.8;
        C2              4.2;
        C3              0.8;
        C3s             1.3;
        C4              1.25;
        C5              0.4;

        Ceps1           1.44;
        Ceps2           1.92;
        Cs              0.25;
        Ceps            0.15;

        couplingFactor  0.0;
    }

Source files

• SSG.H
• SSG.C

Definition at line 92 of file SSG.H.

Member Typedef Documentation

alphaField

typedef BasicMomentumTransportModel::alphaField alphaField

Definition at line 134 of file SSG.H.

rhoField

typedef BasicMomentumTransportModel::rhoField rhoField

Definition at line 135 of file SSG.H.

Constructor & Destructor Documentation

SSG() [1/2]

SSG	(	const alphaField &	alpha,
		const rhoField &	rho,
		const volVectorField &	U,
		const surfaceScalarField &	alphaRhoPhi,
		const surfaceScalarField &	phi,
		const viscosity &	viscosity,
		const word &	type = typeName
	)

Construct from components.

Definition at line 67 of file SSG.C.

References Foam::bound(), and Foam::tr().

Referenced by SSG< BasicMomentumTransportModel >::epsilonSource().

Here is the call graph for this function:

Here is the caller graph for this function:

SSG() [2/2]

SSG ( const SSG< BasicMomentumTransportModel > &  )

delete

Disallow default bitwise copy construction.

~SSG()

virtual ~SSG ( )

inlinevirtual

Destructor.

Definition at line 161 of file SSG.H.

References SSG< BasicMomentumTransportModel >::read().

Here is the call graph for this function:

Member Function Documentation

correctNut()

void correctNut ( )

protectedvirtual

Update the eddy-viscosity.

Implements ReynoldsStress< RASModel< BasicMomentumTransportModel > >.

Definition at line 41 of file SSG.C.

References dictionary::New(), and Foam::sqr().

Here is the call graph for this function:

epsilonSource()

tmp< fvScalarMatrix > epsilonSource ( ) const

protectedvirtual

Source term for the epsilon equation.

Definition at line 50 of file SSG.C.

References Foam::dimTime, Foam::dimVolume, and SSG< BasicMomentumTransportModel >::SSG().

Here is the call graph for this function:

TypeName()

TypeName

(

"SSG< BasicMomentumTransportModel >"

)

Runtime type information.

read()

bool read ( )

virtual

Read model coefficients if they have changed.

Implements ReynoldsStress< RASModel< BasicMomentumTransportModel > >.

Definition at line 237 of file SSG.C.

References Foam::read().

Referenced by SSG< BasicMomentumTransportModel >::~SSG().

Here is the call graph for this function:

Here is the caller graph for this function:

k()

virtual tmp<volScalarField> k ( ) const

inlinevirtual

Return the turbulence kinetic energy.

Reimplemented from ReynoldsStress< RASModel< BasicMomentumTransportModel > >.

Definition at line 171 of file SSG.H.

References SSG< BasicMomentumTransportModel >::k_.

epsilon()

virtual tmp<volScalarField> epsilon ( ) const

inlinevirtual

Return the turbulence kinetic energy dissipation rate.

Definition at line 177 of file SSG.H.

References SSG< BasicMomentumTransportModel >::epsilon_.

omega()

virtual tmp<volScalarField> omega ( ) const

inlinevirtual

Return the turbulence specific dissipation rate.

Definition at line 183 of file SSG.H.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), SSG< BasicMomentumTransportModel >::correct(), SSG< BasicMomentumTransportModel >::DepsilonEff(), SSG< BasicMomentumTransportModel >::DREff(), GeometricField< scalar, fvPatchField, volMesh >::New(), SSG< BasicMomentumTransportModel >::operator=(), and GeometricBoundaryField< Type, PatchField, GeoMesh >::types().

Here is the call graph for this function:

DREff()

tmp< volSymmTensorField > DREff

(

)

const

Return the effective diffusivity for R.

Definition at line 265 of file SSG.C.

References Foam::I, and GeometricField< symmTensor, fvPatchField, volMesh >::New().

Referenced by SSG< BasicMomentumTransportModel >::omega().

Here is the call graph for this function:

Here is the caller graph for this function:

DepsilonEff()

tmp< volSymmTensorField > DepsilonEff

(

)

const

Return the effective diffusivity for epsilon.

Definition at line 276 of file SSG.C.

References Foam::I, and GeometricField< symmTensor, fvPatchField, volMesh >::New().

Referenced by SSG< BasicMomentumTransportModel >::omega().

Here is the call graph for this function:

Here is the caller graph for this function:

correct()

void correct ( )

virtual

Solve the turbulence equations and correct eddy-Viscosity and.

related properties

Implements ReynoldsStress< RASModel< BasicMomentumTransportModel > >.

Definition at line 287 of file SSG.C.

References Foam::constant::physicoChemical::b, Foam::bound(), fvConstraints::constrain(), correct, Foam::fvm::ddt(), Foam::dev(), Foam::fvm::div(), fvPatch::faceCells(), forAll, fvConstraints, fvModels, Foam::constant::universal::G, Foam::fvc::grad(), Foam::I, Foam::innerSqr(), Foam::fvm::laplacian(), Foam::mag(), Foam::min(), dictionary::New(), patches, patchi, R, tmp< T >::ref(), Foam::fvm::S(), Foam::skew(), Foam::solve(), Foam::fvm::Sp(), Foam::symm(), Foam::tr(), and Foam::twoSymm().

Referenced by SSG< BasicMomentumTransportModel >::omega().

Here is the call graph for this function:

Here is the caller graph for this function:

operator=()

void operator= ( const SSG< BasicMomentumTransportModel > &  )

delete

Disallow default bitwise assignment.

Referenced by SSG< BasicMomentumTransportModel >::omega().

Here is the caller graph for this function:

Member Data Documentation

Cmu_

dimensionedScalar Cmu_

protected

Definition at line 102 of file SSG.H.

C1_

dimensionedScalar C1_

protected

Definition at line 104 of file SSG.H.

C1s_

dimensionedScalar C1s_

protected

Definition at line 105 of file SSG.H.

C2_

dimensionedScalar C2_

protected

Definition at line 106 of file SSG.H.

C3_

dimensionedScalar C3_

protected

Definition at line 107 of file SSG.H.

C3s_

dimensionedScalar C3s_

protected

Definition at line 108 of file SSG.H.

C4_

dimensionedScalar C4_

protected

Definition at line 109 of file SSG.H.

C5_

dimensionedScalar C5_

protected

Definition at line 110 of file SSG.H.

Ceps1_

dimensionedScalar Ceps1_

protected

Definition at line 112 of file SSG.H.

Ceps2_

dimensionedScalar Ceps2_

protected

Definition at line 113 of file SSG.H.

Cs_

dimensionedScalar Cs_

protected

Definition at line 114 of file SSG.H.

Ceps_

dimensionedScalar Ceps_

protected

Definition at line 115 of file SSG.H.

k_

volScalarField k_

protected

Definition at line 119 of file SSG.H.

Referenced by SSG< BasicMomentumTransportModel >::k().

epsilon_

volScalarField epsilon_

protected

Definition at line 120 of file SSG.H.

Referenced by SSG< BasicMomentumTransportModel >::epsilon().

---

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

• src/MomentumTransportModels/momentumTransportModels/RAS/SSG/SSG.H
• src/MomentumTransportModels/momentumTransportModels/RAS/SSG/SSG.C