Public Member Functions | List of all members
DADummyTurbulenceModel Class Reference
Inheritance diagram for DADummyTurbulenceModel:
Inheritance graph
[legend]
Collaboration diagram for DADummyTurbulenceModel:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("dummy")
 
 DADummyTurbulenceModel (const word modelType, const fvMesh &mesh, const DAOption &daOption)
 
virtual ~DADummyTurbulenceModel ()
 
virtual void correctModelStates (wordList &modelStates) const
 update the turbulence state for DAStateInfo::regStates_ More...
 
virtual void correctNut ()
 update nut based on other turbulence variables and update the BCs More...
 
virtual void correctBoundaryConditions ()
 update turbulence variable boundary values More...
 
virtual void updateIntermediateVariables ()
 update any intermediate variables that are dependent on state variables and are used in calcResiduals More...
 
virtual void correctStateResidualModelCon (List< List< word >> &stateCon) const
 update the original variable connectivity for the adjoint state residuals in stateCon More...
 
virtual void addModelResidualCon (HashTable< List< List< word >>> &allCon) const
 add the model residual connectivity to stateCon More...
 
virtual void calcResiduals (const dictionary &options)
 compute the turbulence residuals More...
 
virtual void correct (label printToScreen)
 solve the residual equations and update the state More...
 
- Public Member Functions inherited from DATurbulenceModel
 TypeName ("DATurbulenceModel")
 
 declareRunTimeSelectionTable (autoPtr, DATurbulenceModel, dictionary,(const word modelType, const fvMesh &mesh, const DAOption &daOption),(modelType, mesh, daOption))
 
 DATurbulenceModel (const word modelType, const fvMesh &mesh, const DAOption &daOption)
 
virtual ~DATurbulenceModel ()
 
void correctWallDist ()
 update wall distance for d_. Note: y_ will be automatically updated in mesh_ object More...
 
void correctAlphat ()
 update alphat More...
 
virtual void getTurbProdTerm (volScalarField &prodTerm) const
 return the value of the production term from the turbulence model More...
 
virtual void getTurbProdOverDestruct (volScalarField &PoD) const
 return the ratio of the production over destruction term from the turbulence model More...
 
virtual void getTurbConvOverProd (volScalarField &CoP) const
 return the value of the convective over production term from the turbulence model More...
 
tmp< volSymmTensorField > devRhoReff () const
 dev terms More...
 
tmp< fvVectorMatrix > divDevRhoReff (volVectorField &U)
 divDev terms More...
 
tmp< fvVectorMatrix > divDevReff (volVectorField &U)
 divDev terms More...
 
tmp< volScalarField > nuEff () const
 return effective viscosity More...
 
tmp< volScalarField > nut ()
 get the nut field More...
 
tmp< volScalarField > alphaEff ()
 return effective thermal diffusivity More...
 
tmp< volScalarField > nu () const
 get the nu field More...
 
tmp< volScalarField > alpha () const
 get alpha field More...
 
tmp< volScalarField > rho () const
 get the density field More...
 
dimensionSet rhoDimensions () const
 return the dimension of rho More...
 
tmp< volScalarField > phase ()
 get the phase field More...
 
scalar prt ()
 get the turbulent Prandtl number More...
 
tmp< Foam::volScalarField > mu () const
 get mu More...
 
bool writeData (Ostream &os) const
 this is a virtual function for regIOobject More...
 
void printYPlus (const label printToScreen) const
 print the min max and mean yPlus to screen More...
 
word getTurbModelType () const
 
label isPrintTime (const Time &runTime, const label printInterval) const
 
virtual void invTranProdNuTildaEqn (const volScalarField &mySource, volScalarField &pseudoNuTilda)
 Inverse transpose product, M_nuTilda^(-T) More...
 
virtual void constructPseudoNuTildaEqn ()
 
virtual void rhsSolvePseudoNuTildaEqn (const volScalarField &nuTildaSource)
 
virtual void calcLduResidualTurb (volScalarField &nuTildaRes)
 calculate the turbulence residual using LDU matrix More...
 
virtual void getFvMatrixFields (const word varName, scalarField &diag, scalarField &upper, scalarField &lower)
 return the diag(), upper(), and lower() scalarFields from the turbulence model's fvMatrix More...
 
