RASModelVariables Class Reference

Abstract base class for objective functions. No point in making this runTime selectable since its children will have different constructors. More...

Inheritance diagram for RASModelVariables:

Collaboration diagram for RASModelVariables:

Public Member Functions
	TypeName ("RASModelVariables")
	declareRunTimeSelectionTable (autoPtr, RASModelVariables, dictionary,(const fvMesh &mesh, const solverControl &SolverControl),(mesh, SolverControl))
	RASModelVariables (const fvMesh &mesh, const solverControl &SolverControl)
	RASModelVariables (const RASModelVariables &rmv)
autoPtr< RASModelVariables >	clone () const
virtual	~RASModelVariables ()=default
const word &	TMVar1BaseName () const
const word &	TMVar2BaseName () const
const word &	nutBaseName () const
bool	hasTMVar1 () const
bool	hasTMVar2 () const
bool	hasNut () const
bool	hasDist () const
const volScalarField &	TMVar1 () const
volScalarField &	TMVar1 ()
const volScalarField &	TMVar2 () const
volScalarField &	TMVar2 ()
const volScalarField &	nutRef () const
volScalarField &	nutRef ()
const volScalarField &	d () const
volScalarField &	d ()
const volScalarField &	TMVar1Inst () const
volScalarField &	TMVar1Inst ()
const volScalarField &	TMVar2Inst () const
volScalarField &	TMVar2Inst ()
const volScalarField &	nutRefInst () const
volScalarField &	nutRefInst ()
virtual tmp< volScalarField >	nutJacobianVar1 (const singlePhaseTransportModel &laminarTransport) const
virtual tmp< volScalarField >	nutJacobianVar2 (const singlePhaseTransportModel &laminarTransport) const
void	restoreInitValues ()
void	resetMeanFields ()
void	computeMeanFields ()
tmp< volSymmTensorField >	devReff (const singlePhaseTransportModel &laminarTransport, const volVectorField &U) const
virtual void	correctBoundaryConditions (const incompressible::turbulenceModel &turbulence)
virtual void	transfer (RASModelVariables &rmv)

Static Public Member Functions
static autoPtr< RASModelVariables >	New (const fvMesh &mesh, const solverControl &SolverControl)

Protected Member Functions
void	allocateInitValues ()
void	allocateMeanFields ()
refPtr< volScalarField >	cloneRefPtr (const refPtr< volScalarField > &obj) const
void	copyAndRename (volScalarField &f1, volScalarField &f2)
void	operator= (const RASModelVariables &)=delete

Protected Attributes
const fvMesh &	mesh_
const solverControl &	solverControl_
word	TMVar1BaseName_
word	TMVar2BaseName_
word	nutBaseName_
refPtr< volScalarField >	TMVar1Ptr_
refPtr< volScalarField >	TMVar2Ptr_
refPtr< volScalarField >	nutPtr_
refPtr< volScalarField >	distPtr_
refPtr< volScalarField >	TMVar1InitPtr_
refPtr< volScalarField >	TMVar2InitPtr_
refPtr< volScalarField >	nutInitPtr_
refPtr< volScalarField >	TMVar1MeanPtr_
refPtr< volScalarField >	TMVar2MeanPtr_
refPtr< volScalarField >	nutMeanPtr_

Detailed Description

Abstract base class for objective functions. No point in making this runTime selectable since its children will have different constructors.

Source files

• RASModelVariables.H
• RASModelVariables.C

Definition at line 55 of file RASModelVariables.H.

Constructor & Destructor Documentation

RASModelVariables() [1/2]

RASModelVariables	(	const fvMesh &	mesh,
		const solverControl &	SolverControl
	)

Definition at line 176 of file RASModelVariables.C.

RASModelVariables() [2/2]

RASModelVariables

(

const RASModelVariables &

rmv

)

Definition at line 204 of file RASModelVariables.C.

~RASModelVariables()

virtual ~RASModelVariables ( )

virtualdefault

Member Function Documentation

allocateInitValues()

void allocateInitValues ( )

protected

Definition at line 41 of file RASModelVariables.C.

