Calculation of adjoint based sensitivities at wall faces. More...

Inheritance diagram for sensitivitySurface:

Collaboration diagram for sensitivitySurface:

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

	sensitivitySurface (const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager, fv::optionAdjointList &fvOptionsAdjoint)
	Construct from components. More...

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

void	read ()
	Read controls and update solver pointers if necessary. More...

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

void	computeDerivativesSize ()
	Compute the number of faces on sensitivityPatchIDs_. More...

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

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

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

autoPtr< adjointEikonalSolver > &	getAdjointEikonalSolver ()
	Get adjoint eikonal solver. More...

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

bool	getIncludeObjective () const
	Get access to the includeObjective bool. More...

bool	getIncludeSurfaceArea () const
	Get access to the includeSurfaceArea bool. More...

void	setIncludeObjective (const bool includeObjective)
	Set includeObjective bool. More...

void	setIncludeSurfaceArea (const bool includeSurfaceArea)
	Set includeSurfaceArea bool. More...

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

	declareRunTimeSelectionTable (autoPtr, adjointSensitivity, dictionary,(const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager, fv::optionAdjointList &fvOptionsAdjoint),(mesh, dict, primalVars, adjointVars, objectiveManager, fvOptionsAdjoint))

	adjointSensitivity (const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager, fv::optionAdjointList &fvOptionsAdjoint)
	Construct from components. More...

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

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

const scalarField &	getSensitivities () const
	Returns the 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...

Protected Member Functions
void	addGeometricSens ()

void	setSuffixName ()
	Set suffix name for sensitivity fields. More...

Protected Attributes
bool	includeSurfaceArea_
	Include surface area in sens computation. More...

bool	includePressureTerm_
	Include the adjoint pressure term in sens computation. More...

bool	includeGradStressTerm_
	Include the term containing the grad of the stress at the boundary. More...

bool	includeTransposeStresses_
	Include the transpose part of the adjoint stresses. More...

bool	includeDivTerm_
	Include the term from the deviatoric part of the stresses. More...

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

bool	includeMeshMovement_
	Include mesh movement variation in sens computation. More...

bool	includeObjective_
	Include terms directly emerging from the objective function. More...

bool	writeGeometricInfo_
	Write geometric info for use by external programs. More...

autoPtr< adjointEikonalSolver >	eikonalSolver_

autoPtr< adjointMeshMovementSolver >	meshMovementSolver_

autoPtr< volVectorField >	nfOnPatchPtr_

autoPtr< volVectorField >	SfOnPatchPtr_

autoPtr< volVectorField >	CfOnPatchPtr_

Protected Attributes inherited from adjointSensitivity
scalarField	derivatives_

incompressibleVars &	primalVars_

incompressibleAdjointVars &	adjointVars_

objectiveManager &	objectiveManager_

fv::optionAdjointList &	fvOptionsAdjoint_

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, fv::optionAdjointList &fvOptionsAdjoint)
	Return a reference to the selected turbulence model. More...

Detailed Description

Calculation of adjoint based sensitivities at wall faces.

Source files

Definition at line 59 of file sensitivitySurfaceIncompressible.H.

Constructor & Destructor Documentation

◆ sensitivitySurface()

sensitivitySurface	(	const fvMesh &	mesh,
		const dictionary &	dict,
		incompressibleVars &	primalVars,
		incompressibleAdjointVars &	adjointVars,
		objectiveManager &	objectiveManager,
		fv::optionAdjointList &	fvOptionsAdjoint
	)

Construct from components.

Definition at line 220 of file sensitivitySurfaceIncompressible.C.

References IOobject::AUTO_WRITE, mesh, IOobject::NO_READ, Foam::read(), and VectorSpace< Vector< scalar >, scalar, 3 >::zero.

Here is the call graph for this function:

◆ ~sensitivitySurface()

virtual ~sensitivitySurface ( )

virtualdefault

Destructor.

Member Function Documentation

◆ addGeometricSens()

void addGeometricSens ( )

protected

Add sensitivities from dSd/db and dnf/db computed at points and mapped to faces

Definition at line 55 of file sensitivitySurfaceIncompressible.C.