virtual void solveAdjointFP (const word varName, const scalarList &rhs, scalarList &dPsi)
 solve the fvMatrixT field with given rhs and solution More...
 

Additional Inherited Members

- Static Public Member Functions inherited from DATurbulenceModel
static autoPtr< DATurbulenceModelNew (const word modelType, const fvMesh &mesh, const DAOption &daOption)
 
- Protected Attributes inherited from DATurbulenceModel
const fvMesh & mesh_
 fvMesh More...
 
const DAOptiondaOption_
 DAOption object. More...
 
const dictionary & allOptions_
 all DAFoam options More...
 
DAGlobalVardaGlobalVar_
 global variable More...
 
volScalarField & nut_
 turbulence viscosity More...
 
volVectorField & U_
 velocity More...
 
surfaceScalarField & phi_
 face flux More...
 
volScalarField phase_
 phase field More...
 
surfaceScalarField & phaseRhoPhi_
 phase*phi*density field More...
 
volScalarField rhoOne_
 an uniform rho field with ones More...
 
word turbModelType_ = "None"
 whether the turbulence model is incompressible or compressible More...
 
IOdictionary turbDict_
 turbulence model property dict More...
 
dictionary coeffDict_
 turbulence model parameters dict More...
 
dimensionedScalar kMin_
 Lower limit of k. More...
 
dimensionedScalar epsilonMin_
 Lower limit of epsilon. More...
 
dimensionedScalar omegaMin_
 Lower limit for omega. More...
 
dimensionedScalar nuTildaMin_
 Lower limit for nuTilda. More...
 
scalar Pr_
 Prandtl number. More...
 
scalar Prt_ = -9999.0
 turbulent Prandtl number More...
 

Detailed Description

Definition at line 26 of file DADummyTurbulenceModel.H.

Constructor & Destructor Documentation

◆ DADummyTurbulenceModel()

DADummyTurbulenceModel ( const word  modelType,
const fvMesh &  mesh,
const DAOption daOption 
)

Definition at line 19 of file DADummyTurbulenceModel.C.

◆ ~DADummyTurbulenceModel()

virtual ~DADummyTurbulenceModel ( )
inlinevirtual

Definition at line 42 of file DADummyTurbulenceModel.H.

Member Function Documentation

◆ TypeName()

TypeName ( "dummy"  )

◆ correctModelStates()

void correctModelStates ( wordList &  modelStates) const
virtual

update the turbulence state for DAStateInfo::regStates_

Implements DATurbulenceModel.

Definition at line 29 of file DADummyTurbulenceModel.C.

◆ correctNut()

void correctNut ( )
virtual

update nut based on other turbulence variables and update the BCs

Implements DATurbulenceModel.

Definition at line 51 of file DADummyTurbulenceModel.C.

◆ correctBoundaryConditions()

void correctBoundaryConditions ( )
virtual

update turbulence variable boundary values

Implements DATurbulenceModel.

Definition at line 56 of file DADummyTurbulenceModel.C.

◆ updateIntermediateVariables()

void updateIntermediateVariables ( )
virtual

update any intermediate variables that are dependent on state variables and are used in calcResiduals

Implements DATurbulenceModel.

Definition at line 61 of file DADummyTurbulenceModel.C.

◆ correctStateResidualModelCon()

void correctStateResidualModelCon ( List< List< word >> &  stateCon) const
virtual

update the original variable connectivity for the adjoint state residuals in stateCon

Implements DATurbulenceModel.

Definition at line 66 of file DADummyTurbulenceModel.C.

References forAll().

Here is the call graph for this function:

◆ addModelResidualCon()

void addModelResidualCon ( HashTable< List< List< word >>> &  allCon) const
virtual

add the model residual connectivity to stateCon

Implements DATurbulenceModel.

Definition at line 100 of file DADummyTurbulenceModel.C.

◆ calcResiduals()

void calcResiduals ( const dictionary &  options)
virtual

compute the turbulence residuals

Implements DATurbulenceModel.

Definition at line 110 of file DADummyTurbulenceModel.C.

◆ correct()

void correct ( label  printToScreen)
virtual

solve the residual equations and update the state

Implements DATurbulenceModel.

Definition at line 105 of file DADummyTurbulenceModel.C.


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