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

Abstract base class for adjoint sensitivities. More...

Inheritance diagram for sensitivity:
[legend]
Collaboration diagram for sensitivity:
[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 dictionary & dict () 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 scalarField & calculateSensitivities ()=0
 Calculates and returns sensitivity fields. More...
 
virtual void write (const word &baseName=word::null)
 Write sensitivity fields. More...
 

Protected Attributes

const fvMesh & mesh_
 
dictionary dict_
 
autoPtr< volScalarField > fieldSensPtr_
 

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 43 of file sensitivity.C.

◆ ~sensitivity()

virtual ~sensitivity ( )
virtualdefault

Destructor.

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.

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

Here is the caller graph for this function:

◆ readDict()

bool readDict ( const dictionary &  dict)
virtual

Read dictionary if changed.

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

Definition at line 63 of file sensitivity.C.

References dict, and sensitivity::readDict().

Referenced by sensitivity::readDict().

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

◆ computeDerivativesSize()

void computeDerivativesSize ( )
virtual

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

Definition at line 77 of file sensitivity.C.

Member Data Documentation

◆ mesh_

const fvMesh& mesh_
protected

Definition at line 69 of file sensitivity.H.

Referenced by shapeSensitivities::accumulateBCSensitivityIntegrand(), shapeSensitivities::accumulateDirectSensitivityIntegrand(), FIBase::accumulateIntegrand(), sensitivitySurface::accumulateIntegrand(), sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurface::addGeometricSens(), adjointSensitivity::adjointMeshMovementSource(), sensitivityBezierFI::assembleSensitivities(), sensitivitySurface::assembleSensitivities(), sensitivitySurfacePoints::assembleSensitivities(), sensitivityVolBSplinesFI::assembleSensitivities(), sensitivitySurface::computeDerivativesSize(), sensitivitySurface::computeRadius(), sensitivitySurfacePoints::constructGlobalPointNormalsAndAreas(), sensitivitySurfacePoints::finaliseFaceMultiplier(), sensitivitySurfacePoints::finalisePointSensitivities(), FIBase::read(), sensitivitySurface::read(), sensitivitySurfacePoints::read(), sensitivitySurface::sensitivitySurface(), sensitivitySurfacePoints::sensitivitySurfacePoints(), sensitivitySurface::smoothSensitivities(), sensitivityBezierFI::solveMeshMovementEqn(), sensitivityBezier::write(), sensitivityBezierFI::write(), sensitivityVolBSplines::write(), and sensitivityVolBSplinesFI::write().

◆ dict_

dictionary dict_
protected

Definition at line 70 of file sensitivity.H.

Referenced by FIBase::read(), sensitivityBezierFI::read(), and sensitivitySurface::read().

◆ fieldSensPtr_

autoPtr<volScalarField> fieldSensPtr_
protected

Definition at line 74 of file sensitivity.H.

Referenced by adjointSensitivity::clearSensitivities().

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