References Foam::endl(), RASModelVariables::hasNut(), RASModelVariables::hasTMVar1(), RASModelVariables::hasTMVar2(), Foam::Info, Foam::name(), RASModelVariables::nutInitPtr_, RASModelVariables::nutRefInst(), RASModelVariables::solverControl_, solverControl::storeInitValues(), RASModelVariables::TMVar1InitPtr_, RASModelVariables::TMVar1Inst(), RASModelVariables::TMVar2InitPtr_, and RASModelVariables::TMVar2Inst().

Here is the call graph for this function:

allocateMeanFields()

void allocateMeanFields ( )

protected

Definition at line 74 of file RASModelVariables.C.

References IOobject::AUTO_WRITE, solverControl::average(), Foam::endl(), RASModelVariables::hasNut(), RASModelVariables::hasTMVar1(), RASModelVariables::hasTMVar2(), Foam::Info, RASModelVariables::mesh_, Foam::name(), RASModelVariables::nutMeanPtr_, RASModelVariables::nutRefInst(), IOobject::READ_IF_PRESENT, RASModelVariables::solverControl_, fvMesh::time(), Time::timeName(), RASModelVariables::TMVar1Inst(), RASModelVariables::TMVar1MeanPtr_, RASModelVariables::TMVar2Inst(), and RASModelVariables::TMVar2MeanPtr_.

Here is the call graph for this function:

cloneRefPtr()

Foam::refPtr< Foam::volScalarField > cloneRefPtr ( const refPtr< volScalarField > &  obj ) const

protected

Definition at line 141 of file RASModelVariables.C.

References RASModelVariables::mesh_, refPtr::New(), fvMesh::time(), timeName, and Time::timeName().

Here is the call graph for this function:

copyAndRename()

void copyAndRename ( volScalarField &  f1, volScalarField &  f2  )

protected

Definition at line 157 of file RASModelVariables.C.

Referenced by RASModelVariables::transfer().

Here is the caller graph for this function:

operator=()

void operator= ( const RASModelVariables &  )

protecteddelete

TypeName()

TypeName

(

"RASModelVariables"

)

declareRunTimeSelectionTable()

declareRunTimeSelectionTable	(	autoPtr	,
		RASModelVariables	,
		dictionary	,
		(const fvMesh &mesh, const solverControl &SolverControl)	,
		(mesh, SolverControl)
	)

clone()

autoPtr< RASModelVariables > clone

(

)

const

Definition at line 230 of file RASModelVariables.C.

References autoPtr::New().

Here is the call graph for this function:

New()

autoPtr< RASModelVariables > New ( const fvMesh &  mesh, const solverControl &  SolverControl  )

static

Definition at line 239 of file RASModelVariables.C.

References Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, dictionary::findDict(), Foam::Info, mesh, IOobject::MUST_READ_IF_MODIFIED, IOobject::NO_WRITE, dictionary::null, turbulenceModel::propertiesName, and dictionary::readCompat().

Referenced by incompressibleVars::setFields().

Here is the call graph for this function:

Here is the caller graph for this function:

TMVar1BaseName()

const word & TMVar1BaseName ( ) const

inline

Definition at line 31 of file RASModelVariablesI.H.

References RASModelVariables::TMVar1BaseName_.

TMVar2BaseName()

const word & TMVar2BaseName ( ) const

inline

Definition at line 37 of file RASModelVariablesI.H.

References RASModelVariables::TMVar2BaseName_.

nutBaseName()

const word & nutBaseName ( ) const

inline

Definition at line 43 of file RASModelVariablesI.H.

References RASModelVariables::nutBaseName_.

hasTMVar1()

bool hasTMVar1 ( ) const

inline

Definition at line 49 of file RASModelVariablesI.H.

References bool, and RASModelVariables::TMVar1Ptr_.

Referenced by RASModelVariables::allocateInitValues(), RASModelVariables::allocateMeanFields(), RASModelVariables::computeMeanFields(), incompressibleVars::renameTurbulenceFields(), RASModelVariables::restoreInitValues(), and RASModelVariables::transfer().

Here is the caller graph for this function:

hasTMVar2()

bool hasTMVar2 ( ) const

inline

Definition at line 55 of file RASModelVariablesI.H.

References bool, and RASModelVariables::TMVar2Ptr_.

Referenced by RASModelVariables::allocateInitValues(), RASModelVariables::allocateMeanFields(), RASModelVariables::computeMeanFields(), incompressibleVars::renameTurbulenceFields(), RASModelVariables::restoreInitValues(), and RASModelVariables::transfer().