References fvMesh::boundary(), polyMesh::boundaryMesh(), polyMesh::faces(), forAll, objectiveManager::getObjectiveFunctions(), Tensor< scalar >::I, sensitivitySurface::includeObjective_, deltaBoundary::makeFaceCentresAndAreas_d(), sensitivity::mesh_, primitiveMesh::nPoints(), adjointSensitivity::objectiveManager_, p, Foam::foamVersion::patch, face::points(), polyMesh::points(), syncTools::syncPointList(), VectorSpace< Vector< scalar >, scalar, 3 >::zero, and Foam::Zero.

Referenced by sensitivitySurface::accumulateIntegrand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSuffixName()

void setSuffixName ( )

protected

Set suffix name for sensitivity fields.

Definition at line 196 of file sensitivitySurfaceIncompressible.C.

References adjointSensitivity::adjointVars_, sensitivity::dict(), sensitivitySurface::includeMeshMovement_, word::null, shapeSensitivitiesBase::setSuffix(), and variablesSet::solverName().

Referenced by sensitivitySurface::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "surface" )

Runtime type information.

◆ read()

void read ( )

Read controls and update solver pointers if necessary.

Definition at line 325 of file sensitivitySurfaceIncompressible.C.

Referenced by SIBase::read().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readDict()

bool readDict ( const dictionary & dict )

virtual

Read dict if changed.

Reimplemented from sensitivity.

Definition at line 381 of file sensitivitySurfaceIncompressible.C.

References sensitivity::dict(), sensitivitySurface::eikonalSolver_, sensitivitySurface::meshMovementSolver_, and sensitivity::readDict().

Referenced by SIBase::readDict().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ computeDerivativesSize()

void computeDerivativesSize ( )

virtual

Compute the number of faces on sensitivityPatchIDs_.

Reimplemented from sensitivity.

Definition at line 402 of file sensitivitySurfaceIncompressible.C.

References fvMesh::boundary(), adjointSensitivity::derivatives_, and sensitivity::mesh_.

Here is the call graph for this function:

◆ accumulateIntegrand()

void accumulateIntegrand ( const scalar dt )

virtual

Accumulate sensitivity integrands.

Implements adjointSensitivity.

Definition at line 413 of file sensitivitySurfaceIncompressible.C.

References sensitivitySurface::addGeometricSens(), incompressibleAdjointVars::adjointTurbulence(), adjointSensitivity::adjointVars_, fvMesh::boundary(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), GeometricField< Type, PatchField, GeoMesh >::component(), DebugInfo, sensitivitySurface::eikonalSolver_, Foam::endl(), forAll, objectiveManager::getObjectiveFunctions(), Foam::fvc::grad(), sensitivitySurface::includeDistance_, sensitivitySurface::includeDivTerm_, sensitivitySurface::includeGradStressTerm_, sensitivitySurface::includeMeshMovement_, sensitivitySurface::includeObjective_, sensitivitySurface::includePressureTerm_, sensitivitySurface::includeTransposeStresses_, Foam::Info, incompressibleVars::laminarTransport(), sensitivity::mesh_, sensitivitySurface::meshMovementSolver_, singlePhaseTransportModel::nu(), adjointSensitivity::objectiveManager_, p, incompressibleVars::p(), incompressibleAdjointMeanFlowVars::pa(), Foam::foamVersion::patch, adjointSensitivity::primalVars_, incompressibleVars::RASModelVariables(), Foam::T(), U, incompressibleVars::U(), incompressibleAdjointMeanFlowVars::Ua(), and Foam::Zero.

Referenced by SIBase::accumulateIntegrand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assembleSensitivities()

void assembleSensitivities ( )

virtual

Assemble sensitivities.

Implements adjointSensitivity.

Definition at line 617 of file sensitivitySurfaceIncompressible.C.

References fvMesh::boundary(), sensitivitySurface::CfOnPatchPtr_, adjointSensitivity::derivatives_, sensitivitySurface::eikonalSolver_, forAll, sensitivitySurface::includeDistance_, sensitivitySurface::includeMeshMovement_, sensitivitySurface::includeSurfaceArea_, sensitivity::mesh_, sensitivitySurface::meshMovementSolver_, sensitivitySurface::nfOnPatchPtr_, Foam::foamVersion::patch, autoPtr< T >::reset(), sensitivitySurface::SfOnPatchPtr_, and sensitivitySurface::writeGeometricInfo_.

Referenced by sensitivityBezier::assembleSensitivities(), and sensitivityVolBSplines::assembleSensitivities().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clearSensitivities()

