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

Inheritance diagram for RASModel< BasicMomentumTransportModel >:

[legend]

Collaboration diagram for RASModel< BasicMomentumTransportModel >:

Public Types
typedef BasicMomentumTransportModel::alphaField	alphaField

typedef BasicMomentumTransportModel::rhoField	rhoField

typedef BasicMomentumTransportModel::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),(alpha, rho, U, alphaRhoPhi, phi, transport))

	RASModel (const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)
	Construct from components. More...

	RASModel (const RASModel &)=delete
	Disallow default bitwise copy construction. 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...

void	operator= (const RASModel &)=delete
	Disallow default bitwise assignment. 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)
	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 BasicMomentumTransportModel>
class Foam::RASModel< BasicMomentumTransportModel >

Templated abstract base class for RAS turbulence models.

Source files

Definition at line 49 of file RASModel.H.

Member Typedef Documentation

◆ alphaField

typedef BasicMomentumTransportModel::alphaField alphaField

Definition at line 88 of file RASModel.H.

◆ rhoField

typedef BasicMomentumTransportModel::rhoField rhoField

Definition at line 89 of file RASModel.H.

◆ transportModel

typedef BasicMomentumTransportModel::transportModel transportModel

Definition at line 90 of file RASModel.H.

Constructor & Destructor Documentation

◆ RASModel() [1/2]

RASModel	(	const word &	type,
		const alphaField &	alpha,
		const rhoField &	rho,
		const volVectorField &	U,
		const surfaceScalarField &	alphaRhoPhi,
		const surfaceScalarField &	phi,
		const transportModel &	transport
	)

Construct from components.

Definition at line 44 of file RASModel.C.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::printCoeffs().

Here is the caller graph for this function:

◆ RASModel() [2/2]

RASModel ( const RASModel< BasicMomentumTransportModel > & )

delete

Disallow default bitwise copy construction.

◆ ~RASModel()

virtual ~RASModel ( )

inlinevirtual

Destructor.

Definition at line 149 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< BasicMomentumTransportModel >	,
		dictionary	,
		(const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)	,
		(alpha, rho, U, alphaRhoPhi, phi, transport)
	)

◆ New()

Foam::autoPtr< Foam::RASModel< BasicMomentumTransportModel > > New	(	const alphaField &	alpha,
		const rhoField &	rho,
		const volVectorField &	U,
		const surfaceScalarField &	alphaRhoPhi,
		const surfaceScalarField &	phi,
		const transportModel &	transport
	)

static

Return a reference to the selected RAS model.

Definition at line 114 of file RASModel.C.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::RASModel().

Here is the caller graph for this function:

◆ read()

bool read ( )

virtual

Read model coefficients if they have changed.

Definition at line 163 of file RASModel.C.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::~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 162 of file RASModel.H.

◆ epsilonMin() [1/2]

const dimensionedScalar& epsilonMin ( ) const

inline

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

Definition at line 168 of file RASModel.H.

◆ omegaMin() [1/2]

const dimensionedScalar& omegaMin ( ) const

inline

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

Definition at line 174 of file RASModel.H.

◆ kMin() [2/2]

dimensionedScalar& kMin ( )

inline

Allow kMin to be changed.

Definition at line 180 of file RASModel.H.

◆ epsilonMin() [2/2]

dimensionedScalar& epsilonMin ( )

inline

Allow epsilonMin to be changed.

Definition at line 186 of file RASModel.H.

◆ omegaMin() [2/2]

dimensionedScalar& omegaMin ( )

inline

Allow omegaMin to be changed.

Definition at line 192 of file RASModel.H.

◆ coeffDict()

virtual const dictionary& coeffDict ( ) const

inlinevirtual

Const access to the coefficients dictionary.

Definition at line 198 of file RASModel.H.

◆ nuEff() [1/2]

virtual tmp<volScalarField> nuEff ( ) const

inlinevirtual

Return the effective viscosity.

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

Definition at line 205 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, and phasePressureModel.

Definition at line 215 of file RASModel.H.

◆ correct()

void correct ( )

virtual

Solve the turbulence equations and correct the turbulence viscosity.

Definition at line 186 of file RASModel.C.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::nuEff().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const RASModel< BasicMomentumTransportModel > & )

delete

Disallow default bitwise assignment.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::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< phaseCompressible::momentumTransportModel >::coeffDict().

◆ kMin_

dimensionedScalar kMin_

protected

Lower limit of k.

Definition at line 71 of file RASModel.H.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::kMin().

◆ epsilonMin_

dimensionedScalar epsilonMin_

protected

Lower limit of epsilon.

Definition at line 74 of file RASModel.H.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::epsilonMin().

◆ omegaMin_

dimensionedScalar omegaMin_

protected

Lower limit for omega.

Definition at line 77 of file RASModel.H.

Referenced by RASModel< phaseCompressible::momentumTransportModel >::omegaMin().

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

src/MomentumTransportModels/momentumTransportModels/RAS/RASModel/RASModel.H
src/MomentumTransportModels/momentumTransportModels/RAS/RASModel/RASModel.C

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

template<class BasicMomentumTransportModel> class Foam::RASModel< BasicMomentumTransportModel >

Member Typedef Documentation

◆ alphaField

◆ rhoField

◆ transportModel

Constructor & Destructor Documentation

◆ RASModel() [1/2]

◆ RASModel() [2/2]

◆ ~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()

◆ operator=()

Member Data Documentation

◆ RASDict_

◆ turbulence_

◆ printCoeffs_

◆ coeffDict_

◆ kMin_

◆ epsilonMin_

◆ omegaMin_

template<class BasicMomentumTransportModel>
class Foam::RASModel< BasicMomentumTransportModel >