Inheritance diagram for DASpalartAllmaras:

Collaboration diagram for DASpalartAllmaras:

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 >	Stilda (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	Cs_

Protected Attributes inherited from DATurbulenceModel
const fvMesh &	mesh_
	fvMesh More...

const DAOption &	daOption_
	DAOption object. More...

const dictionary &	allOptions_
	all DAFoam options More...

DAGlobalVar &	daGlobalVar_
	global variable More...

volScalarField &	nut_
	turbulence viscosity More...

volVectorField &	U_
	velocity More...

surfaceScalarField &	phi_
	face flux More...

volScalarField	phase_
	phase field More...

surfaceScalarField &	phaseRhoPhi_
	phasephidensity 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_

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

autoPtr< fvScalarMatrix >	psiNuTildaPC_

volScalarField	dPsiNuTilda_

	TypeName ("SpalartAllmaras")

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

virtual	~DASpalartAllmaras ()

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

virtual void	solveAdjointFP (const word varName, const scalarList &rhs, scalarList &dPsi)
	solve the fvMatrixT field with given rhs and solution 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	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...

Static Public Member Functions inherited from DATurbulenceModel
static autoPtr< DATurbulenceModel >	New (const word modelType, const fvMesh &mesh, const DAOption &daOption)

Detailed Description

Definition at line 48 of file DASpalartAllmaras.H.

Constructor & Destructor Documentation

◆ DASpalartAllmaras()

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

Definition at line 41 of file DASpalartAllmaras.C.

References DASpalartAllmaras::nuTildaRes_, and DATurbulenceModel::turbModelType_.

◆ ~DASpalartAllmaras()

virtual ~DASpalartAllmaras ( )

inlinevirtual

Definition at line 114 of file DASpalartAllmaras.H.

Member Function Documentation

◆ chi()

tmp< volScalarField > chi ( ) const

protected

Definition at line 124 of file DASpalartAllmaras.C.

References DATurbulenceModel::nu(), and DASpalartAllmaras::nuTilda_.

Referenced by DASpalartAllmaras::calcResiduals(), DASpalartAllmaras::correctNut(), DASpalartAllmaras::fv1(), DASpalartAllmaras::fv2(), DASpalartAllmaras::getFvMatrixFields(), DASpalartAllmaras::getTurbConvOverProd(), DASpalartAllmaras::getTurbProdOverDestruct(), DASpalartAllmaras::solveAdjointFP(), and DASpalartAllmaras::Stilda().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fv1()

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

protected

Definition at line 129 of file DASpalartAllmaras.C.

References DASpalartAllmaras::chi(), and DASpalartAllmaras::Cv1_.

Referenced by DASpalartAllmaras::calcResiduals(), DASpalartAllmaras::correctNut(), DASpalartAllmaras::fv2(), DASpalartAllmaras::getFvMatrixFields(), DASpalartAllmaras::getTurbConvOverProd(), DASpalartAllmaras::getTurbProdOverDestruct(), DASpalartAllmaras::solveAdjointFP(), and DASpalartAllmaras::Stilda().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fv2()

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

protected

Definition at line 136 of file DASpalartAllmaras.C.

References DASpalartAllmaras::chi(), and DASpalartAllmaras::fv1().

Referenced by DASpalartAllmaras::Stilda().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Stilda()

tmp< volScalarField > Stilda	(	const volScalarField &	chi,
		const volScalarField &	fv1
	)		const

protected

Definition at line 143 of file DASpalartAllmaras.C.

References DASpalartAllmaras::chi(), DASpalartAllmaras::Cs_, DASpalartAllmaras::fv1(), DASpalartAllmaras::fv2(), DASpalartAllmaras::kappa_, DASpalartAllmaras::nuTilda_, DATurbulenceModel::U_, and DASpalartAllmaras::y_.

Referenced by DASpalartAllmaras::calcResiduals(), DASpalartAllmaras::fw(), DASpalartAllmaras::getFvMatrixFields(), DASpalartAllmaras::getTurbConvOverProd(), DASpalartAllmaras::getTurbProdOverDestruct(), and DASpalartAllmaras::solveAdjointFP().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fw()

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

protected

Definition at line 156 of file DASpalartAllmaras.C.

References DASpalartAllmaras::Cw2_, DASpalartAllmaras::Cw3_, DASpalartAllmaras::kappa_, DASpalartAllmaras::nuTilda_, DASpalartAllmaras::Stilda(), and DASpalartAllmaras::y_.

Referenced by DASpalartAllmaras::calcResiduals(), DASpalartAllmaras::getFvMatrixFields(), DASpalartAllmaras::getTurbProdOverDestruct(), and DASpalartAllmaras::solveAdjointFP().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "SpalartAllmaras" )

◆ DnuTildaEff()

