sensitivitySurfacePoints Class Reference

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

Inheritance diagram for sensitivitySurfacePoints:

Collaboration diagram for sensitivitySurfacePoints:

Public Member Functions
	TypeName ("surfacePoints")
	sensitivitySurfacePoints (const fvMesh &mesh, const dictionary &dict, incompressibleVars &primalVars, incompressibleAdjointVars &adjointVars, objectiveManager &objectiveManager)
virtual	~sensitivitySurfacePoints ()=default
virtual bool	readDict (const dictionary &dict)
virtual void	accumulateIntegrand (const scalar dt)
virtual void	assembleSensitivities ()
virtual void	clearSensitivities ()
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 ()
void	finaliseFaceMultiplier ()
void	finalisePointSensitivities ()
void	constructGlobalPointNormalsAndAreas (vectorField &pointNormals, scalarField &pointMagSf)
void	setSuffixName ()

Protected Attributes
bool	includeSurfaceArea_
bool	includePressureTerm_
bool	includeGradStressTerm_
bool	includeTransposeStresses_
bool	useSnGradInTranposeStresses_
bool	includeDivTerm_
bool	includeDistance_
bool	includeMeshMovement_
bool	includeObjective_
autoPtr< adjointEikonalSolver >	eikonalSolver_
autoPtr< adjointMeshMovementSolver >	meshMovementSolver_
autoPtr< boundaryVectorField >	wallFaceSens_
autoPtr< boundaryVectorField >	dSfdbMult_
autoPtr< boundaryVectorField >	dnfdbMult_
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

Calculation of adjoint based sensitivities at wall points.

Source files

• sensitivitySurfacePointsIncompressible.H
• sensitivitySurfacePoints.C

Definition at line 55 of file sensitivitySurfacePointsIncompressible.H.

Constructor & Destructor Documentation

sensitivitySurfacePoints()

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

Definition at line 326 of file sensitivitySurfacePointsIncompressible.C.

References nPoints, Foam::read(), Foam::returnReduce(), and Foam::Zero.

Here is the call graph for this function:

~sensitivitySurfacePoints()

virtual ~sensitivitySurfacePoints ( )

virtualdefault

Member Function Documentation

read()

void read ( )

protected

Definition at line 47 of file sensitivitySurfacePointsIncompressible.C.

References incompressibleAdjointVars::adjointTurbulence(), adjointSensitivity::adjointVars_, sensitivity::dict(), sensitivitySurfacePoints::eikonalSolver_, dictionary::getOrDefault(), sensitivitySurfacePoints::includeDistance_, sensitivitySurfacePoints::includeDivTerm_, sensitivitySurfacePoints::includeGradStressTerm_, sensitivitySurfacePoints::includeMeshMovement_, sensitivitySurfacePoints::includeObjective_, sensitivitySurfacePoints::includePressureTerm_, sensitivitySurfacePoints::includeSurfaceArea_, sensitivitySurfacePoints::includeTransposeStresses_, sensitivity::mesh_, sensitivitySurfacePoints::meshMovementSolver_, adjointSensitivity::primalVars_, incompressibleVars::RASModelVariables(), and sensitivitySurfacePoints::useSnGradInTranposeStresses_.

Here is the call graph for this function:

finaliseFaceMultiplier()

void finaliseFaceMultiplier ( )

protected

Definition at line 105 of file sensitivitySurfacePointsIncompressible.C.

References fvMesh::boundary(), sensitivitySurfacePoints::dnfdbMult_, sensitivitySurfacePoints::eikonalSolver_, sensitivitySurfacePoints::includeDistance_, sensitivitySurfacePoints::includeMeshMovement_, sensitivity::mesh_, sensitivitySurfacePoints::meshMovementSolver_, Foam::foamVersion::patch, autoPtr::reset(), and sensitivitySurfacePoints::wallFaceSens_.

Referenced by sensitivitySurfacePoints::assembleSensitivities().

Here is the call graph for this function:

Here is the caller graph for this function:

finalisePointSensitivities()

void finalisePointSensitivities ( )

protected

Definition at line 166 of file sensitivitySurfacePointsIncompressible.C.

References fvMesh::boundary(), sensitivitySurfacePoints::dnfdbMult_, sensitivitySurfacePoints::dSfdbMult_, polyMesh::faces(), forAll, Tensor::I, sensitivitySurfacePoints::includeObjective_, deltaBoundary::makeFaceCentresAndAreas_d(), sensitivity::mesh_, p, Foam::foamVersion::patch, face::points(), polyMesh::points(), sensitivitySurfacePoints::wallFaceSens_, and Foam::Zero.

