Abstract base class for adjoint sensitivities. More...
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_ |
Abstract base class for adjoint sensitivities.
Definition at line 63 of file sensitivity.H.
sensitivity | ( | const fvMesh & | mesh, |
const dictionary & | dict | ||
) |
Construct from components.
Definition at line 44 of file sensitivity.C.
|
virtualdefault |
Destructor.
TypeName | ( | "sensitivity" | ) |
Runtime type information.
const Foam::dictionary & dict | ( | ) | const |
Return the construction dictionary.
Definition at line 57 of file sensitivity.C.
References sensitivity::dict_.
Referenced by sensitivitySurface::computeRadius(), SIBase::read(), sensitivitySurfacePoints::read(), sensitivitySurface::read(), sensitivityMultiple::readDict(), SIBase::readDict(), FIBase::readDict(), sensitivitySurfacePoints::readDict(), sensitivitySurface::readDict(), sensitivitySurfacePoints::setSuffixName(), sensitivitySurface::setSuffixName(), and sensitivitySurface::smoothSensitivities().
|
virtual |
Read dictionary if changed.
Reimplemented in sensitivitySurface, sensitivitySurfacePoints, FIBase, SIBase, and sensitivityMultiple.
Definition at line 63 of file sensitivity.C.
References dict.
Referenced by sensitivityMultiple::readDict(), SIBase::readDict(), FIBase::readDict(), sensitivitySurfacePoints::readDict(), and sensitivitySurface::readDict().
|
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.
|
pure virtual |
Calculates and returns sensitivity fields.
Used with optimisation libraries
Implemented in adjointSensitivity, and sensitivityMultiple.
|
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 sensitivitySurface, sensitivitySurfacePoints, adjointSensitivity, sensitivityBezierFI, sensitivityVolBSplinesFI, sensitivityVolBSplines, SIBase, shapeSensitivities, sensitivityBezier, and sensitivityMultiple.
Definition at line 77 of file sensitivity.C.
Referenced by adjointSensitivity::write().
|
protected |
Definition at line 69 of file sensitivity.H.
Referenced by shapeSensitivities::accumulateBCSensitivityIntegrand(), shapeSensitivities::accumulateDirectSensitivityIntegrand(), FIBase::accumulateIntegrand(), sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurface::accumulateIntegrand(), sensitivitySurface::addGeometricSens(), adjointSensitivity::adjointMeshMovementSource(), sensitivityVolBSplinesFI::assembleSensitivities(), sensitivityBezierFI::assembleSensitivities(), sensitivitySurfacePoints::assembleSensitivities(), sensitivitySurface::assembleSensitivities(), sensitivitySurface::computeDerivativesSize(), adjointSensitivity::computeGradDxDbMultiplier(), sensitivitySurface::computeRadius(), sensitivitySurfacePoints::finaliseFaceMultiplier(), sensitivitySurfacePoints::finalisePointSensitivities(), FIBase::read(), sensitivitySurfacePoints::read(), sensitivitySurface::read(), sensitivitySurface::smoothSensitivities(), sensitivityBezier::write(), sensitivityVolBSplines::write(), sensitivityVolBSplinesFI::write(), and sensitivityBezierFI::write().
|
protected |
Definition at line 70 of file sensitivity.H.
Referenced by sensitivity::dict(), FIBase::read(), sensitivityBezierFI::read(), and sensitivitySurface::read().
|
protected |
Definition at line 74 of file sensitivity.H.
Referenced by adjointSensitivity::clearSensitivities().