FIBase Class Referenceabstract

Base class for Field Integral-based sensitivity derivatives. More...

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

Public Member Functions

 TypeName ("volumetricBSplinesFI")
 Runtime type information. More...
 
 FIBase (const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager, fv::optionAdjointList &fvOptionsAdjoint)
 Construct from components. More...
 
virtual ~FIBase ()=default
 Destructor. More...
 
virtual bool readDict (const dictionary &dict)
 Read dict if changed. More...
 
virtual void accumulateIntegrand (const scalar dt)
 Accumulate sensitivity integrands. More...
 
virtual void assembleSensitivities ()=0
 Assemble sensitivities. More...
 
virtual void clearSensitivities ()
 Zero sensitivity fields and their constituents. More...
 
- Public Member Functions inherited from shapeSensitivities
 TypeName ("shapeSensitivities")
 Runtime type information. More...
 
 shapeSensitivities (const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager, fv::optionAdjointList &fvOptionsAdjoint)
 Construct from components. More...
 
virtual ~shapeSensitivities ()=default
 Destructor. More...
 
virtual void write (const word &baseName=word::null)
 Write sensitivity fields. More...
 
- Public Member Functions inherited from adjointSensitivity
 TypeName ("adjointSensitivity")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, adjointSensitivity, dictionary,(const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager, fv::optionAdjointList &fvOptionsAdjoint),(mesh, dict, primalVars, adjointVars, objectiveManager, fvOptionsAdjoint))
 
 adjointSensitivity (const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager, fv::optionAdjointList &fvOptionsAdjoint)
 Construct from components. More...
 
virtual ~adjointSensitivity ()=default
 Destructor. More...
 
virtual const scalarFieldcalculateSensitivities ()
 Calculates and returns sensitivity fields. More...
 
const scalarFieldgetSensitivities () const
 Returns the sensitivity fields. More...
 
tmp< volTensorFieldcomputeGradDxDbMultiplier ()
 
tmp< volVectorFieldadjointMeshMovementSource ()
 Compute source term for adjoint mesh movement equation. More...
 
- Public Member Functions inherited from sensitivity
 TypeName ("sensitivity")
 Runtime type information. More...
 
 sensitivity (const fvMesh &mesh, const dictionary &dict)
 Construct from components. More...
 
virtual ~sensitivity ()=default
 Destructor. More...
 
const dictionarydict () const
 Return the construction dictionary. More...
 
virtual void computeDerivativesSize ()
 Compute design variables number. Does nothing in the base. More...
 

Protected Member Functions

void read ()
 Read options and update solver pointers if necessary. More...
 
- Protected Member Functions inherited from shapeSensitivities
virtual void accumulateDirectSensitivityIntegrand (const scalar dt)
 Accumulate direct sensitivities. More...
 
virtual void accumulateBCSensitivityIntegrand (const scalar dt)
 Accumulate sensitivities enamating from the boundary conditions. More...
 
tmp< boundaryVectorFielddvdbMult () const
 Compute multiplier of dv_i/db. More...
 

Protected Attributes

volTensorField gradDxDbMult_
 grad(dx/db) multiplier More...
 
scalarField divDxDbMult_
 div(dx/db) multiplier More...
 
vectorField optionsDxDbMult_
 dx/db multiplier coming from fvOptions More...
 
bool includeDistance_
 Include distance variation in sens computation. More...
 
autoPtr< adjointEikonalSolvereikonalSolver_
 Adjoint eikonal equation solver. More...
 
- Protected Attributes inherited from shapeSensitivities
autoPtr< boundaryVectorFielddSfdbMult_
 Fields related to direct sensitivities. More...
 
autoPtr< boundaryVectorFielddnfdbMult_
 
autoPtr< boundaryVectorFielddxdbDirectMult_
 
autoPtr< boundaryVectorFieldbcDxDbMult_
 
- Protected Attributes inherited from adjointSensitivity
scalarField derivatives_
 
incompressibleVarsprimalVars_
 
incompressibleAdjointVarsadjointVars_
 
objectiveManagerobjectiveManager_
 
fv::optionAdjointListfvOptionsAdjoint_
 
- Protected Attributes inherited from sensitivity
const fvMeshmesh_
 
dictionary dict_
 
autoPtr< volScalarFieldfieldSensPtr_
 

Additional Inherited Members

- Static Public Member Functions inherited from adjointSensitivity
static autoPtr< adjointSensitivityNew (const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager, fv::optionAdjointList &fvOptionsAdjoint)
 Return a reference to the selected turbulence model. More...
 

Detailed Description

Base class for Field Integral-based sensitivity derivatives.

Source files

Definition at line 57 of file FIBaseIncompressible.H.

Constructor & Destructor Documentation

◆ FIBase()

FIBase ( const fvMesh mesh,
const dictionary dict,
incompressibleVars primalVars,
incompressibleAdjointVars adjointVars,
objectiveManager objectiveManager,
fv::optionAdjointList fvOptionsAdjoint 
)

Construct from components.

Definition at line 78 of file FIBaseIncompressible.C.

References Foam::read().

Here is the call graph for this function:

◆ ~FIBase()

virtual ~FIBase ( )
virtualdefault

Destructor.

Member Function Documentation

◆ read()

void read ( )
protected

Read options and update solver pointers if necessary.

Definition at line 48 of file FIBaseIncompressible.C.

References incompressibleAdjointVars::adjointTurbulence(), adjointSensitivity::adjointVars_, sensitivity::dict_, FIBase::eikonalSolver_, dictionary::getOrDefault(), FIBase::includeDistance_, sensitivity::mesh_, adjointSensitivity::primalVars_, and incompressibleVars::RASModelVariables().

Referenced by sensitivityVolBSplinesFI::assembleSensitivities(), and sensitivityBezierFI::read().

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

◆ TypeName()

TypeName ( "volumetricBSplinesFI"  )

Runtime type information.

◆ readDict()

bool readDict ( const dictionary dict)
virtual

Read dict if changed.

Reimplemented from sensitivity.

Definition at line 121 of file FIBaseIncompressible.C.

References sensitivity::dict(), FIBase::eikonalSolver_, and sensitivity::readDict().

Here is the call graph for this function:

◆ accumulateIntegrand()

◆ assembleSensitivities()

virtual void assembleSensitivities ( )
pure virtual

Assemble sensitivities.

Implements shapeSensitivities.

Implemented in sensitivityBezierFI, and sensitivityVolBSplinesFI.

◆ clearSensitivities()

void clearSensitivities ( )
virtual

Zero sensitivity fields and their constituents.

Reimplemented from shapeSensitivities.

Reimplemented in sensitivityBezierFI, and sensitivityVolBSplinesFI.

Definition at line 172 of file FIBaseIncompressible.C.

References shapeSensitivities::clearSensitivities(), FIBase::divDxDbMult_, FIBase::eikonalSolver_, FIBase::gradDxDbMult_, FIBase::includeDistance_, FIBase::optionsDxDbMult_, VectorSpace< Vector< scalar >, scalar, 3 >::zero, and Foam::Zero.

Referenced by sensitivityVolBSplinesFI::clearSensitivities(), and sensitivityBezierFI::clearSensitivities().

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

Member Data Documentation

◆ gradDxDbMult_

◆ divDxDbMult_

◆ optionsDxDbMult_

vectorField optionsDxDbMult_
protected

◆ includeDistance_

bool includeDistance_
protected

◆ eikonalSolver_


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