FIBase Class Reference

Base class for Field Integral-based sensitivity derivatives. More...

Inheritance diagram for FIBase:

Collaboration diagram for FIBase:

Public Member Functions
	TypeName ("volumetricBSplinesFI")
	FIBase (const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager)
virtual	~FIBase ()=default
virtual bool	readDict (const dictionary &dict)
virtual void	accumulateIntegrand (const scalar dt)
virtual void	assembleSensitivities ()=0
virtual void	clearSensitivities ()
Public Member Functions inherited from shapeSensitivities
	TypeName ("shapeSensitivities")
	shapeSensitivities (const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager)
virtual	~shapeSensitivities ()=default
virtual void	write (const word &baseName=word::null)
Public Member Functions inherited from adjointSensitivity
	TypeName ("adjointSensitivity")
	declareRunTimeSelectionTable (autoPtr, adjointSensitivity, dictionary,(const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager),(mesh, dict, primalVars, adjointVars, objectiveManager))
	adjointSensitivity (const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager)
virtual	~adjointSensitivity ()=default
virtual const scalarField &	calculateSensitivities ()
const scalarField &	getSensitivities () const
tmp< volTensorField >	computeGradDxDbMultiplier ()
tmp< volVectorField >	adjointMeshMovementSource ()
Public Member Functions inherited from sensitivity
	TypeName ("sensitivity")
	sensitivity (const fvMesh &mesh, const dictionary &dict)
virtual	~sensitivity ()=default
const dictionary &	dict () const
virtual void	computeDerivativesSize ()

Protected Member Functions
void	read ()
Protected Member Functions inherited from shapeSensitivities
virtual void	accumulateDirectSensitivityIntegrand (const scalar dt)
virtual void	accumulateBCSensitivityIntegrand (const scalar dt)
tmp< boundaryVectorField >	dvdbMult () const

Protected Attributes
volTensorField	gradDxDbMult_
scalarField	divDxDbMult_
vectorField	optionsDxDbMult_
bool	includeDistance_
autoPtr< adjointEikonalSolver >	eikonalSolver_
Protected Attributes inherited from shapeSensitivities
autoPtr< boundaryVectorField >	dSfdbMult_
autoPtr< boundaryVectorField >	dnfdbMult_
autoPtr< boundaryVectorField >	dxdbDirectMult_
autoPtr< boundaryVectorField >	bcDxDbMult_
Protected Attributes inherited from adjointSensitivity
scalarField	derivatives_
incompressibleVars &	primalVars_
incompressibleAdjointVars &	adjointVars_
objectiveManager &	objectiveManager_
Protected Attributes inherited from sensitivity
const fvMesh &	mesh_
dictionary	dict_
autoPtr< volScalarField >	fieldSensPtr_

Additional Inherited Members
Static Public Member Functions inherited from adjointSensitivity
static autoPtr< adjointSensitivity >	New (const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager)

Detailed Description

Base class for Field Integral-based sensitivity derivatives.

Source files

• FIBaseIncompressible.H
• FIBase.C

Definition at line 53 of file FIBaseIncompressible.H.

Constructor & Destructor Documentation

FIBase()

FIBase	(	const fvMesh &	mesh,
		const dictionary &	dict,
		incompressibleVars &	primalVars,
		incompressibleAdjointVars &	adjointVars,
		objectiveManager &	objectiveManager
	)

Definition at line 72 of file FIBaseIncompressible.C.

References Foam::read().

Here is the call graph for this function:

~FIBase()

virtual ~FIBase ( )

virtualdefault

Member Function Documentation

read()

void read ( )

protected

Definition at line 42 of file FIBaseIncompressible.C.

References incompressibleAdjointVars::adjointTurbulence(), adjointSensitivity::adjointVars_, sensitivity::dict_, FIBase::eikonalSolver_, dictionary::getOrDefault(), FIBase::includeDistance_, sensitivity::mesh_, adjointSensitivity::primalVars_, and incompressibleVars::RASModelVariables().

Referenced by sensitivityVolBSplinesFI::assembleSensitivities(), and sensitivityBezierFI::read().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName()

TypeName

