Public Member Functions | Private Member Functions | Private Attributes
kineticTheoryModel Class Reference
Inheritance diagram for kineticTheoryModel:
Inheritance graph
[legend]
Collaboration diagram for kineticTheoryModel:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("kineticTheory")
 Runtime type information. More...
 
 kineticTheoryModel (const volScalarField &alpha, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const phaseModel &transport, const word &propertiesName=turbulenceModel::propertiesName, const word &type=typeName)
 Construct from components. More...
 
virtual ~kineticTheoryModel ()
 Destructor. More...
 
virtual bool read ()
 Re-read model coefficients if they have changed. More...
 
virtual tmp< volScalarFieldnuEff () const
 Return the effective viscosity. More...
 
virtual tmp< scalarFieldnuEff (const label patchi) const
 Return the effective viscosity on patch. More...
 
virtual tmp< volScalarFieldk () const
 Return the turbulence kinetic energy. More...
 
virtual tmp< volScalarFieldepsilon () const
 Return the turbulence kinetic energy dissipation rate. More...
 
virtual tmp< volSymmTensorFieldR () const
 Return the Reynolds stress tensor. More...
 
virtual tmp< volScalarFieldpPrime () const
 Return the phase-pressure'. More...
 
virtual tmp< surfaceScalarFieldpPrimef () const
 Return the face-phase-pressure'. More...
 
virtual tmp< volSymmTensorFielddevRhoReff () const
 Return the effective stress tensor. More...
 
virtual tmp< fvVectorMatrixdivDevRhoReff (volVectorField &U) const
 Return the source term for the momentum equation. More...
 
virtual void correct ()
 Solve the kinetic theory equations and correct the viscosity. More...
 
 TypeName ("kineticTheory")
 Runtime type information. More...
 
 kineticTheoryModel (const volScalarField &alpha, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const phaseModel &transport, const word &propertiesName=turbulenceModel::propertiesName, const word &type=typeName)
 Construct from components. More...
 
virtual ~kineticTheoryModel ()
 Destructor. More...
 
virtual bool read ()
 Re-read model coefficients if they have changed. More...
 
virtual tmp< volScalarFieldnuEff () const
 Return the effective viscosity. More...
 
virtual tmp< scalarFieldnuEff (const label patchi) const
 Return the effective viscosity on patch. More...
 
virtual tmp< volScalarFieldk () const
 Return the turbulence kinetic energy. More...
 
virtual tmp< volScalarFieldepsilon () const
 Return the turbulence kinetic energy dissipation rate. More...
 
virtual tmp< volSymmTensorFieldR () const
 Return the Reynolds stress tensor. More...
 
virtual tmp< volScalarFieldpPrime () const
 Return the phase-pressure'. More...
 
virtual tmp< surfaceScalarFieldpPrimef () const
 Return the face-phase-pressure'. More...
 
virtual tmp< volSymmTensorFielddevRhoReff () const
 Return the effective stress tensor. More...
 
virtual tmp< fvVectorMatrixdivDevRhoReff (volVectorField &U) const
 Return the source term for the momentum equation. More...
 
virtual void correct ()
 Solve the kinetic theory equations and correct the viscosity. More...
 
- Public Member Functions inherited from eddyViscosity< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >
 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 ()
 Destructor. More...
 
volScalarFieldevNut ()
 Return non-const access to the turbulence viscosity. More...
 
virtual tmp< volScalarFieldnut () const
 Return the turbulence viscosity. More...
 
virtual tmp< scalarFieldnut (const label patchi) const
 Return the turbulence viscosity on patch. More...
 
virtual tmp< volScalarFieldk () const=0
 Return the turbulence kinetic energy. More...
 
virtual tmp< volSymmTensorFieldR () const
 Return the Reynolds stress tensor. More...
 
virtual void validate ()
 Validate the turbulence fields after construction. More...
 
- Public Member Functions inherited from linearViscousStress< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >
 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 ()
 Destructor. More...
 
virtual tmp< volSymmTensorFielddevRhoReff () const
 Return the effective stress tensor. More...
 
