Loading...
Searching...
No Matches
incompressibleAdjointMeanFlowVars Class Reference

Manages the adjoint mean flow fields and their mean values. More...

#include <incompressibleAdjointMeanFlowVars.H>

Inheritance diagram for incompressibleAdjointMeanFlowVars:
Inheritance graph
[legend]
Collaboration diagram for incompressibleAdjointMeanFlowVars:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("incompressibleAdjointMeanFlowVars")
 Run-time type information.
 incompressibleAdjointMeanFlowVars (fvMesh &mesh, solverControl &SolverControl, incompressibleVars &primalVars)
 Construct from mesh.
virtual ~incompressibleAdjointMeanFlowVars ()=default
 Destructor.
const incompressibleVars & primalVars () const
const volScalarField & pa () const
 Return const reference to pressure.
volScalarField & pa ()
 Return reference to pressure.
const volVectorField & Ua () const
 Return const reference to velocity.
volVectorField & Ua ()
 Return reference to velocity.
const surfaceScalarField & phia () const
 Return const reference to volume flux.
surfaceScalarField & phia ()
 Return reference to volume flux.
const volScalarField & paInst () const
 Return const reference to pressure.
volScalarField & paInst ()
 Return reference to pressure.
const volVectorField & UaInst () const
 Return const reference to velocity.
volVectorField & UaInst ()
 Return reference to velocity.
const surfaceScalarField & phiaInst () const
 Return const reference to volume flux.
surfaceScalarField & phiaInst ()
 Return reference to volume flux.
bool computeMeanFields () const
 Return computeMeanFields bool.
const solverControl & getSolverControl () const
 Return const reference to solverControl.
virtual void nullify ()
 Nullify all adjoint fields.
Public Member Functions inherited from variablesSet
 TypeName ("variablesSet")
 Run-time type information.
 variablesSet (fvMesh &mesh, const dictionary &dict)
 Construct from mesh and solver name.
virtual autoPtr< variablesSet > clone () const
 Clone the variablesSet.
virtual ~variablesSet ()=default
 Destructor.
const word & solverName () const
 Return solver name.
bool useSolverNameForFields () const
 Append solver name to fields?
template<class Type>
tmp< GeometricField< Type, fvPatchField, volMesh > > allocateField (const fvMesh &mesh, const word &baseName, const word &solverName, const bool useSolverNameForFields)
template<class Type>
void renameTurbulenceField (GeometricField< Type, fvPatchField, volMesh > &baseField, const word &solverName)
 Turbulence model always reads fields with the prescribed name If a custom name is supplied, check whether this field exists, copy it to the field known by the turbulence model and re-name the latter.
tmp< surfaceScalarField > allocateFluxField (const fvMesh &mesh, const volVectorField &velocity, const word &baseName, const word &solverName, const bool useSolverNameForFields)
virtual void transfer (variablesSet &vars)
 Transfer the fields of another variablesSet to this.

Protected Member Functions

void setFields ()
 Read fields and set turbulence.
void setMeanFields ()
 Read mean fields, if necessary.
Protected Member Functions inherited from variablesSet
template<class Type, template< class > class PatchField, class GeoMesh>
autoPtr< GeometricField< Type, PatchField, GeoMesh > > allocateRenamedField (const autoPtr< GeometricField< Type, PatchField, GeoMesh > > &bf)
template<class Type, template< class > class PatchField, class GeoMesh>
void swapAndRename (autoPtr< GeometricField< Type, PatchField, GeoMesh > > &p1, autoPtr< GeometricField< Type, PatchField, GeoMesh > > &p2)
 Swap autoPtrs and rename managed fields.

Protected Attributes

solverControl & solverControl_
 Reference to the solverControl of the solver allocating the fields.
incompressibleVars & primalVars_
 Reference to primal variables.
autoPtr< volScalarField > paPtr_
 Fields involved in the solution of the incompressible adjoint NS equations.
