Eddy viscosity LES SGS model base class. More...

Inheritance diagram for LESeddyViscosity< BasicMomentumTransportModel >:

[legend]

Collaboration diagram for LESeddyViscosity< BasicMomentumTransportModel >:

Public Types
typedef BasicMomentumTransportModel::alphaField	alphaField

typedef BasicMomentumTransportModel::rhoField	rhoField

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

typedef LESModel< BasicMomentumTransportModel > ::rhoField	rhoField

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

typedef LESModel< BasicMomentumTransportModel > ::rhoField	rhoField

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

typedef BasicMomentumTransportModel::rhoField	rhoField

Public Member Functions
	LESeddyViscosity (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...

	LESeddyViscosity (const LESeddyViscosity &)=delete
	Disallow default bitwise copy construction. More...

virtual	~LESeddyViscosity ()
	Destructor. More...

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

virtual tmp< volScalarField >	epsilon () const
	Return sub-grid disipation rate. More...

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

void	operator= (const LESeddyViscosity &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from eddyViscosity< LESModel< BasicMomentumTransportModel > >
	eddyViscosity (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	~eddyViscosity ()
	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 >	sigma () const
	Return the Reynolds stress tensor [m^2/s^2]. 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< BasicMomentumTransportModel > >
	linearViscousStress (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	~linearViscousStress ()
	Destructor. 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...

Public Member Functions inherited from LESModel< BasicMomentumTransportModel >
	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 viscosity &viscosity),(alpha, rho, U, alphaRhoPhi, phi, viscosity))

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

	LESModel (const LESModel &)=delete
	Disallow default bitwise copy construction. More...

virtual	~LESModel ()
	Destructor. More...

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

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 >	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 LESModel &)=delete
	Disallow default bitwise assignment. More...

Protected Attributes
dimensionedScalar	Ck_

dimensionedScalar	Ce_

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

Protected Attributes inherited from LESModel< BasicMomentumTransportModel >
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	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...

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

Additional Inherited Members
Static Public Member Functions inherited from LESModel< BasicMomentumTransportModel >
static autoPtr< LESModel >	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 LES model. More...

Protected Member Functions inherited from eddyViscosity< LESModel< BasicMomentumTransportModel > >
virtual void	correctNut ()=0

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

Detailed Description

template<class BasicMomentumTransportModel>
class Foam::LESModels::LESeddyViscosity< BasicMomentumTransportModel >

Eddy viscosity LES SGS model base class.

Source files

Definition at line 52 of file LESeddyViscosity.H.

Member Typedef Documentation

◆ alphaField

typedef BasicMomentumTransportModel::alphaField alphaField

Definition at line 66 of file LESeddyViscosity.H.

◆ rhoField

typedef BasicMomentumTransportModel::rhoField rhoField

Definition at line 67 of file LESeddyViscosity.H.

Constructor & Destructor Documentation

◆ LESeddyViscosity() [1/2]

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

Construct from components.

Definition at line 39 of file LESeddyViscosity.C.

◆ LESeddyViscosity() [2/2]

LESeddyViscosity ( const LESeddyViscosity< BasicMomentumTransportModel > & )

delete

Disallow default bitwise copy construction.

◆ ~LESeddyViscosity()

virtual ~LESeddyViscosity ( )

inlinevirtual

Destructor.

Definition at line 89 of file LESeddyViscosity.H.

References LESeddyViscosity< BasicMomentumTransportModel >::epsilon(), LESeddyViscosity< BasicMomentumTransportModel >::omega(), LESeddyViscosity< BasicMomentumTransportModel >::operator=(), and LESeddyViscosity< BasicMomentumTransportModel >::read().

Here is the call graph for this function:

Member Function Documentation

◆ read()

bool read ( )

virtual

Read model coefficients if they have changed.

Implements eddyViscosity< LESModel< BasicMomentumTransportModel > >.

Reimplemented in SpalartAllmarasDES< BasicMomentumTransportModel >, dynamicKEqn< BasicMomentumTransportModel >, SpalartAllmarasIDDES< BasicMomentumTransportModel >, NicenoKEqn< BasicMomentumTransportModel >, Smagorinsky< BasicMomentumTransportModel >, SmagorinskyZhang< BasicMomentumTransportModel >, WALE< BasicMomentumTransportModel >, continuousGasKEqn< BasicMomentumTransportModel >, kEqn< BasicMomentumTransportModel >, and dynamicLagrangian< BasicMomentumTransportModel >.

Definition at line 85 of file LESeddyViscosity.C.

References Foam::read().

Referenced by Smagorinsky< BasicMomentumTransportModel >::read(), and LESeddyViscosity< BasicMomentumTransportModel >::~LESeddyViscosity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ epsilon()

tmp< volScalarField > epsilon ( ) const

virtual

Return sub-grid disipation rate.

Reimplemented in dynamicKEqn< BasicMomentumTransportModel >, WALE< BasicMomentumTransportModel >, and kEqn< BasicMomentumTransportModel >.

Definition at line 103 of file LESeddyViscosity.C.

References delta, IOobject::groupName(), k, GeometricField< scalar, fvPatchField, volMesh >::New(), and Foam::sqrt().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ omega()

tmp< volScalarField > omega ( ) const

virtual

Return the turbulence specific dissipation rate.

Definition at line 117 of file LESeddyViscosity.C.

References delta, IOobject::groupName(), k, GeometricField< scalar, fvPatchField, volMesh >::New(), and Foam::sqrt().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ operator=()

void operator= ( const LESeddyViscosity< BasicMomentumTransportModel > & )

delete

Disallow default bitwise assignment.

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

Here is the caller graph for this function:

Member Data Documentation

◆ Ck_

dimensionedScalar Ck_

protected

Definition at line 60 of file LESeddyViscosity.H.

◆ Ce_

dimensionedScalar Ce_

protected

Definition at line 61 of file LESeddyViscosity.H.

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

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

src/MomentumTransportModels/momentumTransportModels/LES/LESeddyViscosity/LESeddyViscosity.H
src/MomentumTransportModels/momentumTransportModels/LES/LESeddyViscosity/LESeddyViscosity.C

Public Types

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

template<class BasicMomentumTransportModel> class Foam::LESModels::LESeddyViscosity< BasicMomentumTransportModel >

Member Typedef Documentation

◆ alphaField

◆ rhoField

Constructor & Destructor Documentation

◆ LESeddyViscosity() [1/2]

◆ LESeddyViscosity() [2/2]

◆ ~LESeddyViscosity()

Member Function Documentation

◆ read()

◆ epsilon()

◆ omega()

◆ operator=()

Member Data Documentation

◆ Ck_

◆ Ce_

template<class BasicMomentumTransportModel>
class Foam::LESModels::LESeddyViscosity< BasicMomentumTransportModel >