virtual tmp< fvVectorMatrixdivDevRhoReff (const volScalarField &rho, volVectorField &U) const
 Return the source term for the momentum equation. More...
 
- Public Member Functions inherited from RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >
 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...
 
 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))
 
virtual ~RASModel ()
 Destructor. More...
 
const dimensionedScalarkMin () const
 Return the lower allowable limit for k (default: SMALL) More...
 
dimensionedScalarkMin ()
 Allow kMin to be changed. More...
 
const dimensionedScalarepsilonMin () const
 Return the lower allowable limit for epsilon (default: SMALL) More...
 
dimensionedScalarepsilonMin ()
 Allow epsilonMin to be changed. More...
 
const dimensionedScalaromegaMin () const
 Return the lower allowable limit for omega (default: SMALL) More...
 
dimensionedScalaromegaMin ()
 Allow omegaMin to be changed. More...
 
virtual const dictionarycoeffDict () const
 Const access to the coefficients dictionary. More...
 
virtual tmp< volScalarFieldnuEff () const
 Return the effective viscosity. More...
 
- Public Member Functions inherited from EddyDiffusivity< phaseCompressibleTurbulenceModel >
 EddyDiffusivity (const word &type, const alphaField &alpha, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName)
 Construct. More...
 
virtual ~EddyDiffusivity ()
 Destructor. More...
 
virtual tmp< volScalarFieldalphat () const
 Return the turbulent thermal diffusivity for enthalpy [kg/m/s]. More...
 
virtual tmp< scalarFieldalphat (const label patchi) const
 Return the turbulent thermal diffusivity for enthalpy for a patch. More...
 
virtual tmp< volScalarFieldkappaEff () const
 Return the effective turbulent thermal diffusivity for temperature. More...
 
virtual tmp< scalarFieldkappaEff (const label patchi) const
 Return the effective turbulent thermal diffusivity for temperature. More...
 
virtual tmp< volScalarFieldalphaEff () const
 Return the effective turbulent thermal diffusivity for enthalpy. More...
 
virtual tmp< scalarFieldalphaEff (const label patchi) const
 Return the effective turbulent thermal diffusivity for enthalpy. More...
 
virtual void correctEnergyTransport ()
 Correct the turbulence thermal diffusivity for energy transport. More...
 
- Public Member Functions inherited from ThermalDiffusivity< BasicTurbulenceModel >
 ThermalDiffusivity (const word &type, const alphaField &alpha, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName)
 Construct. More...
 
virtual ~ThermalDiffusivity ()
 Destructor. More...
 
virtual tmp< volScalarFieldkappa () const
 Return the thermal diffusivity for temperature [J/m/s/K]. More...
 
virtual tmp< scalarFieldkappa (const label patchi) const
 Return the laminar thermal diffusivity for temperature on patch. More...
 
virtual tmp< volScalarFieldalpha () const
 Return the laminar thermal diffusivity for enthalpy [kg/m/s]. More...
 
virtual tmp< scalarFieldalpha (const label patchi) const
 Return the laminar thermal diffusivity for enthalpy on patch. More...
 
virtual tmp< volScalarFieldalphat () const
 Return the turbulent thermal diffusivity for enthalpy [kg/m/s]. More...
 
virtual tmp< volScalarFieldkappaEff () const
 Return the effective turbulent thermal diffusivity for temperature. More...
 
virtual tmp< volScalarFieldalphaEff () const
 Return the effective turbulent thermal diffusivity for enthalpy. More...
 

Private Member Functions

void correctNut ()
 
 kineticTheoryModel (const kineticTheoryModel &)
 Disallow default bitwise copy construct. More...
 
void operator= (const kineticTheoryModel &)
 Disallow default bitwise assignment. More...
 
void correctNut ()
 
 kineticTheoryModel (const kineticTheoryModel &)
 Disallow default bitwise copy construct. More...
 
void operator= (const kineticTheoryModel &)
 Disallow default bitwise assignment. More...
 

Private Attributes

const phaseModelphase_
 
autoPtr< kineticTheoryModels::viscosityModelviscosityModel_
 Run-time selected viscosity model. More...
 