Referenced by sensitivitySurfacePoints::assembleSensitivities().

Here is the call graph for this function:

Here is the caller graph for this function:

constructGlobalPointNormalsAndAreas()

void constructGlobalPointNormalsAndAreas ( vectorField &  pointNormals, scalarField &  pointMagSf  )

protected

Definition at line 252 of file sensitivitySurfacePointsIncompressible.C.

References forAll, Foam::foamVersion::patch, syncTools::syncPointList(), and VectorSpace< Vector< scalar >, scalar, 3 >::zero.

Referenced by sensitivitySurfacePoints::assembleSensitivities().

Here is the call graph for this function:

Here is the caller graph for this function:

setSuffixName()

void setSuffixName ( )

protected

Definition at line 302 of file sensitivitySurfacePointsIncompressible.C.

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

Referenced by sensitivitySurfacePoints::write().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName()

TypeName

(

"surfacePoints"

)

readDict()

bool readDict ( const dictionary &  dict )

virtual

Reimplemented from sensitivity.

Definition at line 387 of file sensitivitySurfacePointsIncompressible.C.

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

Here is the call graph for this function:

accumulateIntegrand()

void accumulateIntegrand ( const scalar  dt )

virtual

Implements adjointSensitivity.

Definition at line 408 of file sensitivitySurfacePointsIncompressible.C.

References incompressibleAdjointVars::adjointTurbulence(), adjointSensitivity::adjointVars_, fvMesh::boundary(), GeometricField::boundaryField(), GeometricField::boundaryFieldRef(), GeometricField::component(), DebugInfo, sensitivitySurfacePoints::dnfdbMult_, sensitivitySurfacePoints::dSfdbMult_, sensitivitySurfacePoints::eikonalSolver_, Foam::endl(), forAll, objectiveManager::getObjectiveFunctions(), Foam::fvc::grad(), sensitivitySurfacePoints::includeDistance_, sensitivitySurfacePoints::includeDivTerm_, sensitivitySurfacePoints::includeGradStressTerm_, sensitivitySurfacePoints::includeMeshMovement_, sensitivitySurfacePoints::includeObjective_, sensitivitySurfacePoints::includePressureTerm_, sensitivitySurfacePoints::includeTransposeStresses_, sensitivity::mesh_, sensitivitySurfacePoints::meshMovementSolver_, adjointSensitivity::objectiveManager_, p, incompressibleVars::p(), incompressibleAdjointMeanFlowVars::pa(), Foam::foamVersion::patch, adjointSensitivity::primalVars_, Foam::T(), U, incompressibleVars::U(), incompressibleAdjointMeanFlowVars::Ua(), sensitivitySurfacePoints::useSnGradInTranposeStresses_, sensitivitySurfacePoints::wallFaceSens_, and Foam::Zero.

Here is the call graph for this function:

assembleSensitivities()

void assembleSensitivities ( )

virtual

Implements adjointSensitivity.

Definition at line 610 of file sensitivitySurfacePointsIncompressible.C.

References polyMesh::boundaryMesh(), sensitivitySurfacePoints::constructGlobalPointNormalsAndAreas(), adjointSensitivity::derivatives_, sensitivitySurfacePoints::finaliseFaceMultiplier(), sensitivitySurfacePoints::finalisePointSensitivities(), forAll, Pstream::gatherList(), sensitivitySurfacePoints::includeSurfaceArea_, Foam::mag(), sensitivity::mesh_, UPstream::myProcNo(), primitiveMesh::nPoints(), UPstream::nProcs(), Foam::foamVersion::patch, Pstream::scatterList(), List::setSize(), syncTools::syncPointList(), VectorSpace< Vector< scalar >, scalar, 3 >::zero, and Foam::Zero.

Here is the call graph for this function:

clearSensitivities()

void clearSensitivities ( )

virtual

Reimplemented from adjointSensitivity.

Definition at line 728 of file sensitivitySurfacePointsIncompressible.C.

References adjointSensitivity::clearSensitivities(), shapeSensitivitiesBase::clearSensitivities(), sensitivitySurfacePoints::dnfdbMult_, sensitivitySurfacePoints::dSfdbMult_, sensitivitySurfacePoints::eikonalSolver_, sensitivitySurfacePoints::includeDistance_, sensitivitySurfacePoints::includeMeshMovement_, sensitivitySurfacePoints::meshMovementSolver_, sensitivitySurfacePoints::wallFaceSens_, and VectorSpace< Vector< scalar >, scalar, 3 >::zero.