autoPtr< volVectorField > UaPtr_
autoPtr< surfaceScalarField > phiaPtr_
autoPtr< volScalarField > paMeanPtr_
 Mean Adjoint Fields. Actual averaging is done in the incompressibleAdjointVars class to take care of the mean adjoint turbulence variables.
autoPtr< volVectorField > UaMeanPtr_
autoPtr< surfaceScalarField > phiaMeanPtr_
Protected Attributes inherited from variablesSet
fvMesh & mesh_
 Reference to the mesh database.
word solverName_
 Solver name owning the variables set.
bool useSolverNameForFields_
 Append the solver name to the variables names?

Additional Inherited Members

Static Public Member Functions inherited from variablesSet
template<class Type>
static void setField (autoPtr< GeometricField< Type, fvPatchField, volMesh > > &fieldPtr, const fvMesh &mesh, const word &baseName, const word &solverName, const bool useSolverNameForFields)
 Read vol fields.
static void setFluxField (autoPtr< surfaceScalarField > &fieldPtr, const fvMesh &mesh, const volVectorField &velocity, const word &baseName, const word &solverName, const bool useSolverNameForFields)
 Set flux field.
static tmp< volVectorField > autoCreateMeshMovementField (const fvMesh &mesh, const word &name, const dimensionSet &dims)
 Auto create variable for mesh movement.
template<class Type, template< class > class PatchField, class GeoMesh>
static void nullifyField (GeometricField< Type, PatchField, GeoMesh > &fieldPtr)
 Nullify field and old times, if present.

Detailed Description

Manages the adjoint mean flow fields and their mean values.

Definition at line 45 of file incompressibleAdjointMeanFlowVars.H.

Constructor & Destructor Documentation

◆ incompressibleAdjointMeanFlowVars()

incompressibleAdjointMeanFlowVars ( fvMesh & mesh,
solverControl & SolverControl,
incompressibleVars & primalVars )

Construct from mesh.

Definition at line 115 of file incompressibleAdjointMeanFlowVars.C.

References mesh, paMeanPtr_, paPtr_, phiaMeanPtr_, phiaPtr_, primalVars(), primalVars_, setFields(), setMeanFields(), solverControl_, UaMeanPtr_, and UaPtr_.

Here is the call graph for this function:

◆ ~incompressibleAdjointMeanFlowVars()

virtual ~incompressibleAdjointMeanFlowVars ( )
virtualdefault

Destructor.

Member Function Documentation

◆ setFields()

void setFields ( )
protected

Read fields and set turbulence.

Definition at line 36 of file incompressibleAdjointMeanFlowVars.C.

References variablesSet::mesh_, paPtr_, phiaPtr_, variablesSet::setField(), variablesSet::setFluxField(), variablesSet::solverName_, UaInst(), UaPtr_, and variablesSet::useSolverNameForFields_.

Referenced by incompressibleAdjointMeanFlowVars().

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

◆ setMeanFields()

void setMeanFields ( )
protected

Read mean fields, if necessary.

Definition at line 54 of file incompressibleAdjointMeanFlowVars.C.

References IOobjectOption::AUTO_WRITE, Foam::endl(), Foam::Info, variablesSet::mesh_, name, paInst(), paMeanPtr_, phiaInst(), phiaMeanPtr_, IOobjectOption::READ_IF_PRESENT, IOobjectOption::REGISTER, solverControl_, UaInst(), and UaMeanPtr_.

Referenced by incompressibleAdjointMeanFlowVars().

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

◆ TypeName()

TypeName ( "incompressibleAdjointMeanFlowVars" )

Run-time type information.

References mesh, and primalVars().

Here is the call graph for this function:

◆ primalVars()

const incompressibleVars & primalVars ( ) const

Definition at line 139 of file incompressibleAdjointMeanFlowVars.C.

References primalVars_.

Referenced by incompressibleAdjointMeanFlowVars(), incompressibleAdjointVars::incompressibleAdjointVars(), TypeName(), and incompressibleAdjointVars::TypeName().

