Templated abstract base class for LES SGS models. More...

Inheritance diagram for LESModel< BasicTurbulenceModel >:

[legend]

Collaboration diagram for LESModel< BasicTurbulenceModel >:

[legend]

Public Types
typedef BasicTurbulenceModel::alphaField	alphaField

typedef BasicTurbulenceModel::rhoField	rhoField

typedef BasicTurbulenceModel::transportModel	transportModel

Public Member Functions
	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 ()
	Destructor. More...

virtual bool	read ()
	Read model coefficients if they have changed. 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 >	nuEff () const
	Return the effective viscosity. More...

virtual tmp< scalarField >	nuEff (const label patchi) const
	Return the effective viscosity on patch. More...

virtual void	correct ()
	Solve the turbulence equations and correct the turbulence viscosity. More...

Static Public Member Functions
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 Member Functions
virtual void	printCoeffs (const word &type)
	Print model coefficients. More...

Protected Attributes
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	omegaMin_
	Lower limit of omega. More...

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

Private Member Functions
	LESModel (const LESModel &)
	Disallow default bitwise copy construct. More...

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

Detailed Description

template<class BasicTurbulenceModel>
class Foam::LESModel< BasicTurbulenceModel >

Templated abstract base class for LES SGS models.

Source files

Definition at line 56 of file LESModel.H.

Member Typedef Documentation

◆ alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 106 of file LESModel.H.

◆ rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 107 of file LESModel.H.

◆ transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 108 of file LESModel.H.

Constructor & Destructor Documentation

◆ LESModel() [1/2]

LESModel ( const LESModel< BasicTurbulenceModel > & )

private

Disallow default bitwise copy construct.

◆ LESModel() [2/2]

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.

Definition at line 44 of file LESModel.C.

◆ ~LESModel()

virtual ~LESModel ( )

inlinevirtual

Destructor.

Definition at line 167 of file LESModel.H.

Member Function Documentation

◆ printCoeffs()

void printCoeffs ( const word & type )

protectedvirtual

Print model coefficients.

Definition at line 31 of file LESModel.C.

References Foam::endl(), Foam::Info, and Foam::type().

Here is the call graph for this function:

◆ operator=()

void operator= ( const LESModel< BasicTurbulenceModel > & )

private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "LES" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		LESModel< BasicTurbulenceModel >	,
		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)
	)

◆ New()

Foam::autoPtr< Foam::LESModel< BasicTurbulenceModel > > New	(	const alphaField &	alpha,
		const rhoField &	rho,
		const volVectorField &	U,
		const surfaceScalarField &	alphaRhoPhi,
		const surfaceScalarField &	phi,
		const transportModel &	transport,
		const word &	propertiesName = `turbulenceModel::propertiesName`
	)