Here is the caller graph for this function:

hasNut()

bool hasNut ( ) const

inline

Definition at line 61 of file RASModelVariablesI.H.

References bool, and RASModelVariables::nutPtr_.

Referenced by RASModelVariables::allocateInitValues(), RASModelVariables::allocateMeanFields(), RASModelVariables::computeMeanFields(), incompressibleVars::renameTurbulenceFields(), RASModelVariables::restoreInitValues(), and RASModelVariables::transfer().

Here is the caller graph for this function:

hasDist()

bool hasDist ( ) const

inline

Definition at line 67 of file RASModelVariablesI.H.

References bool, and RASModelVariables::distPtr_.

Referenced by RASModelVariables::transfer().

Here is the caller graph for this function:

TMVar1() [1/2]

volScalarField & TMVar1 ( ) const

inline

Definition at line 73 of file RASModelVariablesI.H.

References RASModelVariables::solverControl_, RASModelVariables::TMVar1MeanPtr_, RASModelVariables::TMVar1Ptr_, and solverControl::useAveragedFields().

Here is the call graph for this function:

TMVar1() [2/2]

volScalarField& TMVar1 ( )

inline

TMVar2() [1/2]

volScalarField & TMVar2 ( ) const

inline

Definition at line 95 of file RASModelVariablesI.H.

References RASModelVariables::solverControl_, RASModelVariables::TMVar2MeanPtr_, RASModelVariables::TMVar2Ptr_, and solverControl::useAveragedFields().

Here is the call graph for this function:

TMVar2() [2/2]

volScalarField& TMVar2 ( )

inline

nutRef() [1/2]

volScalarField & nutRef ( ) const

inline

Definition at line 115 of file RASModelVariablesI.H.

References RASModelVariables::nutMeanPtr_, RASModelVariables::nutPtr_, RASModelVariables::solverControl_, and solverControl::useAveragedFields().

Here is the call graph for this function:

nutRef() [2/2]

volScalarField& nutRef ( )

inline

d() [1/2]

volScalarField & d ( ) const

inline

Definition at line 137 of file RASModelVariablesI.H.

References RASModelVariables::distPtr_.

Referenced by RASModelVariables::transfer().

Here is the caller graph for this function:

d() [2/2]

volScalarField& d ( )

inline

TMVar1Inst() [1/2]

volScalarField & TMVar1Inst ( ) const

inline

Definition at line 149 of file RASModelVariablesI.H.

References RASModelVariables::TMVar1Ptr_.

Referenced by RASModelVariables::allocateInitValues(), RASModelVariables::allocateMeanFields(), RASModelVariables::computeMeanFields(), incompressibleVars::renameTurbulenceFields(), RASModelVariables::resetMeanFields(), RASModelVariables::restoreInitValues(), and RASModelVariables::transfer().

Here is the caller graph for this function:

TMVar1Inst() [2/2]

volScalarField& TMVar1Inst ( )

inline

TMVar2Inst() [1/2]

volScalarField & TMVar2Inst ( ) const

inline

Definition at line 161 of file RASModelVariablesI.H.

References RASModelVariables::TMVar2Ptr_.

Referenced by RASModelVariables::allocateInitValues(), RASModelVariables::allocateMeanFields(), RASModelVariables::computeMeanFields(), incompressibleVars::renameTurbulenceFields(), RASModelVariables::resetMeanFields(), RASModelVariables::restoreInitValues(), and RASModelVariables::transfer().

Here is the caller graph for this function:

TMVar2Inst() [2/2]

volScalarField& TMVar2Inst ( )

inline

nutRefInst() [1/2]

volScalarField & nutRefInst ( ) const

inline

Definition at line 173 of file RASModelVariablesI.H.

References RASModelVariables::nutPtr_.

Referenced by RASModelVariables::allocateInitValues(), RASModelVariables::allocateMeanFields(), RASModelVariables::computeMeanFields(), incompressibleVars::renameTurbulenceFields(), RASModelVariables::resetMeanFields(), RASModelVariables::restoreInitValues(), and RASModelVariables::transfer().

Here is the caller graph for this function:

nutRefInst() [2/2]

volScalarField& nutRefInst ( )

inline

nutJacobianVar1()

