List of all members
DASpalartAllmarasFv3 Class Reference
Inheritance diagram for DASpalartAllmarasFv3:
Inheritance graph
[legend]
Collaboration diagram for DASpalartAllmarasFv3:
Collaboration graph
[legend]

Protected Member Functions

SA functions
tmp< volScalarField > chi () const
 
tmp< volScalarField > fv1 (const volScalarField &chi) const
 
tmp< volScalarField > fv2 (const volScalarField &chi, const volScalarField &fv1) const
 
tmp< volScalarField > fv3 (const volScalarField &chi, const volScalarField &fv1) const
 
tmp< volScalarField > fw (const volScalarField &Stilda) const
 

Protected Attributes

SA parameters
dimensionedScalar sigmaNut_
 
dimensionedScalar kappa_
 
dimensionedScalar Cb1_
 
dimensionedScalar Cb2_
 
dimensionedScalar Cw1_
 
dimensionedScalar Cw2_
 
dimensionedScalar Cw3_
 
dimensionedScalar Cv1_
 
dimensionedScalar Cv2_
 
- 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...
 

Augmented variables for residual computation

volScalarField & nuTilda_
 
volScalarField nuTildaRes_
 
volScalarField pseudoNuTilda_
 pseudoNuTilda_ and pseudoNuTildaEqn_ for solving adjoint equation More...
 
fvScalarMatrix pseudoNuTildaEqn_
 
const volScalarField & y_
 3D wall distance More...
 
volScalarField betaFINuTilda_
 beta field for field inversion More...
 
label solveTurbState_ = 0
 whether to solve for turb states More...
 
scalar relaxNuTildaEqn_ = 1.0
 
dictionary solverDictNuTilda_
 
 TypeName ("SpalartAllmarasFv3")
 
 DASpalartAllmarasFv3 (const word modelType, const fvMesh &mesh, const DAOption &daOption)
 
virtual ~DASpalartAllmarasFv3 ()
 
tmp< volScalarField > DnuTildaEff () const
 Return the effective diffusivity for nuTilda. More...
 
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...
 
virtual void invTranProdNuTildaEqn (const volScalarField &mySource, volScalarField &pseudoNuTilda)
 Inverse transpose product, A_nuTilda^(-T) More...
 
virtual void constructPseudoNuTildaEqn ()
 construct pseudoNuTildaEqn_, which is nuTildaEqn with swapped upper and lower arrays More...
 
virtual void rhsSolvePseudoNuTildaEqn (const volScalarField &nuTildaSource)
 solve pseudoNuTildaEqn_ with overwritten rhs More...
 
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 getTurbProdOverDestruct (volScalarField &PoD) const
 return the value of the 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...
 

Additional Inherited Members

- 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...
 
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 solveAdjointFP (const word varName, const scalarList &rhs, scalarList &dPsi)
 solve the fvMatrixT field with given rhs and solution More...
 
- Static Public Member Functions inherited from DATurbulenceModel
static autoPtr< DATurbulenceModelNew (const word modelType, const fvMesh &mesh, const DAOption &daOption)
 

Detailed Description

Definition at line 48 of file DASpalartAllmarasFv3.H.

Constructor & Destructor Documentation

◆ DASpalartAllmarasFv3()

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

◆ ~DASpalartAllmarasFv3()

virtual ~DASpalartAllmarasFv3 ( )
inlinevirtual

Definition at line 118 of file DASpalartAllmarasFv3.H.

Member Function Documentation

◆ chi()

tmp< volScalarField > chi ( ) const
protected

◆ fv1()

tmp< volScalarField > fv1 ( const volScalarField &  chi) const
protected

◆ fv2()

tmp< volScalarField > fv2 ( const volScalarField &  chi,
const volScalarField &  fv1 
) const
protected

◆ fv3()

tmp< volScalarField > fv3 ( const volScalarField &  chi,
const volScalarField &  fv1 
) const
protected

◆ fw()

tmp< volScalarField > fw ( const volScalarField &  Stilda) const
protected

◆ TypeName()

TypeName ( "SpalartAllmarasFv3"  )

◆ DnuTildaEff()

tmp< volScalarField > DnuTildaEff ( ) const

Return the effective diffusivity for nuTilda.

Definition at line 196 of file DASpalartAllmarasFv3.C.

References DATurbulenceModel::nu(), DASpalartAllmarasFv3::nuTilda_, and DASpalartAllmarasFv3::sigmaNut_.

Referenced by DASpalartAllmarasFv3::calcLduResidualTurb(), DASpalartAllmarasFv3::calcResiduals(), DASpalartAllmarasFv3::constructPseudoNuTildaEqn(), and DASpalartAllmarasFv3::getFvMatrixFields().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ correctModelStates()

void correctModelStates ( wordList &  modelStates) const
virtual

update the turbulence state for DAStateInfo::regStates_

Implements DATurbulenceModel.

Definition at line 203 of file DASpalartAllmarasFv3.C.

References forAll().

Here is the call graph for this function:

◆ correctNut()

void correctNut ( )
virtual

update nut based on other turbulence variables and update the BCs

Implements DATurbulenceModel.

Definition at line 237 of file DASpalartAllmarasFv3.C.

References DASpalartAllmarasFv3::chi(), DATurbulenceModel::correctAlphat(), DASpalartAllmarasFv3::fv1(), DATurbulenceModel::nut_, and DASpalartAllmarasFv3::nuTilda_.

