sensitivity Class Referenceabstract

Abstract base class for adjoint sensitivities. More...

Inheritance diagram for sensitivity:
Collaboration diagram for sensitivity:

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 dictionarydict () const
 Return the construction dictionary. More...
virtual bool readDict (const dictionary &dict)
 Read dictionary if changed. More...
virtual void computeDerivativesSize ()
 Compute design variables number. Does nothing in the base. More...
virtual const scalarFieldcalculateSensitivities ()=0
 Calculates and returns sensitivity fields. More...
virtual void write (const word &baseName=word::null)
 Write sensitivity fields. More...

Protected Attributes

const fvMeshmesh_
dictionary dict_
autoPtr< volScalarFieldfieldSensPtr_

Detailed Description

Abstract base class for adjoint sensitivities.

Source files

Definition at line 63 of file sensitivity.H.

Constructor & Destructor Documentation

◆ sensitivity()

sensitivity ( const fvMesh mesh,
const dictionary dict 

Construct from components.

Definition at line 44 of file sensitivity.C.

◆ ~sensitivity()

virtual ~sensitivity ( )


Member Function Documentation

◆ TypeName()

TypeName ( "sensitivity"  )

Runtime type information.

◆ dict()

const Foam::dictionary & dict ( ) const

Return the construction dictionary.

Definition at line 57 of file sensitivity.C.

References sensitivity::dict_.

Referenced by SIBase::read(), sensitivitySurfacePoints::read(), sensitivitySurface::read(), sensitivityMultiple::readDict(), SIBase::readDict(), FIBase::readDict(), sensitivitySurface::readDict(), sensitivitySurfacePoints::readDict(), sensitivitySurface::setSuffixName(), and sensitivitySurfacePoints::setSuffixName().

Here is the caller graph for this function:

◆ readDict()

bool readDict ( const dictionary dict)

Read dictionary if changed.

Reimplemented in sensitivitySurfacePoints, sensitivitySurface, FIBase, SIBase, and sensitivityMultiple.

Definition at line 63 of file sensitivity.C.

References dict.

Referenced by sensitivityMultiple::readDict(), SIBase::readDict(), FIBase::readDict(), sensitivitySurface::readDict(), and sensitivitySurfacePoints::readDict().

Here is the caller graph for this function:

◆ computeDerivativesSize()

void computeDerivativesSize ( )

Compute design variables number. Does nothing in the base.

Used to get the correct design variables number when setSensitivityPatchIDs are not set in the constructor

Reimplemented in sensitivitySurface.

Definition at line 71 of file sensitivity.C.

◆ calculateSensitivities()

virtual const scalarField& calculateSensitivities ( )
pure virtual

Calculates and returns sensitivity fields.

Used with optimisation libraries

Implemented in adjointSensitivity, and sensitivityMultiple.

◆ write()

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

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, sensitivitySurfacePoints, sensitivitySurface, sensitivityBezierFI, sensitivityVolBSplinesFI, sensitivityVolBSplines, SIBase, shapeSensitivities, sensitivityBezier, and sensitivityMultiple.

Definition at line 77 of file sensitivity.C.

Referenced by adjointSensitivity::write().

Here is the caller graph for this function:

Member Data Documentation

◆ mesh_

◆ dict_

dictionary dict_

◆ fieldSensPtr_

autoPtr<volScalarField> fieldSensPtr_

Definition at line 74 of file sensitivity.H.

Referenced by adjointSensitivity::clearSensitivities().

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