sensitivity Class Reference

Abstract base class for adjoint sensitivities. More...

#include <sensitivity.H>

Inheritance diagram for sensitivity:

Collaboration diagram for sensitivity:

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

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

Detailed Description

Abstract base class for adjoint sensitivities.

Source files

• sensitivity.H
• sensitivity.C

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

References dict(), dict_, fieldSensPtr_, mesh(), mesh_, and writeFieldSens_.

Here is the call graph for this function:

~sensitivity()

virtual ~sensitivity ( )

virtualdefault

Destructor.

Member Function Documentation

TypeName()

TypeName

(

"sensitivity"

)

Runtime type information.

References dict(), and mesh().

Here is the call graph for this function:

mesh()

const fvMesh & mesh ( ) const

inline

Return reference to mesh.

Definition at line 121 of file sensitivity.H.

References mesh_.

Referenced by adjointSensitivity::adjointSensitivity(), adjointSensitivity::declareRunTimeSelectionTable(), adjointSensitivity::New(), sensitivity(), sensitivityMultiple::sensitivityMultiple(), sensitivityShapeESI::sensitivityShapeESI(), sensitivityShapeFI::sensitivityShapeFI(), sensitivityTopO::sensitivityTopO(), ShapeSensitivitiesBase::ShapeSensitivitiesBase(), TypeName(), sensitivityMultiple::TypeName(), sensitivityShapeESI::TypeName(), sensitivityShapeFI::TypeName(), sensitivityTopO::TypeName(), and ShapeSensitivitiesBase::TypeName().

Here is the caller graph for this function:

dict()

const dictionary & dict ( ) const

inline

Return the construction dictionary.

Definition at line 129 of file sensitivity.H.

References dict_, and mesh_.

Referenced by adjointSensitivity::adjointSensitivity(), ShapeSensitivitiesBase::allocateEikonalSolver(), adjointSensitivity::declareRunTimeSelectionTable(), adjointSensitivity::New(), adjointSensitivity::readDict(), readDict(), sensitivityMultiple::readDict(), sensitivityShapeESI::readDict(), sensitivityTopO::readDict(), ShapeSensitivitiesBase::readDict(), sensitivity(), sensitivityMultiple::sensitivityMultiple(), sensitivityShapeESI::sensitivityShapeESI(), sensitivityShapeFI::sensitivityShapeFI(), sensitivityTopO::sensitivityTopO(), ShapeSensitivitiesBase::ShapeSensitivitiesBase(), TypeName(), sensitivityMultiple::TypeName(), sensitivityShapeESI::TypeName(), sensitivityShapeFI::TypeName(), sensitivityTopO::TypeName(), ShapeSensitivitiesBase::TypeName(), adjointSensitivity::~adjointSensitivity(), sensitivityMultiple::~sensitivityMultiple(), sensitivityShapeESI::~sensitivityShapeESI(), sensitivityTopO::~sensitivityTopO(), and ShapeSensitivitiesBase::~ShapeSensitivitiesBase().

Here is the caller graph for this function:

readDict()

bool readDict ( const dictionary & dict )

virtual

Read dictionary if changed.

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

Definition at line 51 of file sensitivity.C.

References dict(), and 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 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, sensitivityMultiple, sensitivitySurfacePoints, and ShapeSensitivitiesBase.

Definition at line 59 of file sensitivity.C.

References fieldSensPtr_, and writeFieldSens_.

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(), ShapeSensitivitiesBase::allocateMultipliers(), sensitivitySurface::assembleSensitivities(), sensitivitySurfacePoints::assembleSensitivities(), sensitivityShapeESI::computeDxDbMult(), sensitivitySurface::computeFaceDerivativesSize(), sensitivitySurfacePoints::computePointDerivativesSize(), sensitivitySurface::computeRadius(), ShapeSensitivitiesBase::constructAndWriteSensitivityField(), ShapeSensitivitiesBase::constructAndWriteSensitivtyPointField(), sensitivitySurfacePoints::constructGlobalPointNormalsAndAreas(), ShapeSensitivitiesBase::constructVolSensitivtyField(), dict(), sensitivitySurfacePoints::finalisePointSensitivities(), ShapeSensitivitiesBase::getWallFaceSensNormal(), ShapeSensitivitiesBase::getWallFaceSensNormalVec(), ShapeSensitivitiesBase::getWallFaceSensVec(), ShapeSensitivitiesBase::getWallPointSensNormal(), ShapeSensitivitiesBase::getWallPointSensNormalVec(), ShapeSensitivitiesBase::getWallPointSensVec(), mesh(), sensitivitySurfacePoints::populateExtendedIDs(), sensitivityTopO::postProcessSens(), sensitivityShapeESI::readDict(), sensitivityTopO::readDict(), ShapeSensitivitiesBase::readDict(), sensitivity(), sensitivityShapeESI::sensitivityShapeESI(), sensitivitySurface::sensitivitySurface(), sensitivitySurfacePoints::sensitivitySurfacePoints(), sensitivityTopO::sensitivityTopO(), sensitivitySurface::smoothSensitivities(), sensitivitySurfacePoints::write(), and sensitivityTopO::zeroSensInFixedPorousZones().

dict_

dictionary dict_

protected

Definition at line 69 of file sensitivity.H.

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

writeFieldSens_

bool writeFieldSens_

protected

Definition at line 70 of file sensitivity.H.

Referenced by sensitivity(), and write().

fieldSensPtr_

autoPtr<volScalarField> fieldSensPtr_

protected

Definition at line 74 of file sensitivity.H.

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

---

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

• src/optimisation/adjointOptimisation/adjoint/optimisation/adjointSensitivity/sensitivity/sensitivity.H
• src/optimisation/adjointOptimisation/adjoint/optimisation/adjointSensitivity/sensitivity/sensitivity.C