autoPtr< kineticTheoryModels::conductivityModelconductivityModel_
 Run-time selected conductivity model. More...
 
autoPtr< kineticTheoryModels::radialModelradialModel_
 Run-time selected radial distribution model. More...
 
autoPtr< kineticTheoryModels::granularPressureModelgranularPressureModel_
 Run-time selected granular pressure model. More...
 
autoPtr< kineticTheoryModels::frictionalStressModelfrictionalStressModel_
 Run-time selected frictional stress model. More...
 
Switch equilibrium_
 Use equilibrium approximation: generation == dissipation. More...
 
dimensionedScalar e_
 Coefficient of restitution. More...
 
dimensionedScalar alphaMax_
 Maximum packing phase-fraction. More...
 
dimensionedScalar alphaMinFriction_
 Min value for which the frictional stresses are zero. More...
 
dimensionedScalar residualAlpha_
 Residual phase fraction. More...
 
volScalarField Theta_
 The granular energy/temperature. More...
 
volScalarField lambda_
 The granular bulk viscosity. More...
 
volScalarField gs0_
 The granular radial distribution. More...
 
volScalarField kappa_
 The granular "thermal" conductivity. More...
 

Additional Inherited Members

- Public Types inherited from eddyViscosity< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >
typedef RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > ::alphaField alphaField
 
typedef RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > ::rhoField rhoField
 
typedef RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > ::transportModel transportModel
 
- Public Types inherited from linearViscousStress< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >
typedef RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > ::alphaField alphaField
 
typedef RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > ::rhoField rhoField
 
typedef RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > ::transportModel transportModel
 
- Public Types inherited from RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >
typedef EddyDiffusivity< phaseCompressibleTurbulenceModel > ::alphaField alphaField
 
typedef EddyDiffusivity< phaseCompressibleTurbulenceModel > ::rhoField rhoField
 
typedef EddyDiffusivity< phaseCompressibleTurbulenceModel > ::transportModel transportModel
 
- Public Types inherited from EddyDiffusivity< phaseCompressibleTurbulenceModel >
typedef phaseCompressibleTurbulenceModel ::alphaField alphaField
 
typedef phaseCompressibleTurbulenceModel ::rhoField rhoField
 
typedef phaseCompressibleTurbulenceModel ::transportModel transportModel
 
- Public Types inherited from ThermalDiffusivity< BasicTurbulenceModel >
typedef BasicTurbulenceModel::alphaField alphaField
 
typedef volScalarField rhoField
 
typedef BasicTurbulenceModel::transportModel transportModel
 