tmp< volScalarField > DnuTildaEff ( ) const

Return the effective diffusivity for nuTilda.

Definition at line 174 of file DASpalartAllmaras.C.

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

Referenced by DASpalartAllmaras::calcResiduals(), DASpalartAllmaras::getFvMatrixFields(), and DASpalartAllmaras::solveAdjointFP().

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 181 of file DASpalartAllmaras.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 215 of file DASpalartAllmaras.C.

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

Referenced by DASpalartAllmaras::calcResiduals(), and DASpalartAllmaras::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 235 of file DASpalartAllmaras.C.

References DASpalartAllmaras::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 246 of file DASpalartAllmaras.C.

References DASpalartAllmaras::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 257 of file DASpalartAllmaras.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 307 of file DASpalartAllmaras.C.

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

◆ calcResiduals()

void calcResiduals ( const dictionary & options )

virtual

compute the turbulence residuals

Implements DATurbulenceModel.

Definition at line 407 of file DASpalartAllmaras.C.

Referenced by DASpalartAllmaras::correct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ correct()

void correct ( label printToScreen )

virtual

solve the residual equations and update the state

Implements DATurbulenceModel.

Definition at line 386 of file DASpalartAllmaras.C.

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

Here is the call graph for this function:

◆ getFvMatrixFields()

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

virtual

return the diag(), upper(), and lower() scalarFields from the turbulence model's fvMatrix

Reimplemented from DATurbulenceModel.

Definition at line 490 of file DASpalartAllmaras.C.

References DASpalartAllmaras::betaFINuTilda_, DASpalartAllmaras::Cb1_, DASpalartAllmaras::Cb2_, DASpalartAllmaras::chi(), DASpalartAllmaras::Cw1_, DASpalartAllmaras::DnuTildaEff(), DASpalartAllmaras::fv1(), DASpalartAllmaras::fw(), DASpalartAllmaras::nuTilda_, DATurbulenceModel::phase_, DATurbulenceModel::phaseRhoPhi_, DATurbulenceModel::rho(), DASpalartAllmaras::sigmaNut_, DASpalartAllmaras::Stilda(), and DASpalartAllmaras::y_.

Here is the call graph for this function:

◆ getTurbProdOverDestruct()

void getTurbProdOverDestruct ( volScalarField & PoD ) const

virtual

return the value of the destruction term from the turbulence model

Reimplemented from DATurbulenceModel.

Definition at line 601 of file DASpalartAllmaras.C.

References DASpalartAllmaras::Cb1_, DASpalartAllmaras::chi(), DASpalartAllmaras::Cw1_, D, forAll(), DASpalartAllmaras::fv1(), DASpalartAllmaras::fw(), DASpalartAllmaras::nuTilda_, DATurbulenceModel::phase_, DATurbulenceModel::rho(), DASpalartAllmaras::Stilda(), and DASpalartAllmaras::y_.

Here is the call graph for this function:

◆ getTurbConvOverProd()

void getTurbConvOverProd ( volScalarField & CoP ) const

virtual

return the value of the convective over production term from the turbulence model

Reimplemented from DATurbulenceModel.

Definition at line 624 of file DASpalartAllmaras.C.

References DASpalartAllmaras::Cb1_, DASpalartAllmaras::chi(), forAll(), DASpalartAllmaras::fv1(), DASpalartAllmaras::nuTilda_, DATurbulenceModel::phase_, DATurbulenceModel::phaseRhoPhi_, DATurbulenceModel::rho(), and DASpalartAllmaras::Stilda().

Here is the call graph for this function:

◆ solveAdjointFP()

void solveAdjointFP	(	const word	varName,
		const scalarList &	rhs,
		scalarList &	dPsi
	)

virtual

solve the fvMatrixT field with given rhs and solution

Reimplemented from DATurbulenceModel.

Definition at line 531 of file DASpalartAllmaras.C.

References DASpalartAllmaras::Cb2_, DASpalartAllmaras::chi(), DASpalartAllmaras::Cw1_, DASpalartAllmaras::DnuTildaEff(), DASpalartAllmaras::dPsiNuTilda_, forAll(), DASpalartAllmaras::fv1(), DASpalartAllmaras::fw(), DATurbulenceModel::mesh_, DASpalartAllmaras::nuTilda_, DATurbulenceModel::phase_, DATurbulenceModel::phaseRhoPhi_, DASpalartAllmaras::psiNuTildaPC_, DATurbulenceModel::rho(), DASpalartAllmaras::sigmaNut_, DASpalartAllmaras::Stilda(), and DASpalartAllmaras::y_.

Here is the call graph for this function:

Member Data Documentation

◆ sigmaNut_

dimensionedScalar sigmaNut_

protected