(

"volumetricBSplinesFI"

)

readDict()

bool readDict ( const dictionary &  dict )

virtual

Reimplemented from sensitivity.

Definition at line 113 of file FIBaseIncompressible.C.

References sensitivity::dict(), FIBase::eikonalSolver_, and sensitivity::readDict().

Here is the call graph for this function:

accumulateIntegrand()

void accumulateIntegrand ( const scalar  dt )

virtual

Implements shapeSensitivities.

Definition at line 129 of file FIBaseIncompressible.C.

References shapeSensitivities::accumulateBCSensitivityIntegrand(), shapeSensitivities::accumulateDirectSensitivityIntegrand(), adjointSensitivity::adjointVars_, adjointSensitivity::computeGradDxDbMultiplier(), FIBase::divDxDbMult_, FIBase::eikonalSolver_, Foam::func(), objectiveManager::getObjectiveFunctions(), FIBase::gradDxDbMult_, FIBase::includeDistance_, sensitivity::mesh_, options::New(), adjointSensitivity::objectiveManager_, FIBase::optionsDxDbMult_, optionList::postProcessSens(), variablesSet::solverName(), and Foam::T().

Here is the call graph for this function:

assembleSensitivities()

virtual void assembleSensitivities ( )

pure virtual

Implements shapeSensitivities.

Implemented in sensitivityBezierFI, and sensitivityVolBSplinesFI.

clearSensitivities()

void clearSensitivities ( )

virtual

Reimplemented from shapeSensitivities.

Reimplemented in sensitivityBezierFI, and sensitivityVolBSplinesFI.

Definition at line 163 of file FIBaseIncompressible.C.

References shapeSensitivities::clearSensitivities(), FIBase::divDxDbMult_, FIBase::eikonalSolver_, FIBase::gradDxDbMult_, FIBase::includeDistance_, FIBase::optionsDxDbMult_, VectorSpace< Vector< scalar >, scalar, 3 >::zero, and Foam::Zero.

Referenced by sensitivityVolBSplinesFI::clearSensitivities(), and sensitivityBezierFI::clearSensitivities().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

gradDxDbMult_

volTensorField gradDxDbMult_

protected

Definition at line 62 of file FIBaseIncompressible.H.

Referenced by FIBase::accumulateIntegrand(), sensitivityVolBSplinesFI::assembleSensitivities(), sensitivityBezierFI::assembleSensitivities(), and FIBase::clearSensitivities().

divDxDbMult_

scalarField divDxDbMult_

protected

Definition at line 65 of file FIBaseIncompressible.H.

Referenced by FIBase::accumulateIntegrand(), sensitivityVolBSplinesFI::assembleSensitivities(), sensitivityBezierFI::assembleSensitivities(), and FIBase::clearSensitivities().

optionsDxDbMult_

vectorField optionsDxDbMult_

protected

Definition at line 68 of file FIBaseIncompressible.H.

Referenced by FIBase::accumulateIntegrand(), sensitivityVolBSplinesFI::assembleSensitivities(), sensitivityBezierFI::assembleSensitivities(), and FIBase::clearSensitivities().

includeDistance_

bool includeDistance_

protected

Definition at line 71 of file FIBaseIncompressible.H.

Referenced by FIBase::accumulateIntegrand(), sensitivityVolBSplinesFI::assembleSensitivities(), sensitivityBezierFI::assembleSensitivities(), FIBase::clearSensitivities(), and FIBase::read().

eikonalSolver_

autoPtr<adjointEikonalSolver> eikonalSolver_

protected

Definition at line 74 of file FIBaseIncompressible.H.

Referenced by FIBase::accumulateIntegrand(), sensitivityVolBSplinesFI::assembleSensitivities(), sensitivityBezierFI::assembleSensitivities(), FIBase::clearSensitivities(), FIBase::read(), and FIBase::readDict().

---

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

• src/optimisation/adjointOptimisation/adjoint/optimisation/adjointSensitivity/incompressible/FIBase/FIBaseIncompressible.H
• src/optimisation/adjointOptimisation/adjoint/optimisation/adjointSensitivity/incompressible/FIBase/FIBaseIncompressible.C