Templated abstract base class for RAS turbulence models. More...

Inheritance diagram for RASModel< BasicTurbulenceModel >:

[legend]

Collaboration diagram for RASModel< BasicTurbulenceModel >:

Public Types
typedef BasicTurbulenceModel::alphaField	alphaField

typedef BasicTurbulenceModel::rhoField	rhoField

typedef BasicTurbulenceModel::transportModel	transportModel

Public Member Functions
	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 transportModel &transport, const word &propertiesName),(alpha, rho, U, alphaRhoPhi, phi, transport, propertiesName))

	RASModel (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	~RASModel ()
	Destructor. More...

virtual bool	read ()
	Read model coefficients if they have changed. 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 >	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< RASModel >	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 RAS model. More...

Protected Member Functions
virtual void	printCoeffs (const word &type)
	Print model coefficients. More...

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

Detailed Description

template<class BasicTurbulenceModel>
class Foam::RASModel< BasicTurbulenceModel >

Templated abstract base class for RAS turbulence models.

Source files

Definition at line 49 of file RASModel.H.

Member Typedef Documentation

◆ alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 99 of file RASModel.H.

◆ rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 100 of file RASModel.H.

◆ transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 101 of file RASModel.H.

Constructor & Destructor Documentation

◆ RASModel()

RASModel	(	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 RASModel.C.

◆ ~RASModel()

virtual ~RASModel ( )

inlinevirtual

Destructor.

Definition at line 160 of file RASModel.H.

Member Function Documentation

◆ printCoeffs()

void printCoeffs ( const word & type )

protectedvirtual

Print model coefficients.

Definition at line 31 of file RASModel.C.

◆ TypeName()

TypeName ( "RAS" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		RASModel< 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::RASModel< 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`
	)

static

Return a reference to the selected RAS model.

Definition at line 116 of file RASModel.C.

Referenced by RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::RASModel().

Here is the caller graph for this function:

◆ read()

bool read ( )

virtual

Read model coefficients if they have changed.

Definition at line 169 of file RASModel.C.

Referenced by RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::~RASModel().

Here is the caller graph for this function:

◆ kMin() [1/2]

const dimensionedScalar& kMin ( ) const

inline

Return the lower allowable limit for k (default: SMALL)

Definition at line 173 of file RASModel.H.

◆ epsilonMin() [1/2]

const dimensionedScalar& epsilonMin ( ) const

inline

Return the lower allowable limit for epsilon (default: SMALL)

Definition at line 179 of file RASModel.H.

◆ omegaMin() [1/2]

const dimensionedScalar& omegaMin ( ) const

inline

Return the lower allowable limit for omega (default: SMALL)

Definition at line 185 of file RASModel.H.

◆ kMin() [2/2]

dimensionedScalar& kMin ( )

inline

Allow kMin to be changed.

Definition at line 191 of file RASModel.H.

◆ epsilonMin() [2/2]

dimensionedScalar& epsilonMin ( )

inline

Allow epsilonMin to be changed.

Definition at line 197 of file RASModel.H.

◆ omegaMin() [2/2]

dimensionedScalar& omegaMin ( )

inline

Allow omegaMin to be changed.

Definition at line 203 of file RASModel.H.

◆ coeffDict()

virtual const dictionary& coeffDict ( ) const

inlinevirtual

Const access to the coefficients dictionary.

Definition at line 209 of file RASModel.H.

◆ nuEff() [1/2]

virtual tmp<volScalarField> nuEff ( ) const

inlinevirtual

Return the effective viscosity.

Reimplemented in kineticTheoryModel, kineticTheoryModel, continuousGasKEpsilon< BasicTurbulenceModel >, phasePressureModel, and phasePressureModel.

Definition at line 216 of file RASModel.H.

◆ nuEff() [2/2]

virtual tmp<scalarField> nuEff ( const label patchi ) const

inlinevirtual

Return the effective viscosity on patch.

Reimplemented in kineticTheoryModel, kineticTheoryModel, phasePressureModel, and phasePressureModel.

Definition at line 229 of file RASModel.H.

◆ correct()

void correct ( )

virtual

Solve the turbulence equations and correct the turbulence viscosity.

Definition at line 192 of file RASModel.C.

Referenced by RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::nuEff().

Here is the caller graph for this function:

Member Data Documentation

◆ RASDict_

dictionary RASDict_

protected

RAS coefficients dictionary.

Definition at line 59 of file RASModel.H.

◆ turbulence_

Switch turbulence_

protected

Turbulence on/off flag.

Definition at line 62 of file RASModel.H.

◆ printCoeffs_

Switch printCoeffs_

protected

Flag to print the model coeffs at run-time.

Definition at line 65 of file RASModel.H.

◆ coeffDict_

dictionary coeffDict_

protected

Model coefficients dictionary.

Definition at line 68 of file RASModel.H.

Referenced by RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::coeffDict().

◆ kMin_

dimensionedScalar kMin_

protected

Lower limit of k.

Definition at line 71 of file RASModel.H.

Referenced by RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::kMin().

◆ epsilonMin_

dimensionedScalar epsilonMin_

protected

Lower limit of epsilon.

Definition at line 74 of file RASModel.H.

Referenced by RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::epsilonMin().

◆ omegaMin_

dimensionedScalar omegaMin_

protected

Lower limit for omega.

Definition at line 77 of file RASModel.H.

Referenced by RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >::omegaMin().

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

src/TurbulenceModels/turbulenceModels/RAS/RASModel/RASModel.H
src/TurbulenceModels/turbulenceModels/RAS/RASModel/RASModel.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class BasicTurbulenceModel> class Foam::RASModel< BasicTurbulenceModel >

Member Typedef Documentation

◆ alphaField

◆ rhoField

◆ transportModel

Constructor & Destructor Documentation

◆ RASModel()

◆ ~RASModel()

Member Function Documentation

◆ printCoeffs()

◆ TypeName()

◆ declareRunTimeSelectionTable()

◆ New()

◆ read()

◆ kMin() [1/2]

◆ epsilonMin() [1/2]

◆ omegaMin() [1/2]

◆ kMin() [2/2]

◆ epsilonMin() [2/2]

◆ omegaMin() [2/2]

◆ coeffDict()

◆ nuEff() [1/2]

◆ nuEff() [2/2]

◆ correct()

Member Data Documentation

◆ RASDict_

◆ turbulence_

◆ printCoeffs_

◆ coeffDict_

◆ kMin_

◆ epsilonMin_

◆ omegaMin_

template<class BasicTurbulenceModel>
class Foam::RASModel< BasicTurbulenceModel >