tmp< volScalarField > nutJacobianVar1 ( const singlePhaseTransportModel &  laminarTransport ) const

virtual

Reimplemented in SpalartAllmaras.

Definition at line 293 of file RASModelVariables.C.

References Foam::dimless, Foam::endl(), tmp::New(), IOobject::NO_READ, IOobject::NO_WRITE, WarningInFunction, and Foam::Zero.

Here is the call graph for this function:

nutJacobianVar2()

tmp< volScalarField > nutJacobianVar2 ( const singlePhaseTransportModel &  laminarTransport ) const

virtual

Definition at line 318 of file RASModelVariables.C.

References Foam::dimless, Foam::endl(), tmp::New(), IOobject::NO_READ, IOobject::NO_WRITE, WarningInFunction, and Foam::Zero.

Here is the call graph for this function:

restoreInitValues()

void restoreInitValues

(

)

Definition at line 342 of file RASModelVariables.C.

References RASModelVariables::hasNut(), RASModelVariables::hasTMVar1(), RASModelVariables::hasTMVar2(), RASModelVariables::nutInitPtr_, RASModelVariables::nutRefInst(), RASModelVariables::solverControl_, solverControl::storeInitValues(), RASModelVariables::TMVar1InitPtr_, RASModelVariables::TMVar1Inst(), RASModelVariables::TMVar2InitPtr_, and RASModelVariables::TMVar2Inst().

Here is the call graph for this function:

resetMeanFields()

void resetMeanFields

(

)

Definition at line 362 of file RASModelVariables.C.

References solverControl::average(), Foam::endl(), Foam::Info, RASModelVariables::nutMeanPtr_, RASModelVariables::nutPtr_, RASModelVariables::nutRefInst(), RASModelVariables::solverControl_, RASModelVariables::TMVar1Inst(), RASModelVariables::TMVar1MeanPtr_, RASModelVariables::TMVar1Ptr_, RASModelVariables::TMVar2Inst(), RASModelVariables::TMVar2MeanPtr_, RASModelVariables::TMVar2Ptr_, and Foam::Zero.

Here is the call graph for this function:

computeMeanFields()

void computeMeanFields

(

)

Definition at line 388 of file RASModelVariables.C.

References solverControl::averageIter(), solverControl::doAverageIter(), RASModelVariables::hasNut(), RASModelVariables::hasTMVar1(), RASModelVariables::hasTMVar2(), RASModelVariables::nutMeanPtr_, RASModelVariables::nutRefInst(), RASModelVariables::solverControl_, RASModelVariables::TMVar1Inst(), RASModelVariables::TMVar1MeanPtr_, RASModelVariables::TMVar2Inst(), and RASModelVariables::TMVar2MeanPtr_.

Here is the call graph for this function:

devReff()

tmp< volSymmTensorField > devReff	(	const singlePhaseTransportModel &	laminarTransport,
		const volVectorField &	U
	)		const

Definition at line 417 of file RASModelVariables.C.

References Foam::dev(), Foam::fvc::grad(), laminarTransport(), tmp::New(), IOobject::NO_READ, IOobject::NO_WRITE, Foam::twoSymm(), and U.

Here is the call graph for this function:

correctBoundaryConditions()

void correctBoundaryConditions ( const incompressible::turbulenceModel &  turbulence )

virtual

Reimplemented in kOmegaSST.

Definition at line 438 of file RASModelVariables.C.

Referenced by kOmegaSST::correctBoundaryConditions().

Here is the caller graph for this function:

transfer()

void transfer ( RASModelVariables &  rmv )

virtual

Definition at line 471 of file RASModelVariables.C.

References RASModelVariables::copyAndRename(), RASModelVariables::d(), RASModelVariables::hasDist(), RASModelVariables::hasNut(), RASModelVariables::hasTMVar1(), RASModelVariables::hasTMVar2(), RASModelVariables::nutRefInst(), RASModelVariables::TMVar1Inst(), and RASModelVariables::TMVar2Inst().

Here is the call graph for this function:

Member Data Documentation

mesh_

const fvMesh& mesh_

protected

Definition at line 61 of file RASModelVariables.H.

Referenced by RASModelVariables::allocateMeanFields(), and RASModelVariables::cloneRefPtr().

solverControl_

const solverControl& solverControl_