Here is the call graph for this function:

write()

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

virtual

Reimplemented from adjointSensitivity.

Definition at line 751 of file sensitivitySurfacePointsIncompressible.C.

References sensitivitySurfacePoints::setSuffixName(), adjointSensitivity::write(), and shapeSensitivitiesBase::write().

Here is the call graph for this function:

Member Data Documentation

includeSurfaceArea_

bool includeSurfaceArea_

protected

Definition at line 66 of file sensitivitySurfacePointsIncompressible.H.

Referenced by sensitivitySurfacePoints::assembleSensitivities(), and sensitivitySurfacePoints::read().

includePressureTerm_

bool includePressureTerm_

protected

Definition at line 69 of file sensitivitySurfacePointsIncompressible.H.

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

includeGradStressTerm_

bool includeGradStressTerm_

protected

Definition at line 72 of file sensitivitySurfacePointsIncompressible.H.

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

includeTransposeStresses_

bool includeTransposeStresses_

protected

Definition at line 75 of file sensitivitySurfacePointsIncompressible.H.

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

useSnGradInTranposeStresses_

bool useSnGradInTranposeStresses_

protected

Definition at line 78 of file sensitivitySurfacePointsIncompressible.H.

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

includeDivTerm_

bool includeDivTerm_

protected

Definition at line 81 of file sensitivitySurfacePointsIncompressible.H.

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

includeDistance_

bool includeDistance_

protected

Definition at line 84 of file sensitivitySurfacePointsIncompressible.H.

Referenced by sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurfacePoints::clearSensitivities(), sensitivitySurfacePoints::finaliseFaceMultiplier(), and sensitivitySurfacePoints::read().

includeMeshMovement_

bool includeMeshMovement_

protected

Definition at line 87 of file sensitivitySurfacePointsIncompressible.H.

Referenced by sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurfacePoints::clearSensitivities(), sensitivitySurfacePoints::finaliseFaceMultiplier(), sensitivitySurfacePoints::read(), and sensitivitySurfacePoints::setSuffixName().

includeObjective_

bool includeObjective_

protected

Definition at line 90 of file sensitivitySurfacePointsIncompressible.H.

Referenced by sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurfacePoints::finalisePointSensitivities(), and sensitivitySurfacePoints::read().

eikonalSolver_

autoPtr<adjointEikonalSolver> eikonalSolver_

protected

Definition at line 92 of file sensitivitySurfacePointsIncompressible.H.

Referenced by sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurfacePoints::clearSensitivities(), sensitivitySurfacePoints::finaliseFaceMultiplier(), sensitivitySurfacePoints::read(), and sensitivitySurfacePoints::readDict().

meshMovementSolver_

autoPtr<adjointMeshMovementSolver> meshMovementSolver_

protected

Definition at line 94 of file sensitivitySurfacePointsIncompressible.H.

Referenced by sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurfacePoints::clearSensitivities(), sensitivitySurfacePoints::finaliseFaceMultiplier(), sensitivitySurfacePoints::read(), and sensitivitySurfacePoints::readDict().

wallFaceSens_

autoPtr<boundaryVectorField> wallFaceSens_

protected

Definition at line 101 of file sensitivitySurfacePointsIncompressible.H.

Referenced by sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurfacePoints::clearSensitivities(), sensitivitySurfacePoints::finaliseFaceMultiplier(), and sensitivitySurfacePoints::finalisePointSensitivities().

dSfdbMult_

autoPtr<boundaryVectorField> dSfdbMult_

protected

Definition at line 104 of file sensitivitySurfacePointsIncompressible.H.

Referenced by sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurfacePoints::clearSensitivities(), and sensitivitySurfacePoints::finalisePointSensitivities().

dnfdbMult_

autoPtr<boundaryVectorField> dnfdbMult_

protected

Definition at line 105 of file sensitivitySurfacePointsIncompressible.H.

Referenced by sensitivitySurfacePoints::accumulateIntegrand(), sensitivitySurfacePoints::clearSensitivities(), sensitivitySurfacePoints::finaliseFaceMultiplier(), and sensitivitySurfacePoints::finalisePointSensitivities().

---

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

• src/optimisation/adjointOptimisation/adjoint/optimisation/adjointSensitivity/incompressible/sensitivitySurfacePoints/sensitivitySurfacePointsIncompressible.H
• src/optimisation/adjointOptimisation/adjoint/optimisation/adjointSensitivity/incompressible/sensitivitySurfacePoints/sensitivitySurfacePointsIncompressible.C