void clearSensitivities ( )

virtual

Zero sensitivity fields and their constituents.

Reimplemented from adjointSensitivity.

Definition at line 704 of file sensitivitySurfaceIncompressible.C.

References shapeSensitivitiesBase::clearSensitivities(), adjointSensitivity::clearSensitivities(), sensitivitySurface::eikonalSolver_, sensitivitySurface::includeDistance_, sensitivitySurface::includeMeshMovement_, and sensitivitySurface::meshMovementSolver_.

Referenced by SIBase::clearSensitivities().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAdjointEikonalSolver()

autoPtr< adjointEikonalSolver > & getAdjointEikonalSolver ( )

Get adjoint eikonal solver.

Definition at line 721 of file sensitivitySurfaceIncompressible.C.

References sensitivitySurface::eikonalSolver_.

◆ write()

void write ( const word & baseName = word::null )

virtual

Write sensitivity maps.

Reimplemented from adjointSensitivity.

Definition at line 727 of file sensitivitySurfaceIncompressible.C.

References sensitivitySurface::CfOnPatchPtr_, sensitivitySurface::nfOnPatchPtr_, sensitivitySurface::setSuffixName(), sensitivitySurface::SfOnPatchPtr_, shapeSensitivitiesBase::write(), adjointSensitivity::write(), and sensitivitySurface::writeGeometricInfo_.

Referenced by SIBase::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIncludeObjective()

bool getIncludeObjective ( ) const

inline

Get access to the includeObjective bool.

Definition at line 38 of file sensitivitySurfaceIncompressibleI.H.

References sensitivitySurface::includeObjective_.

Referenced by SIBase::read().

Here is the caller graph for this function:

◆ getIncludeSurfaceArea()

bool getIncludeSurfaceArea ( ) const

inline

Get access to the includeSurfaceArea bool.

Definition at line 44 of file sensitivitySurfaceIncompressibleI.H.

References sensitivitySurface::includeSurfaceArea_.

◆ setIncludeObjective()

void setIncludeObjective ( const bool includeObjective )

inline

Set includeObjective bool.

Definition at line 51 of file sensitivitySurfaceIncompressibleI.H.

Referenced by SIBase::read().

Here is the caller graph for this function:

◆ setIncludeSurfaceArea()

void setIncludeSurfaceArea ( const bool includeSurfaceArea )

inline

Set includeSurfaceArea bool.

Definition at line 60 of file sensitivitySurfaceIncompressibleI.H.

Referenced by SIBase::read().

Here is the caller graph for this function:

Member Data Documentation

◆ includeSurfaceArea_

bool includeSurfaceArea_

protected

Include surface area in sens computation.

Definition at line 70 of file sensitivitySurfaceIncompressible.H.

Referenced by sensitivitySurface::assembleSensitivities(), sensitivitySurface::getIncludeSurfaceArea(), and sensitivitySurface::read().

◆ includePressureTerm_

bool includePressureTerm_

protected

Include the adjoint pressure term in sens computation.

Definition at line 73 of file sensitivitySurfaceIncompressible.H.

Referenced by sensitivitySurface::accumulateIntegrand(), and sensitivitySurface::read().

◆ includeGradStressTerm_

bool includeGradStressTerm_

protected

Include the term containing the grad of the stress at the boundary.

Definition at line 76 of file sensitivitySurfaceIncompressible.H.

Referenced by sensitivitySurface::accumulateIntegrand(), and sensitivitySurface::read().

◆ includeTransposeStresses_

bool includeTransposeStresses_

protected

Include the transpose part of the adjoint stresses.

Definition at line 79 of file sensitivitySurfaceIncompressible.H.

Referenced by sensitivitySurface::accumulateIntegrand(), and sensitivitySurface::read().

◆ includeDivTerm_

bool includeDivTerm_

protected

Include the term from the deviatoric part of the stresses.

Definition at line 82 of file sensitivitySurfaceIncompressible.H.

Referenced by sensitivitySurface::accumulateIntegrand(), and sensitivitySurface::read().

◆ includeDistance_

bool includeDistance_

protected

Include distance variation in sens computation.

Definition at line 85 of file sensitivitySurfaceIncompressible.H.

Referenced by sensitivitySurface::accumulateIntegrand(), sensitivitySurface::assembleSensitivities(), sensitivitySurface::clearSensitivities(), and sensitivitySurface::read().