protected

Definition at line 62 of file RASModelVariables.H.

Referenced by RASModelVariables::allocateInitValues(), RASModelVariables::allocateMeanFields(), RASModelVariables::computeMeanFields(), RASModelVariables::nutRef(), RASModelVariables::resetMeanFields(), RASModelVariables::restoreInitValues(), RASModelVariables::TMVar1(), and RASModelVariables::TMVar2().

TMVar1BaseName_

word TMVar1BaseName_

protected

Definition at line 65 of file RASModelVariables.H.

Referenced by RASModelVariables::TMVar1BaseName().

TMVar2BaseName_

word TMVar2BaseName_

protected

Definition at line 66 of file RASModelVariables.H.

Referenced by RASModelVariables::TMVar2BaseName().

nutBaseName_

word nutBaseName_

protected

Definition at line 67 of file RASModelVariables.H.

Referenced by RASModelVariables::nutBaseName().

TMVar1Ptr_

refPtr<volScalarField> TMVar1Ptr_

protected

Definition at line 69 of file RASModelVariables.H.

Referenced by RASModelVariables::hasTMVar1(), RASModelVariables::resetMeanFields(), RASModelVariables::TMVar1(), and RASModelVariables::TMVar1Inst().

TMVar2Ptr_

refPtr<volScalarField> TMVar2Ptr_

protected

Definition at line 70 of file RASModelVariables.H.

Referenced by RASModelVariables::hasTMVar2(), RASModelVariables::resetMeanFields(), RASModelVariables::TMVar2(), and RASModelVariables::TMVar2Inst().

nutPtr_

refPtr<volScalarField> nutPtr_

protected

Definition at line 71 of file RASModelVariables.H.

Referenced by RASModelVariables::hasNut(), RASModelVariables::nutRef(), RASModelVariables::nutRefInst(), and RASModelVariables::resetMeanFields().

distPtr_

refPtr<volScalarField> distPtr_

protected

Definition at line 72 of file RASModelVariables.H.

Referenced by RASModelVariables::d(), and RASModelVariables::hasDist().

TMVar1InitPtr_

refPtr<volScalarField> TMVar1InitPtr_

protected

Definition at line 76 of file RASModelVariables.H.

Referenced by RASModelVariables::allocateInitValues(), and RASModelVariables::restoreInitValues().

TMVar2InitPtr_

refPtr<volScalarField> TMVar2InitPtr_

protected

Definition at line 77 of file RASModelVariables.H.

Referenced by RASModelVariables::allocateInitValues(), and RASModelVariables::restoreInitValues().

nutInitPtr_

refPtr<volScalarField> nutInitPtr_

protected

Definition at line 78 of file RASModelVariables.H.

Referenced by RASModelVariables::allocateInitValues(), and RASModelVariables::restoreInitValues().

TMVar1MeanPtr_

refPtr<volScalarField> TMVar1MeanPtr_

protected

Definition at line 81 of file RASModelVariables.H.

Referenced by RASModelVariables::allocateMeanFields(), RASModelVariables::computeMeanFields(), RASModelVariables::resetMeanFields(), and RASModelVariables::TMVar1().

TMVar2MeanPtr_

refPtr<volScalarField> TMVar2MeanPtr_

protected

Definition at line 82 of file RASModelVariables.H.

Referenced by RASModelVariables::allocateMeanFields(), RASModelVariables::computeMeanFields(), RASModelVariables::resetMeanFields(), and RASModelVariables::TMVar2().

nutMeanPtr_

refPtr<volScalarField> nutMeanPtr_

protected

Definition at line 83 of file RASModelVariables.H.

Referenced by RASModelVariables::allocateMeanFields(), RASModelVariables::computeMeanFields(), RASModelVariables::nutRef(), and RASModelVariables::resetMeanFields().

---

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

• src/optimisation/adjointOptimisation/adjoint/turbulenceModels/turbulenceModelVariables/RAS/RASModelVariables/RASModelVariables.H
• src/optimisation/adjointOptimisation/adjoint/turbulenceModels/turbulenceModelVariables/RAS/RASModelVariables/RASModelVariables.C
• src/optimisation/adjointOptimisation/adjoint/turbulenceModels/turbulenceModelVariables/RAS/RASModelVariables/RASModelVariablesI.H