Public Member Functions | Protected Attributes | List of all members
sensitivity Class Referenceabstract

Abstract base class for adjoint sensitivities. More...

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

Public Member Functions

 TypeName ("sensitivity")
 Runtime type information. More...
 
 sensitivity (const fvMesh &mesh, const dictionary &dict)
 Construct from components. More...
 
virtual ~sensitivity ()=default
 Destructor. More...
 
const fvMesh & mesh () const
 Return reference to mesh. More...
 
const dictionary & dict () const
 Return the construction dictionary. More...
 
virtual bool readDict (const dictionary &dict)
 Read dictionary if changed. More...
 
virtual const scalarField & calculateSensitivities (autoPtr< designVariables > &designVars)=0
 Calculates and returns sensitivity field. More...
 
const autoPtr< volScalarField > & fieldSensPtr () const
 Get the fieldSensPtr. More...
 
virtual void write (const word &baseName=word::null)
 Write sensitivity fields. More...
 

Protected Attributes

const fvMesh & mesh_
 
dictionary dict_
 
bool writeFieldSens_
 
autoPtr< volScalarField > fieldSensPtr_
 

Detailed Description

Abstract base class for adjoint sensitivities.

Source files

Definition at line 62 of file sensitivity.H.

Constructor & Destructor Documentation

◆ sensitivity()

sensitivity ( const fvMesh &  mesh,
const dictionary &  dict 
)

Construct from components.

Definition at line 37 of file sensitivity.C.

◆ ~sensitivity()

virtual ~sensitivity ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "sensitivity"  )

Runtime type information.

◆ mesh()

const fvMesh& mesh ( ) const
inline

Return reference to mesh.

Definition at line 121 of file sensitivity.H.

References sensitivity::mesh_.

◆ dict()

const dictionary& dict ( ) const
inline

Return the construction dictionary.

Definition at line 129 of file sensitivity.H.

References sensitivity::dict_, sensitivity::mesh_, fvMesh::name(), and dictionary::optionalSubDict().

Referenced by ShapeSensitivitiesBase::allocateEikonalSolver(), sensitivitySurface::computeRadius(), sensitivitySurface::read(), sensitivitySurfacePoints::read(), sensitivityMultiple::readDict(), sensitivityTopO::readDict(), sensitivity::readDict(), sensitivitySurfacePoints::readDict(), adjointSensitivity::readDict(), sensitivitySurfacePoints::setSuffixName(), and sensitivitySurface::smoothSensitivities().

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

◆ readDict()

bool readDict ( const dictionary &  dict)
virtual

Read dictionary if changed.

Reimplemented in ShapeSensitivitiesBase, adjointSensitivity, sensitivitySurfacePoints, sensitivityTopO, sensitivityShapeESI, and sensitivityMultiple.

Definition at line 51 of file sensitivity.C.

References sensitivity::dict(), and sensitivity::dict_.

Referenced by adjointSensitivity::readDict().

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

◆ calculateSensitivities()

virtual const scalarField& calculateSensitivities ( autoPtr< designVariables > &  designVars)
pure virtual

Calculates and returns sensitivity field.

Implemented in adjointSensitivity, and sensitivityMultiple.

◆ fieldSensPtr()

const autoPtr<volScalarField>& fieldSensPtr ( ) const
inline

Get the fieldSensPtr.

Definition at line 152 of file sensitivity.H.

References sensitivity::fieldSensPtr_.

Referenced by levelSetDesignVariables::assembleSensitivities(), and topODesignVariables::assembleSensitivities().

Here is the caller graph for this function:

◆ write()

void write ( const word &  baseName = word::null)
virtual

Write sensitivity fields.

If valid, copies boundaryFields to volFields and writes them. Virtual to be reimplemented by control points-based methods (Bezier, RBF) which do not need to write fields

Reimplemented in adjointSensitivity, ShapeSensitivitiesBase, sensitivitySurfacePoints, and sensitivityMultiple.

Definition at line 59 of file sensitivity.C.

Referenced by adjointSensitivity::write().

Here is the caller graph for this function:

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

Definition at line 68 of file sensitivity.H.

Referenced by ShapeSensitivitiesBase::allocateEikonalSolver(), sensitivityShapeESI::computeDxDbMult(), sensitivitySurfacePoints::computePointDerivativesSize(), sensitivitySurface::computeRadius(), sensitivity::dict(), sensitivitySurfacePoints::finalisePointSensitivities(), sensitivity::mesh(), sensitivitySurfacePoints::populateExtendedIDs(), sensitivityTopO::readDict(), sensitivitySurface::smoothSensitivities(), sensitivitySurfacePoints::write(), and sensitivityTopO::zeroSensInFixedPorousZones().

◆ dict_

dictionary dict_
protected

Definition at line 69 of file sensitivity.H.

Referenced by sensitivity::dict(), sensitivityTopO::readDict(), and sensitivity::readDict().

◆ writeFieldSens_

bool writeFieldSens_
protected

Definition at line 70 of file sensitivity.H.

◆ fieldSensPtr_

autoPtr<volScalarField> fieldSensPtr_
protected

Definition at line 74 of file sensitivity.H.

Referenced by sensitivityTopO::accumulateIntegrand(), adjointSensitivity::clearSensitivities(), and sensitivity::fieldSensPtr().

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