The sigma SGS model. More...

Inheritance diagram for sigma< BasicTurbulenceModel >:

Collaboration diagram for sigma< BasicTurbulenceModel >:

Public Types
typedef BasicTurbulenceModel::alphaField	alphaField

typedef BasicTurbulenceModel::rhoField	rhoField

typedef BasicTurbulenceModel::transportModel	transportModel

Public Types inherited from LESeddyViscosity< BasicTurbulenceModel >
typedef BasicTurbulenceModel::alphaField	alphaField

typedef BasicTurbulenceModel::rhoField	rhoField

typedef BasicTurbulenceModel::transportModel	transportModel

Public Types inherited from eddyViscosity< LESModel< BasicTurbulenceModel > >
typedef LESModel< BasicTurbulenceModel > ::alphaField	alphaField

typedef LESModel< BasicTurbulenceModel > ::rhoField	rhoField

typedef LESModel< BasicTurbulenceModel > ::transportModel	transportModel

Public Types inherited from linearViscousStress< LESModel< BasicTurbulenceModel > >
typedef LESModel< BasicTurbulenceModel > ::alphaField	alphaField

typedef LESModel< BasicTurbulenceModel > ::rhoField	rhoField

typedef LESModel< BasicTurbulenceModel > ::transportModel	transportModel

Public Types inherited from LESModel< BasicTurbulenceModel >
typedef BasicTurbulenceModel::alphaField	alphaField

typedef BasicTurbulenceModel::rhoField	rhoField

typedef BasicTurbulenceModel::transportModel	transportModel

Public Member Functions
	TypeName ("sigma")
	Runtime type information. More...

	sigma (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName=turbulenceModel::propertiesName, const word &type=typeName)
	Construct from components. More...

virtual	~sigma ()
	Destructor. More...

virtual bool	read ()
	Read model coefficients if they have changed. More...

virtual tmp< volScalarField >	k () const
	Return SGS kinetic energy. More...

virtual tmp< volScalarField >	epsilon () const
	Return SGS disipation rate. More...

virtual void	correct ()
	Correct Eddy-Viscosity and related properties. More...

Public Member Functions inherited from LESeddyViscosity< BasicTurbulenceModel >
	LESeddyViscosity (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. More...

virtual	~LESeddyViscosity ()=default
	Destructor. More...

Public Member Functions inherited from eddyViscosity< LESModel< BasicTurbulenceModel > >
	eddyViscosity (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	~eddyViscosity ()=default
	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 >	R () const
	Return the Reynolds stress tensor. More...

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

Public Member Functions inherited from linearViscousStress< LESModel< BasicTurbulenceModel > >
	linearViscousStress (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	~linearViscousStress ()=default
	Destructor. 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...

Public Member Functions inherited from LESModel< BasicTurbulenceModel >
	TypeName ("LES")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, LESModel, dictionary,(const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName),(alpha, rho, U, alphaRhoPhi, phi, transport, propertiesName))

	LESModel (const word &type, 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	~LESModel ()=default
	Destructor. More...

virtual const dictionary &	coeffDict () const
	Const access to the coefficients dictionary. More...

const dimensionedScalar &	Ce () const noexcept

const dimensionedScalar &	kMin () const
	Return the lower allowable limit for k (default: SMALL) More...

dimensionedScalar &	kMin ()
	Allow kMin to be changed. More...

const volScalarField &	delta () const
	Access function to filter width. 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...

virtual tmp< volScalarField >	omega () const
	Return the specific dissipation rate. More...

Protected Member Functions
virtual void	correctNut ()
	Update the SGS eddy-viscosity. More...

Protected Member Functions inherited from LESModel< BasicTurbulenceModel >
virtual void	printCoeffs (const word &type)
	Print model coefficients. More...

	LESModel (const LESModel &)=delete
	No copy construct. More...

void	operator= (const LESModel &)=delete
	No copy assignment. More...

Protected Attributes
dimensionedScalar	Ck_

dimensionedScalar	Cw_

dimensionedScalar	Csigma_

Protected Attributes inherited from eddyViscosity< LESModel< BasicTurbulenceModel > >
volScalarField	nut_

Protected Attributes inherited from LESModel< BasicTurbulenceModel >
dictionary	LESDict_
	LES 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	Ce_
	Empirical model constant. More...

dimensionedScalar	kMin_
	Lower limit of k. More...

dimensionedScalar	epsilonMin_
	Lower limit of epsilon. More...

dimensionedScalar	omegaMin_
	Lower limit for omega. More...

autoPtr< Foam::LESdelta >	delta_
	Run-time selectable delta model. More...

Additional Inherited Members
Static Public Member Functions inherited from LESModel< BasicTurbulenceModel >
static autoPtr< LESModel >	New (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName=turbulenceModel::propertiesName)
	Return a reference to the selected LES model. More...

Detailed Description

template<class BasicTurbulenceModel>
class Foam::LESModels::sigma< BasicTurbulenceModel >

The sigma SGS model.

Reference:

    Nicoud, F., Toda, H. B., Cabrit, O., Bose, S., & Lee, J. (2011).
    Using singular values to build a subgrid-scale
    model for large eddy simulations.
    Physics of fluids, 23(8), 085106.
    DOI:10.1063/1.3623274

The default model coefficients correspond to the following:

    sigmaCoeffs
    {
        ck          0.094;
        Csigma      1.68;
    }

Note: The default value of the Csigma constant implemented was calibrated for OpenFOAM using decaying isotropic turbulence and is slightly higher than the value suggested in the reference publication.

Source files

Definition at line 77 of file sigma.H.

Member Typedef Documentation

◆ alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 113 of file sigma.H.

◆ rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 114 of file sigma.H.

◆ transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 115 of file sigma.H.

Constructor & Destructor Documentation

◆ sigma()

sigma	(	const alphaField &	alpha,
		const rhoField &	rho,
		const volVectorField &	U,
		const surfaceScalarField &	alphaRhoPhi,
		const surfaceScalarField &	phi,
		const transportModel &	transport,
		const word &	propertiesName = `turbulenceModel::propertiesName`,
		const word &	type = `typeName`
	)