Referenced by DASpalartAllmarasFv3::calcResiduals(), and DASpalartAllmarasFv3::updateIntermediateVariables().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ correctBoundaryConditions()

void correctBoundaryConditions ( )
virtual

update turbulence variable boundary values

Implements DATurbulenceModel.

Definition at line 257 of file DASpalartAllmarasFv3.C.

References DASpalartAllmarasFv3::nuTilda_.

◆ updateIntermediateVariables()

void updateIntermediateVariables ( )
virtual

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

Implements DATurbulenceModel.

Definition at line 268 of file DASpalartAllmarasFv3.C.

References DASpalartAllmarasFv3::correctNut().

Here is the call graph for this function:

◆ 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 279 of file DASpalartAllmarasFv3.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 329 of file DASpalartAllmarasFv3.C.

References DATurbulenceModel::mesh_, and DATurbulenceModel::turbModelType_.

◆ calcResiduals()

void calcResiduals ( const dictionary &  options)
virtual

◆ correct()

void correct ( label  printToScreen)
virtual

solve the residual equations and update the state

Implements DATurbulenceModel.

Definition at line 408 of file DASpalartAllmarasFv3.C.

References DASpalartAllmarasFv3::calcResiduals(), and DASpalartAllmarasFv3::solveTurbState_.

Here is the call graph for this function:

◆ invTranProdNuTildaEqn()

void invTranProdNuTildaEqn ( const volScalarField &  mySource,
volScalarField &  pseudoNuTilda 
)
virtual

Inverse transpose product, A_nuTilda^(-T)

Reimplemented from DATurbulenceModel.

Definition at line 513 of file DASpalartAllmarasFv3.C.

◆ constructPseudoNuTildaEqn()

void constructPseudoNuTildaEqn ( )
virtual

◆ rhsSolvePseudoNuTildaEqn()

void rhsSolvePseudoNuTildaEqn ( const volScalarField &  nuTildaSource)
virtual

solve pseudoNuTildaEqn_ with overwritten rhs

Reimplemented from DATurbulenceModel.

Definition at line 626 of file DASpalartAllmarasFv3.C.

References forAll(), DASpalartAllmarasFv3::pseudoNuTilda_, DASpalartAllmarasFv3::pseudoNuTildaEqn_, and DASpalartAllmarasFv3::solverDictNuTilda_.

Here is the call graph for this function:

◆ calcLduResidualTurb()

void calcLduResidualTurb ( volScalarField &  nuTildaRes)
virtual

◆ getFvMatrixFields()

void getFvMatrixFields ( const word  varName,
scalarField &  diag,
scalarField &  upper,
scalarField &  lower 
)
virtual

◆ getTurbProdOverDestruct()

void getTurbProdOverDestruct ( volScalarField &  PoD) const
virtual

◆ getTurbConvOverProd()

void getTurbConvOverProd ( volScalarField &  CoP) const
virtual

Member Data Documentation

◆ sigmaNut_

dimensionedScalar sigmaNut_
protected

◆ kappa_

dimensionedScalar kappa_
protected

◆ Cb1_

dimensionedScalar Cb1_
protected

◆ Cb2_

dimensionedScalar Cb2_
protected

◆ Cw1_

dimensionedScalar Cw1_
protected

◆ Cw2_

dimensionedScalar Cw2_
protected

Definition at line 60 of file DASpalartAllmarasFv3.H.

Referenced by DASpalartAllmarasFv3::fw().

◆ Cw3_

dimensionedScalar Cw3_
protected

Definition at line 61 of file DASpalartAllmarasFv3.H.

Referenced by DASpalartAllmarasFv3::fw().

◆ Cv1_

dimensionedScalar Cv1_
protected

Definition at line 62 of file DASpalartAllmarasFv3.H.

Referenced by DASpalartAllmarasFv3::fv1().

◆ Cv2_

dimensionedScalar Cv2_
protected

Definition at line 63 of file DASpalartAllmarasFv3.H.

Referenced by DASpalartAllmarasFv3::fv2(), and DASpalartAllmarasFv3::fv3().

◆ nuTilda_

volScalarField& nuTilda_
protected

◆ nuTildaRes_

volScalarField nuTildaRes_
protected

◆ pseudoNuTilda_

volScalarField pseudoNuTilda_
protected

pseudoNuTilda_ and pseudoNuTildaEqn_ for solving adjoint equation

Definition at line 91 of file DASpalartAllmarasFv3.H.

Referenced by DASpalartAllmarasFv3::constructPseudoNuTildaEqn(), and DASpalartAllmarasFv3::rhsSolvePseudoNuTildaEqn().

◆ pseudoNuTildaEqn_

fvScalarMatrix pseudoNuTildaEqn_
protected

◆ y_

const volScalarField& y_
protected

◆ betaFINuTilda_

volScalarField betaFINuTilda_
protected

◆ solveTurbState_

label solveTurbState_ = 0
protected

whether to solve for turb states

Definition at line 101 of file DASpalartAllmarasFv3.H.

Referenced by DASpalartAllmarasFv3::calcResiduals(), and DASpalartAllmarasFv3::correct().

◆ relaxNuTildaEqn_

scalar relaxNuTildaEqn_ = 1.0
protected

◆ solverDictNuTilda_

dictionary solverDictNuTilda_
protected

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