Here is the caller graph for this function:

◆ pa() [1/2]

const volScalarField & pa ( ) const

Return const reference to pressure.

Definition at line 144 of file incompressibleAdjointMeanFlowVars.C.

References paMeanPtr_, paPtr_, and solverControl_.

◆ pa() [2/2]

volScalarField & pa ( )

Return reference to pressure.

Definition at line 157 of file incompressibleAdjointMeanFlowVars.C.

References paMeanPtr_, paPtr_, and solverControl_.

◆ Ua() [1/2]

const volVectorField & Ua ( ) const

Return const reference to velocity.

Definition at line 170 of file incompressibleAdjointMeanFlowVars.C.

References solverControl_, UaMeanPtr_, and UaPtr_.

Referenced by incompressibleAdjointSolver::hasBCdxdbMult(), and incompressibleAdjointSolver::topOSensMultiplier().

Here is the caller graph for this function:

◆ Ua() [2/2]

volVectorField & Ua ( )

Return reference to velocity.

Definition at line 183 of file incompressibleAdjointMeanFlowVars.C.

References solverControl_, UaMeanPtr_, and UaPtr_.

◆ phia() [1/2]

const surfaceScalarField & phia ( ) const

Return const reference to volume flux.

Definition at line 196 of file incompressibleAdjointMeanFlowVars.C.

References phiaMeanPtr_, phiaPtr_, and solverControl_.

◆ phia() [2/2]

surfaceScalarField & phia ( )

Return reference to volume flux.

Definition at line 209 of file incompressibleAdjointMeanFlowVars.C.

References phiaMeanPtr_, phiaPtr_, and solverControl_.

◆ paInst() [1/2]

const Foam::volScalarField & paInst ( ) const
inline

Return const reference to pressure.

Definition at line 25 of file incompressibleAdjointMeanFlowVarsI.H.

References paPtr_.

Referenced by incompressibleAdjointSolver::accumulateOptionsDxDbMultiplier(), boundaryAdjointContributionIncompressible::pab(), incompressibleAdjointVars::restoreInitValues(), and setMeanFields().

Here is the caller graph for this function:

◆ paInst() [2/2]

Foam::volScalarField & paInst ( )
inline

Return reference to pressure.

Definition at line 31 of file incompressibleAdjointMeanFlowVarsI.H.

References paPtr_.

◆ UaInst() [1/2]

const Foam::volVectorField & UaInst ( ) const
inline

Return const reference to velocity.

Definition at line 38 of file incompressibleAdjointMeanFlowVarsI.H.

References UaPtr_.

Referenced by incompressibleAdjointSolver::accumulateOptionsDxDbMultiplier(), incompressibleAdjointVars::restoreInitValues(), setFields(), setMeanFields(), and boundaryAdjointContributionIncompressible::Uab().

Here is the caller graph for this function:

◆ UaInst() [2/2]

Foam::volVectorField & UaInst ( )
inline

Return reference to velocity.

Definition at line 44 of file incompressibleAdjointMeanFlowVarsI.H.

References UaPtr_.

◆ phiaInst() [1/2]

const Foam::surfaceScalarField & phiaInst ( ) const
inline

Return const reference to volume flux.

Definition at line 51 of file incompressibleAdjointMeanFlowVarsI.H.

References phiaPtr_.

Referenced by boundaryAdjointContributionIncompressible::phiab(), incompressibleAdjointVars::restoreInitValues(), and setMeanFields().

Here is the caller graph for this function:

◆ phiaInst() [2/2]

Foam::surfaceScalarField & phiaInst ( )
inline

Return reference to volume flux.

Definition at line 58 of file incompressibleAdjointMeanFlowVarsI.H.

References phiaPtr_.

◆ computeMeanFields()

bool computeMeanFields ( ) const

Return computeMeanFields bool.

