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

Inheritance diagram for FIBase:

Collaboration diagram for FIBase:

Public Member Functions
	TypeName ("volumetricBSplinesFI")
	Runtime type information. More...

	FIBase (const fvMesh &mesh, const dictionary &dict, incompressibleAdjointSolver &adjointSolver)
	Construct from components. More...

virtual	~FIBase ()=default
	Destructor. More...

virtual bool	readDict (const dictionary &dict)
	Read dict if changed. More...

virtual void	accumulateIntegrand (const scalar dt)
	Accumulate sensitivity integrands. More...

virtual void	assembleSensitivities ()=0
	Assemble sensitivities. More...

virtual void	clearSensitivities ()
	Zero sensitivity fields and their constituents. More...

Public Member Functions inherited from shapeSensitivities
	TypeName ("shapeSensitivities")
	Runtime type information. More...

	shapeSensitivities (const fvMesh &mesh, const dictionary &dict, incompressibleAdjointSolver &adjointSolver)
	Construct from components. More...

virtual	~shapeSensitivities ()=default
	Destructor. More...

virtual void	accumulateIntegrand (const scalar dt)=0
	Accumulate sensitivity integrands. More...

virtual void	assembleSensitivities ()=0
	Assemble sensitivities. More...

virtual void	clearSensitivities ()
	Zero sensitivity fields and their constituents. More...

virtual void	write (const word &baseName=word::null)
	Write sensitivity fields. More...

Public Member Functions inherited from adjointSensitivity
	TypeName ("adjointSensitivity")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, adjointSensitivity, dictionary,(const fvMesh &mesh, const dictionary &dict, incompressibleAdjointSolver &adjointSolver),(mesh, dict, adjointSolver))

	adjointSensitivity (const fvMesh &mesh, const dictionary &dict, incompressibleAdjointSolver &adjointSolver)
	Construct from components. More...

virtual	~adjointSensitivity ()=default
	Destructor. More...

const incompressibleVars &	primalVars () const
	Get primal variables. More...

const incompressibleAdjointVars &	adjointVars () const
	Get adjoint variables. More...

const incompressibleAdjointSolver &	adjointSolver () const
	Get adjoint solver. More...

virtual void	accumulateIntegrand (const scalar dt)=0
	Accumulate sensitivity integrands. More...

virtual void	assembleSensitivities ()=0
	Assemble sensitivities. More...

virtual const scalarField &	calculateSensitivities ()
	Calculates and returns sensitivity fields. More...

const scalarField &	getSensitivities () const
	Returns the sensitivity fields. More...

virtual void	clearSensitivities ()
	Zero sensitivity fields and their constituents. More...

virtual void	write (const word &baseName=word::null)
	Write sensitivity fields. More...

tmp< volTensorField >	computeGradDxDbMultiplier ()

tmp< volVectorField >	adjointMeshMovementSource ()
	Compute source term for adjoint mesh movement equation. More...

Public Member Functions inherited from sensitivity
	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 Member Functions
void	read ()
	Read options and update solver pointers if necessary. More...

Protected Member Functions inherited from shapeSensitivities
virtual void	accumulateDirectSensitivityIntegrand (const scalar dt)
	Accumulate direct sensitivities. More...

virtual void	accumulateBCSensitivityIntegrand (const scalar dt)
	Accumulate sensitivities enamating from the boundary conditions. More...

tmp< boundaryVectorField >	dvdbMult () const
	Compute multiplier of dv_i/db. More...

Protected Attributes
volTensorField	gradDxDbMult_
	grad(dx/db) multiplier More...

scalarField	divDxDbMult_
	div(dx/db) multiplier More...

vectorField	optionsDxDbMult_
	dx/db multiplier coming from fvOptions More...

bool	includeDistance_
	Include distance variation in sens computation. More...

autoPtr< adjointEikonalSolver >	eikonalSolver_
	Adjoint eikonal equation solver. More...

Protected Attributes inherited from shapeSensitivities
autoPtr< boundaryVectorField >	dSfdbMult_
	Fields related to direct sensitivities. More...

autoPtr< boundaryVectorField >	dnfdbMult_