Definition at line 55 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::calcResiduals(), DASpalartAllmaras::DnuTildaEff(), DASpalartAllmaras::getFvMatrixFields(), and DASpalartAllmaras::solveAdjointFP().

◆ kappa_

dimensionedScalar kappa_

protected

Definition at line 56 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::fw(), and DASpalartAllmaras::Stilda().

◆ Cb1_

dimensionedScalar Cb1_

protected

Definition at line 57 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::calcResiduals(), DASpalartAllmaras::getFvMatrixFields(), DASpalartAllmaras::getTurbConvOverProd(), and DASpalartAllmaras::getTurbProdOverDestruct().

◆ Cb2_

dimensionedScalar Cb2_

protected

Definition at line 58 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::calcResiduals(), DASpalartAllmaras::getFvMatrixFields(), and DASpalartAllmaras::solveAdjointFP().

◆ Cw1_

dimensionedScalar Cw1_

protected

Definition at line 59 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::calcResiduals(), DASpalartAllmaras::getFvMatrixFields(), DASpalartAllmaras::getTurbProdOverDestruct(), and DASpalartAllmaras::solveAdjointFP().

◆ Cw2_

dimensionedScalar Cw2_

protected

Definition at line 60 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::fw().

◆ Cw3_

dimensionedScalar Cw3_

protected

Definition at line 61 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::fw().

◆ Cv1_

dimensionedScalar Cv1_

protected

Definition at line 62 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::fv1().

◆ Cs_

dimensionedScalar Cs_

protected

Definition at line 63 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::Stilda().

◆ nuTilda_

volScalarField& nuTilda_

protected

Definition at line 86 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::calcResiduals(), DASpalartAllmaras::chi(), DASpalartAllmaras::correctBoundaryConditions(), DASpalartAllmaras::correctNut(), DASpalartAllmaras::DnuTildaEff(), DASpalartAllmaras::fw(), DASpalartAllmaras::getFvMatrixFields(), DASpalartAllmaras::getTurbConvOverProd(), DASpalartAllmaras::getTurbProdOverDestruct(), DASpalartAllmaras::solveAdjointFP(), and DASpalartAllmaras::Stilda().

◆ nuTildaRes_

volScalarField nuTildaRes_

protected

Definition at line 87 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::calcResiduals(), and DASpalartAllmaras::DASpalartAllmaras().

◆ y_

const volScalarField& y_

protected

3D wall distance

Definition at line 91 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::calcResiduals(), DASpalartAllmaras::fw(), DASpalartAllmaras::getFvMatrixFields(), DASpalartAllmaras::getTurbProdOverDestruct(), DASpalartAllmaras::solveAdjointFP(), and DASpalartAllmaras::Stilda().

◆ betaFINuTilda_

volScalarField betaFINuTilda_

protected

beta field for field inversion

Definition at line 94 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::calcResiduals(), and DASpalartAllmaras::getFvMatrixFields().

◆ solveTurbState_

label solveTurbState_ = 0

protected

whether to solve for turb states

Definition at line 97 of file DASpalartAllmaras.H.

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

◆ psiNuTildaPC_

autoPtr<fvScalarMatrix> psiNuTildaPC_

protected

Definition at line 99 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::solveAdjointFP().

◆ dPsiNuTilda_

volScalarField dPsiNuTilda_

protected

Definition at line 101 of file DASpalartAllmaras.H.

Referenced by DASpalartAllmaras::solveAdjointFP().

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

dafoam/src/adjoint/DAModel/DATurbulenceModel/DASpalartAllmaras.H
dafoam/src/adjoint/DAModel/DATurbulenceModel/DASpalartAllmaras.C

Protected Member Functions

Protected Attributes

Augmented variables for residual computation

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DASpalartAllmaras()

◆ ~DASpalartAllmaras()

Member Function Documentation

◆ chi()

◆ fv1()

◆ fv2()

◆ Stilda()

◆ fw()

◆ TypeName()

◆ DnuTildaEff()

◆ correctModelStates()

◆ correctNut()

◆ correctBoundaryConditions()

◆ updateIntermediateVariables()

◆ correctStateResidualModelCon()

◆ addModelResidualCon()

◆ calcResiduals()

◆ correct()

◆ getFvMatrixFields()

◆ getTurbProdOverDestruct()

◆ getTurbConvOverProd()

◆ solveAdjointFP()

Member Data Documentation

◆ sigmaNut_

◆ kappa_

◆ Cb1_

◆ Cb2_

◆ Cw1_

◆ Cw2_

◆ Cw3_

◆ Cv1_

◆ Cs_

◆ nuTilda_

◆ nuTildaRes_

◆ y_

◆ betaFINuTilda_

◆ solveTurbState_

◆ psiNuTildaPC_

◆ dPsiNuTilda_