Definition at line 222 of file incompressibleAdjointMeanFlowVars.C.

References solverControl_.

◆ getSolverControl()

const solverControl & getSolverControl ( ) const

Return const reference to solverControl.

Definition at line 228 of file incompressibleAdjointMeanFlowVars.C.

References solverControl_.

◆ nullify()

void nullify ( )
virtual

Nullify all adjoint fields.

Reimplemented in incompressibleAdjointVars.

Definition at line 234 of file incompressibleAdjointMeanFlowVars.C.

References variablesSet::nullifyField(), paPtr_, phiaPtr_, and UaPtr_.

Referenced by incompressibleAdjointVars::nullify().

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

Member Data Documentation

◆ solverControl_

solverControl& solverControl_
protected

Reference to the solverControl of the solver allocating the fields.

Definition at line 74 of file incompressibleAdjointMeanFlowVars.H.

Referenced by computeMeanFields(), incompressibleAdjointVars::computeMeanFields(), getSolverControl(), incompressibleAdjointMeanFlowVars(), pa(), pa(), phia(), phia(), incompressibleAdjointVars::resetMeanFields(), incompressibleAdjointVars::restoreInitValues(), setMeanFields(), Ua(), and Ua().

◆ primalVars_

incompressibleVars& primalVars_
protected

Reference to primal variables.

Definition at line 79 of file incompressibleAdjointMeanFlowVars.H.

Referenced by incompressibleAdjointMeanFlowVars(), incompressibleAdjointVars::incompressibleAdjointVars(), and primalVars().

◆ paPtr_

autoPtr<volScalarField> paPtr_
protected

Fields involved in the solution of the incompressible adjoint NS equations.

Definition at line 85 of file incompressibleAdjointMeanFlowVars.H.

Referenced by incompressibleAdjointVars::computeMeanFields(), incompressibleAdjointMeanFlowVars(), nullify(), pa(), pa(), paInst(), paInst(), and setFields().

◆ UaPtr_

autoPtr<volVectorField> UaPtr_
protected

Definition at line 86 of file incompressibleAdjointMeanFlowVars.H.

Referenced by incompressibleAdjointVars::computeMeanFields(), incompressibleAdjointMeanFlowVars(), nullify(), setFields(), Ua(), Ua(), UaInst(), and UaInst().

◆ phiaPtr_

autoPtr<surfaceScalarField> phiaPtr_
protected

Definition at line 87 of file incompressibleAdjointMeanFlowVars.H.

Referenced by incompressibleAdjointVars::computeMeanFields(), incompressibleAdjointMeanFlowVars(), nullify(), phia(), phia(), phiaInst(), phiaInst(), and setFields().

◆ paMeanPtr_

autoPtr<volScalarField> paMeanPtr_
protected

Mean Adjoint Fields. Actual averaging is done in the incompressibleAdjointVars class to take care of the mean adjoint turbulence variables.

Definition at line 94 of file incompressibleAdjointMeanFlowVars.H.

Referenced by incompressibleAdjointVars::computeMeanFields(), incompressibleAdjointMeanFlowVars(), pa(), pa(), incompressibleAdjointVars::resetMeanFields(), and setMeanFields().

◆ UaMeanPtr_

autoPtr<volVectorField> UaMeanPtr_
protected

Definition at line 95 of file incompressibleAdjointMeanFlowVars.H.

Referenced by incompressibleAdjointVars::computeMeanFields(), incompressibleAdjointMeanFlowVars(), incompressibleAdjointVars::resetMeanFields(), setMeanFields(), Ua(), and Ua().

◆ phiaMeanPtr_

autoPtr<surfaceScalarField> phiaMeanPtr_
protected

Definition at line 96 of file incompressibleAdjointMeanFlowVars.H.

Referenced by incompressibleAdjointVars::computeMeanFields(), incompressibleAdjointMeanFlowVars(), phia(), phia(), incompressibleAdjointVars::resetMeanFields(), and setMeanFields().

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