autoPtr< boundaryVectorField >	dxdbDirectMult_

autoPtr< boundaryVectorField >	bcDxDbMult_

Protected Attributes inherited from adjointSensitivity
scalarField	derivatives_

incompressibleAdjointSolver &	adjointSolver_

const 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, incompressibleAdjointSolver &adjointSolver)
	Return a reference to the selected turbulence model. More...

Detailed Description

Base class for Field Integral-based sensitivity derivatives.

Source files

Definition at line 57 of file FIBaseIncompressible.H.

Constructor & Destructor Documentation

◆ FIBase()

FIBase	(	const fvMesh &	mesh,
		const dictionary &	dict,
		incompressibleAdjointSolver &	adjointSolver
	)

Construct from components.

Definition at line 78 of file FIBaseIncompressible.C.

References FIBase::read().

Here is the call graph for this function:

◆ ~FIBase()

virtual ~FIBase ( )

virtualdefault

Destructor.

Member Function Documentation

◆ read()

void read ( )

protected

Read options and update solver pointers if necessary.

Definition at line 49 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(), FIBase::FIBase(), and sensitivityBezierFI::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "volumetricBSplinesFI" )

Runtime type information.

◆ readDict()

bool readDict ( const dictionary & dict )

virtual

Read dict if changed.

Reimplemented from sensitivity.

Definition at line 111 of file FIBaseIncompressible.C.

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

Here is the call graph for this function:

◆ accumulateIntegrand()

void accumulateIntegrand ( const scalar dt )

virtual

Accumulate sensitivity integrands.

Implements shapeSensitivities.

Definition at line 127 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_, Time::New(), adjointSensitivity::objectiveManager_, FIBase::optionsDxDbMult_, variablesSet::solverName(), and T.

Here is the call graph for this function:

◆ assembleSensitivities()

virtual void assembleSensitivities ( )

pure virtual

Assemble sensitivities.

Implements shapeSensitivities.

Implemented in sensitivityBezierFI, and sensitivityVolBSplinesFI.

◆ clearSensitivities()

void clearSensitivities ( )

virtual

Zero sensitivity fields and their constituents.

Reimplemented from shapeSensitivities.

Reimplemented in sensitivityBezierFI, and sensitivityVolBSplinesFI.

Definition at line 163 of file FIBaseIncompressible.C.

References shapeSensitivities::clearSensitivities(), DimensionedField< Type, GeoMesh >::dimensions(), FIBase::divDxDbMult_, FIBase::eikonalSolver_, FIBase::gradDxDbMult_, FIBase::includeDistance_, FIBase::optionsDxDbMult_, and Foam::Zero.

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

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ gradDxDbMult_

volTensorField gradDxDbMult_

protected

grad(dx/db) multiplier

Definition at line 66 of file FIBaseIncompressible.H.

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

◆ divDxDbMult_

scalarField divDxDbMult_

protected

div(dx/db) multiplier

Definition at line 69 of file FIBaseIncompressible.H.

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

◆ optionsDxDbMult_

vectorField optionsDxDbMult_

protected

dx/db multiplier coming from fvOptions

Definition at line 72 of file FIBaseIncompressible.H.

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

◆ includeDistance_

bool includeDistance_

protected

Include distance variation in sens computation.

Definition at line 75 of file FIBaseIncompressible.H.

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

◆ eikonalSolver_

autoPtr<adjointEikonalSolver> eikonalSolver_

protected

Adjoint eikonal equation solver.

Definition at line 78 of file FIBaseIncompressible.H.

Referenced by FIBase::accumulateIntegrand(), sensitivityBezierFI::assembleSensitivities(), sensitivityVolBSplinesFI::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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FIBase()

◆ ~FIBase()

Member Function Documentation

◆ read()

◆ TypeName()

◆ readDict()

◆ accumulateIntegrand()

◆ assembleSensitivities()

◆ clearSensitivities()

Member Data Documentation

◆ gradDxDbMult_

◆ divDxDbMult_

◆ optionsDxDbMult_

◆ includeDistance_

◆ eikonalSolver_