- Static Public Member Functions inherited from RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >
static autoPtr< RASModelNew (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...
 
- Static Public Member Functions inherited from ThermalDiffusivity< BasicTurbulenceModel >
static autoPtr< ThermalDiffusivityNew (const alphaField &alpha, const volScalarField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transportModel, const word &propertiesName=turbulenceModel::propertiesName)
 Return a reference to the selected turbulence model. More...
 
static autoPtr< ThermalDiffusivityNew (const volScalarField &rho, const volVectorField &U, const surfaceScalarField &phi, const transportModel &transportModel, const word &propertiesName=turbulenceModel::propertiesName)
 Return a reference to the selected turbulence model. More...
 
- Protected Member Functions inherited from RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >
virtual void printCoeffs (const word &type)
 Print model coefficients. More...
 
- Protected Attributes inherited from eddyViscosity< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >
volScalarField nut_
 
- Protected Attributes inherited from RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >
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...
 
- Protected Attributes inherited from EddyDiffusivity< phaseCompressibleTurbulenceModel >
dimensionedScalar Prt_
 
volScalarField alphat_
 

Detailed Description

Definition at line 71 of file kineticTheoryModel.H.

Constructor & Destructor Documentation

◆ kineticTheoryModel() [1/4]

kineticTheoryModel ( const kineticTheoryModel )
private

Disallow default bitwise copy construct.

◆ kineticTheoryModel() [2/4]

kineticTheoryModel ( const volScalarField alpha,
const volScalarField rho,
const volVectorField U,
const surfaceScalarField alphaRhoPhi,
const surfaceScalarField phi,
const phaseModel transport,
const word propertiesName = turbulenceModel::propertiesName,
const word type = typeName 
)

Construct from components.

◆ ~kineticTheoryModel() [1/2]

virtual ~kineticTheoryModel ( )
virtual

Destructor.

◆ kineticTheoryModel() [3/4]

kineticTheoryModel ( const kineticTheoryModel )
private

Disallow default bitwise copy construct.

◆ kineticTheoryModel() [4/4]

kineticTheoryModel ( const volScalarField alpha,
const volScalarField rho,
const volVectorField U,
const surfaceScalarField alphaRhoPhi,
const surfaceScalarField phi,
const phaseModel transport,
const word propertiesName = turbulenceModel::propertiesName,
const word type = typeName 
)

Construct from components.

◆ ~kineticTheoryModel() [2/2]

virtual ~kineticTheoryModel ( )
virtual

Destructor.

Member Function Documentation

◆ correctNut() [1/2]

void correctNut ( )
inlineprivatevirtual

◆ operator=() [1/2]

void operator= ( const kineticTheoryModel )
private

Disallow default bitwise assignment.

◆ TypeName() [1/2]

TypeName ( "kineticTheory"  )

Runtime type information.

◆ read() [1/2]

virtual bool read ( )
virtual

Re-read model coefficients if they have changed.

Implements eddyViscosity< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >.

◆ nuEff() [1/4]

virtual tmp<volScalarField> nuEff ( ) const
inlinevirtual

Return the effective viscosity.

Definition at line 182 of file kineticTheoryModel.H.

References eddyViscosity< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >::nut().

Here is the call graph for this function:

◆ nuEff() [2/4]

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

Return the effective viscosity on patch.

Reimplemented from RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >.

Definition at line 188 of file kineticTheoryModel.H.

References eddyViscosity< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >::nut().

Here is the call graph for this function:

◆ k() [1/2]

virtual tmp<volScalarField> k ( ) const
virtual

Return the turbulence kinetic energy.

◆ epsilon() [1/2]

virtual tmp<volScalarField> epsilon ( ) const
virtual

Return the turbulence kinetic energy dissipation rate.

◆ R() [1/2]

virtual tmp<volSymmTensorField> R ( ) const
virtual

Return the Reynolds stress tensor.

◆ pPrime() [1/2]

virtual tmp<volScalarField> pPrime ( ) const
virtual

Return the phase-pressure'.

(derivative of phase-pressure w.r.t. phase-fraction)

◆ pPrimef() [1/2]

virtual tmp<surfaceScalarField> pPrimef ( ) const
virtual

Return the face-phase-pressure'.

(derivative of phase-pressure w.r.t. phase-fraction)

◆ devRhoReff() [1/2]

virtual tmp<volSymmTensorField> devRhoReff ( ) const
virtual

Return the effective stress tensor.

◆ divDevRhoReff() [1/2]

virtual tmp<fvVectorMatrix> divDevRhoReff ( volVectorField U) const
virtual

Return the source term for the momentum equation.

Reimplemented from linearViscousStress< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >.

◆ correct() [1/2]

virtual void correct ( )
virtual

Solve the kinetic theory equations and correct the viscosity.

Implements eddyViscosity< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >.

◆ correctNut() [2/2]

void correctNut ( )
inlineprivatevirtual

◆ operator=() [2/2]

void operator= ( const kineticTheoryModel )
private

Disallow default bitwise assignment.

◆ TypeName() [2/2]

TypeName ( "kineticTheory"  )

Runtime type information.

◆ read() [2/2]

virtual bool read ( )
virtual

Re-read model coefficients if they have changed.

Implements eddyViscosity< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >.

◆ nuEff() [3/4]

virtual tmp<volScalarField> nuEff ( ) const
inlinevirtual

Return the effective viscosity.

Definition at line 186 of file kineticTheoryModel.H.

References eddyViscosity< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >::nut().

Here is the call graph for this function:

◆ nuEff() [4/4]

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

Return the effective viscosity on patch.

Reimplemented from RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > >.

Definition at line 192 of file kineticTheoryModel.H.

References eddyViscosity< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >::nut().

Here is the call graph for this function:

◆ k() [2/2]

virtual tmp<volScalarField> k ( ) const
virtual

Return the turbulence kinetic energy.

◆ epsilon() [2/2]

virtual tmp<volScalarField> epsilon ( ) const
virtual

Return the turbulence kinetic energy dissipation rate.

◆ R() [2/2]

virtual tmp<volSymmTensorField> R ( ) const
virtual

Return the Reynolds stress tensor.

◆ pPrime() [2/2]

virtual tmp<volScalarField> pPrime ( ) const
virtual

Return the phase-pressure'.

(derivative of phase-pressure w.r.t. phase-fraction)

◆ pPrimef() [2/2]

virtual tmp<surfaceScalarField> pPrimef ( ) const
virtual

Return the face-phase-pressure'.

(derivative of phase-pressure w.r.t. phase-fraction)

◆ devRhoReff() [2/2]

virtual tmp<volSymmTensorField> devRhoReff ( ) const
virtual

Return the effective stress tensor.

◆ divDevRhoReff() [2/2]

virtual tmp<fvVectorMatrix> divDevRhoReff ( volVectorField U) const
virtual

Return the source term for the momentum equation.

Reimplemented from linearViscousStress< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >.

◆ correct() [2/2]

virtual void correct ( )
virtual

Solve the kinetic theory equations and correct the viscosity.

Implements eddyViscosity< RASModel< EddyDiffusivity< phaseCompressibleTurbulenceModel > > >.

Field Documentation

◆ phase_

const phaseModel & phase_
private

Definition at line 82 of file kineticTheoryModel.H.

◆ viscosityModel_

autoPtr< kineticTheoryModels::viscosityModel > viscosityModel_
private

Run-time selected viscosity model.

Definition at line 88 of file kineticTheoryModel.H.

◆ conductivityModel_

autoPtr< kineticTheoryModels::conductivityModel > conductivityModel_
private

Run-time selected conductivity model.

Definition at line 91 of file kineticTheoryModel.H.

◆ radialModel_

autoPtr< kineticTheoryModels::radialModel > radialModel_
private

Run-time selected radial distribution model.

Definition at line 94 of file kineticTheoryModel.H.

◆ granularPressureModel_

autoPtr< kineticTheoryModels::granularPressureModel > granularPressureModel_
private

Run-time selected granular pressure model.

Definition at line 98 of file kineticTheoryModel.H.

◆ frictionalStressModel_

autoPtr< kineticTheoryModels::frictionalStressModel > frictionalStressModel_
private

Run-time selected frictional stress model.

Definition at line 102 of file kineticTheoryModel.H.

◆ equilibrium_

Switch equilibrium_
private

Use equilibrium approximation: generation == dissipation.

Definition at line 108 of file kineticTheoryModel.H.

◆ e_

dimensionedScalar e_
private

Coefficient of restitution.

Definition at line 111 of file kineticTheoryModel.H.

◆ alphaMax_

dimensionedScalar alphaMax_
private

Maximum packing phase-fraction.

Definition at line 114 of file kineticTheoryModel.H.

◆ alphaMinFriction_

dimensionedScalar alphaMinFriction_
private

Min value for which the frictional stresses are zero.

Definition at line 117 of file kineticTheoryModel.H.

◆ residualAlpha_

dimensionedScalar residualAlpha_
private

Residual phase fraction.

Definition at line 120 of file kineticTheoryModel.H.

◆ Theta_

volScalarField Theta_
private

The granular energy/temperature.

Definition at line 126 of file kineticTheoryModel.H.

◆ lambda_

volScalarField lambda_
private

The granular bulk viscosity.

Definition at line 129 of file kineticTheoryModel.H.

◆ gs0_

volScalarField gs0_
private

The granular radial distribution.

Definition at line 132 of file kineticTheoryModel.H.

◆ kappa_

volScalarField kappa_
private

The granular "thermal" conductivity.

Definition at line 135 of file kineticTheoryModel.H.


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