◆ includeMeshMovement_

bool includeMeshMovement_

protected

Include mesh movement variation in sens computation.

Definition at line 88 of file sensitivitySurfaceIncompressible.H.

Referenced by sensitivitySurface::accumulateIntegrand(), sensitivitySurface::assembleSensitivities(), sensitivitySurface::clearSensitivities(), sensitivitySurface::read(), and sensitivitySurface::setSuffixName().

◆ includeObjective_

bool includeObjective_

protected

Include terms directly emerging from the objective function.

Definition at line 91 of file sensitivitySurfaceIncompressible.H.

Referenced by sensitivitySurface::accumulateIntegrand(), sensitivitySurface::addGeometricSens(), sensitivitySurface::getIncludeObjective(), and sensitivitySurface::read().

◆ writeGeometricInfo_

bool writeGeometricInfo_

protected

Write geometric info for use by external programs.

Definition at line 94 of file sensitivitySurfaceIncompressible.H.

Referenced by sensitivitySurface::assembleSensitivities(), sensitivitySurface::read(), and sensitivitySurface::write().

◆ eikonalSolver_

autoPtr<adjointEikonalSolver> eikonalSolver_

protected

Definition at line 96 of file sensitivitySurfaceIncompressible.H.

Referenced by sensitivitySurface::accumulateIntegrand(), sensitivitySurface::assembleSensitivities(), sensitivitySurface::clearSensitivities(), sensitivitySurface::getAdjointEikonalSolver(), sensitivitySurface::read(), and sensitivitySurface::readDict().

◆ meshMovementSolver_

autoPtr<adjointMeshMovementSolver> meshMovementSolver_

protected

Definition at line 98 of file sensitivitySurfaceIncompressible.H.

Referenced by sensitivitySurface::accumulateIntegrand(), sensitivitySurface::assembleSensitivities(), sensitivitySurface::clearSensitivities(), sensitivitySurface::read(), and sensitivitySurface::readDict().

◆ nfOnPatchPtr_

autoPtr<volVectorField> nfOnPatchPtr_

protected

Definition at line 101 of file sensitivitySurfaceIncompressible.H.

Referenced by sensitivitySurface::assembleSensitivities(), and sensitivitySurface::write().

◆ SfOnPatchPtr_

autoPtr<volVectorField> SfOnPatchPtr_

protected

Definition at line 102 of file sensitivitySurfaceIncompressible.H.

Referenced by sensitivitySurface::assembleSensitivities(), and sensitivitySurface::write().

◆ CfOnPatchPtr_

autoPtr<volVectorField> CfOnPatchPtr_

protected

Definition at line 103 of file sensitivitySurfaceIncompressible.H.

Referenced by sensitivitySurface::assembleSensitivities(), and sensitivitySurface::write().

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

src/optimisation/adjointOptimisation/adjoint/optimisation/adjointSensitivity/incompressible/sensitivitySurface/sensitivitySurfaceIncompressible.H
src/optimisation/adjointOptimisation/adjoint/optimisation/adjointSensitivity/incompressible/sensitivitySurface/sensitivitySurfaceIncompressible.C
src/optimisation/adjointOptimisation/adjoint/optimisation/adjointSensitivity/incompressible/sensitivitySurface/sensitivitySurfaceIncompressibleI.H

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sensitivitySurface()

◆ ~sensitivitySurface()

Member Function Documentation

◆ addGeometricSens()

◆ setSuffixName()

◆ TypeName()

◆ read()

◆ readDict()

◆ computeDerivativesSize()

◆ accumulateIntegrand()

◆ assembleSensitivities()

◆ clearSensitivities()

◆ getAdjointEikonalSolver()

◆ write()

◆ getIncludeObjective()

◆ getIncludeSurfaceArea()

◆ setIncludeObjective()

◆ setIncludeSurfaceArea()

Member Data Documentation

◆ includeSurfaceArea_

◆ includePressureTerm_

◆ includeGradStressTerm_

◆ includeTransposeStresses_

◆ includeDivTerm_

◆ includeDistance_

◆ includeMeshMovement_

◆ includeObjective_

◆ writeGeometricInfo_

◆ eikonalSolver_

◆ meshMovementSolver_

◆ nfOnPatchPtr_

◆ SfOnPatchPtr_

◆ CfOnPatchPtr_