incompressibleAdjointVars Class Reference

Class including all adjoint fields for incompressible flows. More...

Inheritance diagram for incompressibleAdjointVars:
[legend]
Collaboration diagram for incompressibleAdjointVars:
[legend]

Public Member Functions

 TypeName ("incompressibleAdjointVars")
 Run-time type information. More...
 
 incompressibleAdjointVars (fvMesh &mesh, solverControl &SolverControl, objectiveManager &objManager, incompressibleVars &primalVars)
 Construct from mesh. More...
 
virtual ~incompressibleAdjointVars ()
 Destructor. More...
 
const autoPtr< incompressibleAdjoint::adjointRASModel > & adjointTurbulence () const
 Return const reference to the adjointRASModel. More...
 
autoPtr< incompressibleAdjoint::adjointRASModel > & adjointTurbulence ()
 Return non-const reference to the adjointRASModel. More...
 
void resetMeanFields ()
 Reset mean fields to zero. More...
 
void computeMeanFields ()
 Compute mean fields on the fly. More...
 
virtual void nullify ()
 Nullify all adjoint fields. More...
 
virtual void updatePrimalBasedQuantities ()
 Update primal based quantities of the adjoint boundary. More...
 
- Public Member Functions inherited from incompressibleAdjointMeanFlowVars
 TypeName ("incompressibleAdjointMeanFlowVars")
 Run-time type information. More...
 
 incompressibleAdjointMeanFlowVars (fvMesh &mesh, solverControl &SolverControl, incompressibleVars &primalVars)
 Construct from mesh. More...
 
virtual ~incompressibleAdjointMeanFlowVars ()=default
 Destructor. More...
 
const incompressibleVarsprimalVars () const
 
const volScalarFieldpa () const
 Return const reference to pressure. More...
 
volScalarFieldpa ()
 Return reference to pressure. More...
 
const volVectorFieldUa () const
 Return const reference to velocity. More...
 
volVectorFieldUa ()
 Return reference to velocity. More...
 
const surfaceScalarFieldphia () const
 Return const reference to volume flux. More...
 
surfaceScalarFieldphia ()
 Return reference to volume flux. More...
 
const volScalarFieldpaInst () const
 Return const reference to pressure. More...
 
volScalarFieldpaInst ()
 Return reference to pressure. More...
 
const volVectorFieldUaInst () const
 Return const reference to velocity. More...
 
volVectorFieldUaInst ()
 Return reference to velocity. More...
 
const surfaceScalarFieldphiaInst () const
 Return const reference to volume flux. More...
 
surfaceScalarFieldphiaInst ()
 Return reference to volume flux. More...
 
bool computeMeanFields () const
 Return computeMeanFields bool. More...
 
const solverControlgetSolverControl () const
 Return const reference to solverControl. More...
 
virtual void nullify ()
 Nullify all adjoint fields. More...
 
- Public Member Functions inherited from variablesSet
 TypeName ("variablesSet")
 Run-time type information. More...
 
 variablesSet (fvMesh &mesh, const dictionary &dict)
 Construct from mesh and solver name. More...
 
virtual autoPtr< variablesSetclone () const
 Clone the variablesSet. More...
 
virtual ~variablesSet ()=default
 Destructor. More...
 
const wordsolverName () const
 Return solver name. More...
 
bool useSolverNameForFields () const
 Append solver name to fields? More...
 
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)
 
tmp< surfaceScalarFieldallocateFluxField (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. More...
 

Protected Member Functions

 incompressibleAdjointVars (const incompressibleAdjointVars &)
 No copy construct. More...
 
void operator= (const incompressibleAdjointVars &)
 No copy assignment. More...
 
- Protected Member Functions inherited from incompressibleAdjointMeanFlowVars
void setFields ()
 Read fields and set turbulence. More...
 
void setMeanFields ()
 Read mean fields, if necessary. More...
 
- 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. More...
 

Protected Attributes

objectiveManagerobjectiveManager_
 Reference to the objectiveManager. More...
 
autoPtr< incompressibleAdjoint::adjointRASModeladjointTurbulence_
 Adjoint to the turbulence model. More...
 
- Protected Attributes inherited from incompressibleAdjointMeanFlowVars
solverControlsolverControl_
 Reference to the solverControl of the solver allocating the fields. More...
 
incompressibleVarsprimalVars_
 Reference to primal variables. More...
 
autoPtr< volScalarFieldpaPtr_
 
autoPtr< volVectorFieldUaPtr_
 
autoPtr< surfaceScalarFieldphiaPtr_
 
autoPtr< volScalarFieldpaMeanPtr_
 
autoPtr< volVectorFieldUaMeanPtr_
 
autoPtr< surfaceScalarFieldphiaMeanPtr_
 
- Protected Attributes inherited from variablesSet
fvMeshmesh_
 Reference to the mesh database. More...
 
word solverName_
 Solver name owning the variables set. More...
 
bool useSolverNameForFields_
 Append the solver name to the variables names? More...
 

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. More...
 
static void setFluxField (autoPtr< surfaceScalarField > &fieldPtr, const fvMesh &mesh, const volVectorField &velocity, const word &baseName, const word &solverName, const bool useSolverNameForFields)
 Set flux field. More...
 
static tmp< volVectorFieldautoCreateMeshMovementField (const fvMesh &mesh, const word &name, const dimensionSet &dims)
 Auto create variable for mesh movement. More...
 
template<class Type , template< class > class PatchField, class GeoMesh >
static void nullifyField (GeometricField< Type, PatchField, GeoMesh > &fieldPtr)
 Nullify field and old times, if present. More...
 

Detailed Description

Class including all adjoint fields for incompressible flows.

Definition at line 52 of file incompressibleAdjointVars.H.

Constructor & Destructor Documentation

◆ incompressibleAdjointVars() [1/2]

No copy construct.

◆ incompressibleAdjointVars() [2/2]

incompressibleAdjointVars ( fvMesh mesh,
solverControl SolverControl,
objectiveManager objManager,
incompressibleVars primalVars 
)

Construct from mesh.

Definition at line 45 of file incompressibleAdjointVars.C.

◆ ~incompressibleAdjointVars()

virtual ~incompressibleAdjointVars ( )
inlinevirtual

Destructor.

Definition at line 98 of file incompressibleAdjointVars.H.

Member Function Documentation

◆ operator=()

void operator= ( const incompressibleAdjointVars )
protected

No copy assignment.

◆ TypeName()

TypeName ( "incompressibleAdjointVars"  )

Run-time type information.

◆ adjointTurbulence() [1/2]

◆ adjointTurbulence() [2/2]

Return non-const reference to the adjointRASModel.

Definition at line 39 of file incompressibleAdjointVarsI.H.

◆ resetMeanFields()

◆ computeMeanFields()

◆ nullify()

void nullify ( )
virtual

Nullify all adjoint fields.

Reimplemented from incompressibleAdjointMeanFlowVars.

Definition at line 106 of file incompressibleAdjointVars.C.

References incompressibleAdjointVars::adjointTurbulence_, and incompressibleAdjointMeanFlowVars::nullify().

Here is the call graph for this function:

◆ updatePrimalBasedQuantities()

void updatePrimalBasedQuantities ( )
virtual

Update primal based quantities of the adjoint boundary.

conditions

Definition at line 113 of file incompressibleAdjointVars.C.

Member Data Documentation

◆ objectiveManager_

objectiveManager& objectiveManager_
protected

Reference to the objectiveManager.

Definition at line 61 of file incompressibleAdjointVars.H.

◆ adjointTurbulence_


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