sensitivity Class Reference

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 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

• sensitivity.H
• sensitivity.C

Definition at line 59 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.

dict()

const Foam::dictionary & dict

(

)

const

Return the construction dictionary.

Definition at line 50 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().

Here is the caller graph for this function:

readDict()

bool readDict ( const dictionary &  dict )

virtual

Read dictionary if changed.

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

Definition at line 56 of file sensitivity.C.

References dict.

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

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

Definition at line 70 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 65 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(), sensitivitySurface::computeRadius(), sensitivitySurfacePoints::finaliseFaceMultiplier(), sensitivitySurfacePoints::finalisePointSensitivities(), FIBase::read(), sensitivitySurfacePoints::read(), sensitivitySurface::read(), sensitivitySurface::smoothSensitivities(), sensitivityBezier::write(), sensitivityVolBSplines::write(), sensitivityVolBSplinesFI::write(), and sensitivityBezierFI::write().

dict_

dictionary dict_

protected

Definition at line 66 of file sensitivity.H.

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

fieldSensPtr_

autoPtr<volScalarField> fieldSensPtr_

protected

Definition at line 70 of file sensitivity.H.

Referenced by adjointSensitivity::clearSensitivities().

---

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