Templated abstract base class for DES models. More...

Inheritance diagram for DESModel< BasicTurbulenceModel >:

Collaboration diagram for DESModel< 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
	DESModel (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	~DESModel ()=default
	Destructor. More...

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

virtual tmp< volScalarField >	LESRegion () const =0
	Return the LES field indicator. More...

virtual tmp< volScalarField >	Ssigma (const volTensorField &gradU) const
	Return modified strain rate. More...

virtual tmp< volScalarField >	fd () const
	Return the shielding function. More...

Public Member Functions inherited from DESModelBase
	ClassName ("DESModelBase")
	Runtime type information. More...

	DESModelBase () noexcept=default
	Constructor. More...

virtual	~DESModelBase ()=default
	Destructor. 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< volScalarField >	k () const=0
	Return the turbulence kinetic energy. More...

virtual tmp< volSymmTensorField >	R () const
	Return the Reynolds stress tensor. 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...

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 >	epsilon () const
	Return the turbulence kinetic energy dissipation rate. More...

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

Static Public Member Functions
static tmp< volScalarField >	Ssigma (const volTensorField &gradU, const dimensionedScalar &coeff)
	Return modified strain rate. More...

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

Protected Attributes
dimensionedScalar	Ctrans_
	Model-specific transition constant. More...

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
Protected Member Functions inherited from eddyViscosity< LESModel< BasicTurbulenceModel > >
virtual void	correctNut ()=0

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

Detailed Description

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

Templated abstract base class for DES models.

Source files

Definition at line 51 of file DESModel.H.

Member Typedef Documentation

◆ alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 81 of file DESModel.H.

◆ rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 82 of file DESModel.H.

◆ transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 83 of file DESModel.H.

Constructor & Destructor Documentation

◆ DESModel()

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

Definition at line 36 of file DESModel.C.

◆ ~DESModel()

virtual ~DESModel ( )

virtualdefault

Destructor.

Member Function Documentation

◆ read()

bool read ( )

virtual

Re-read model coefficients if they have changed.

Reimplemented from LESeddyViscosity< BasicTurbulenceModel >.

Definition at line 67 of file DESModel.C.

◆ LESRegion()

virtual tmp<volScalarField> LESRegion ( ) const

pure virtual

Return the LES field indicator.

Implements DESModelBase.

◆ Ssigma() [1/2]

tmp< volScalarField > Ssigma	(	const volTensorField &	gradU,
		const dimensionedScalar &	coeff
	)

static

Return modified strain rate.

Definition at line 82 of file DESModel.C.

References Foam::acos(), alpha1, Foam::cos(), Foam::det(), Foam::dimless, Foam::dimTime, Foam::constant::universal::G, Foam::max(), Foam::min(), Foam::constant::mathematical::pi(), Foam::pow(), Foam::pow3(), Foam::pow4(), Foam::sqr(), Foam::sqrt(), GeometricField< Type, PatchField, GeoMesh >::T(), and Foam::tr().

Referenced by sigma< BasicTurbulenceModel >::correctNut().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Ssigma() [2/2]

tmp< volScalarField > Ssigma ( const volTensorField & gradU ) const

virtual

Return modified strain rate.

Note: uses Ctrans_ coefficient

Definition at line 153 of file DESModel.C.

◆ fd()

tmp< volScalarField > fd ( ) const

virtual

Return the shielding function.

Implements DESModelBase.

Definition at line 162 of file DESModel.C.

References Foam::dimless, GeometricField< scalar, fvPatchField, volMesh >::New(), IOobjectOption::NO_REGISTER, and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ Ctrans_

dimensionedScalar Ctrans_

protected

Model-specific transition constant.

Definition at line 76 of file DESModel.H.

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

src/TurbulenceModels/turbulenceModels/DES/DESModel/DESModel.H
src/TurbulenceModels/turbulenceModels/DES/DESModel/DESModel.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

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

Member Typedef Documentation

◆ alphaField

◆ rhoField

◆ transportModel

Constructor & Destructor Documentation

◆ DESModel()

◆ ~DESModel()

Member Function Documentation

◆ read()

◆ LESRegion()

◆ Ssigma() [1/2]

◆ Ssigma() [2/2]

◆ fd()

Member Data Documentation

◆ Ctrans_

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