Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
boundaryAdjointContributionIncompressible Class Reference

Contributions of objective function differentiation to adjoint boundary conditions for incompressible flows. More...

Inheritance diagram for boundaryAdjointContributionIncompressible:
[legend]
Collaboration diagram for boundaryAdjointContributionIncompressible:
[legend]

Public Member Functions

 TypeName ("incompressible")
 Runtime type information. More...
 
 boundaryAdjointContributionIncompressible (const word &managerName, const word &adjointSolverName, const word &simulationType, const fvPatch &patch)
 Construct from components. More...
 
virtual ~boundaryAdjointContributionIncompressible ()=default
 Destructor. More...
 
tmp< scalarField > pressureSource ()
 
tmp< vectorField > velocitySource ()
 
tmp< vectorField > tangentVelocitySource ()
 
tmp< vectorField > normalVelocitySource ()
 
tmp< scalarField > energySource ()
 
tmp< scalarField > adjointTMVariable1Source ()
 
tmp< scalarField > adjointTMVariable2Source ()
 
tmp< scalarField > dJdnut ()
 
tmp< tensorField > dJdGradU ()
 
tmp< scalarField > momentumDiffusion ()
 
tmp< scalarField > laminarDiffusivity ()
 
tmp< scalarField > thermalDiffusion ()
 
tmp< scalarField > wallDistance ()
 
tmp< scalarField > TMVariable1Diffusion ()
 
tmp< scalarField > TMVariable2Diffusion ()
 
tmp< scalarField > TMVariable1 ()
 
tmp< scalarField > TMVariable2 ()
 
const fvPatchVectorField & Ub () const
 
const fvPatchScalarField & pb () const
 
const fvsPatchScalarField & phib () const
 
const fvPatchScalarField & turbulentDiffusivity () const
 
const fvPatchVectorField & Uab () const
 
const fvPatchScalarField & pab () const
 
const fvsPatchScalarField & phiab () const
 
const word primalSolverName () const
 
const word adjointSolverName () const
 
const incompressibleVars & primalVars () const
 
const incompressibleAdjointVars & adjointVars () const
 
objectiveManager & getObjectiveManager ()
 
template<class returnType , class sourceType , class castType >
Foam::tmp< Foam::Field< returnType > > sumContributions (PtrList< sourceType > &sourceList, const fvPatchField< returnType > &(castType::*boundaryFunction)(const label))
 
- Public Member Functions inherited from boundaryAdjointContribution
 TypeName ("boundaryAdjointContribution")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, boundaryAdjointContribution, dictionary,(const word &managerName, const word &adjointSolverName, const word &simulationType, const fvPatch &patch),(managerName, adjointSolverName, simulationType, patch))
 
 boundaryAdjointContribution (const word &managerName, const word &adjointSolverName, const word &simulationType, const fvPatch &patch)
 Construct from components. More...
 
virtual ~boundaryAdjointContribution ()=default
 Destructor. More...
 
virtual tmp< scalarField > pressureSource ()=0
 
virtual tmp< vectorField > velocitySource ()=0
 
virtual tmp< vectorField > tangentVelocitySource ()=0
 
virtual tmp< vectorField > normalVelocitySource ()=0
 
virtual tmp< scalarField > adjointTMVariable1Source ()
 
virtual tmp< scalarField > adjointTMVariable2Source ()
 
virtual tmp< scalarField > dJdnut ()
 
virtual tmp< tensorField > dJdGradU ()
 
virtual tmp< scalarField > energySource ()=0
 
virtual tmp< scalarField > momentumDiffusion ()=0
 
virtual tmp< scalarField > laminarDiffusivity ()=0
 
virtual tmp< scalarField > thermalDiffusion ()=0
 
virtual tmp< scalarField > wallDistance ()=0
 
virtual tmp< scalarField > TMVariable1Diffusion ()
 
virtual tmp< scalarField > TMVariable2Diffusion ()
 
virtual tmp< scalarField > TMVariable1 ()
 
virtual tmp< scalarField > TMVariable2 ()
 
virtual const fvPatchVectorField & Ub () const =0
 
virtual const fvPatchScalarField & pb () const =0
 
virtual const fvsPatchScalarField & phib () const =0
 
virtual const fvPatchScalarField & turbulentDiffusivity () const =0
 
virtual const fvPatchVectorField & Uab () const =0
 
virtual const fvPatchScalarField & pab () const =0
 
virtual const fvsPatchScalarField & phiab () const =0
 
virtual const word primalSolverName () const =0
 
virtual const word adjointSolverName () const =0
 

Protected Member Functions

template<class returnType , class sourceType , class castType >
tmp< Field< returnType > > sumContributions (PtrList< sourceType > &sourceList, const fvPatchField< returnType > &(castType::*boundaryFunction)(const label))
 

Protected Attributes

objectiveManager & objectiveManager_
 
const incompressibleVars & primalVars_
 
const incompressibleAdjointSolver & adjointSolver_
 
- Protected Attributes inherited from boundaryAdjointContribution
const fvPatch & patch_
 

Additional Inherited Members

- Static Public Member Functions inherited from boundaryAdjointContribution
static autoPtr< boundaryAdjointContribution > New (const word &managerName, const word &adjointSolverName, const word &simulationType, const fvPatch &patch)
 Return a reference to the selected turbulence model. More...
 

Detailed Description

Contributions of objective function differentiation to adjoint boundary conditions for incompressible flows.

Source files

Definition at line 61 of file boundaryAdjointContributionIncompressible.H.

Constructor & Destructor Documentation

◆ boundaryAdjointContributionIncompressible()

boundaryAdjointContributionIncompressible ( const word &  managerName,
const word &  adjointSolverName,
const word &  simulationType,
const fvPatch &  patch 
)

Construct from components.

Definition at line 52 of file boundaryAdjointContributionIncompressible.C.

◆ ~boundaryAdjointContributionIncompressible()

virtual ~boundaryAdjointContributionIncompressible ( )
virtualdefault

Destructor.

Member Function Documentation

◆ sumContributions() [1/2]

tmp< Field< returnType > > sumContributions ( PtrList< sourceType > &  sourceList,
const fvPatchField< returnType > &(castType::*)(const label)  boundaryFunction 
)
protected

Referenced by boundaryAdjointContributionIncompressible::adjointTMVariable1Source(), boundaryAdjointContributionIncompressible::adjointTMVariable2Source(), boundaryAdjointContributionIncompressible::dJdGradU(), boundaryAdjointContributionIncompressible::dJdnut(), boundaryAdjointContributionIncompressible::energySource(), boundaryAdjointContributionIncompressible::normalVelocitySource(), boundaryAdjointContributionIncompressible::pressureSource(), boundaryAdjointContributionIncompressible::tangentVelocitySource(), and boundaryAdjointContributionIncompressible::velocitySource().

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "incompressible"  )

Runtime type information.

◆ pressureSource()

tmp< scalarField > pressureSource ( )
virtual

Implements boundaryAdjointContribution.

Definition at line 109 of file boundaryAdjointContributionIncompressible.C.

References incompressibleAdjointVars::adjointTurbulence(), boundaryAdjointContributionIncompressible::adjointVars(), objectiveIncompressible::boundarydJdvn(), objectiveManager::getObjectiveFunctions(), fvPatch::index(), fvPatch::nf(), boundaryAdjointContributionIncompressible::objectiveManager_, boundaryAdjointContribution::patch_, tmp< T >::ref(), and boundaryAdjointContributionIncompressible::sumContributions().

Here is the call graph for this function:

◆ velocitySource()

tmp< vectorField > velocitySource ( )
virtual

Implements boundaryAdjointContribution.

Definition at line 89 of file boundaryAdjointContributionIncompressible.C.

References incompressibleAdjointVars::adjointTurbulence(), boundaryAdjointContributionIncompressible::adjointVars(), objectiveIncompressible::boundarydJdv(), objectiveManager::getObjectiveFunctions(), fvPatch::index(), boundaryAdjointContributionIncompressible::objectiveManager_, boundaryAdjointContribution::patch_, tmp< T >::ref(), and boundaryAdjointContributionIncompressible::sumContributions().

Here is the call graph for this function:

◆ tangentVelocitySource()

tmp< vectorField > tangentVelocitySource ( )
virtual

Implements boundaryAdjointContribution.

Definition at line 134 of file boundaryAdjointContributionIncompressible.C.

References incompressibleAdjointVars::adjointTurbulence(), boundaryAdjointContributionIncompressible::adjointVars(), objectiveIncompressible::boundarydJdvt(), objectiveManager::getObjectiveFunctions(), fvPatch::index(), fvPatch::nf(), boundaryAdjointContributionIncompressible::objectiveManager_, boundaryAdjointContribution::patch_, tmp< T >::ref(), and boundaryAdjointContributionIncompressible::sumContributions().

Here is the call graph for this function:

◆ normalVelocitySource()

tmp< vectorField > normalVelocitySource ( )
virtual

Implements boundaryAdjointContribution.

Definition at line 162 of file boundaryAdjointContributionIncompressible.C.

References objectiveIncompressible::boundarydJdp(), objectiveManager::getObjectiveFunctions(), boundaryAdjointContributionIncompressible::objectiveManager_, and boundaryAdjointContributionIncompressible::sumContributions().

Here is the call graph for this function:

◆ energySource()

tmp< scalarField > energySource ( )
virtual

Implements boundaryAdjointContribution.

Definition at line 174 of file boundaryAdjointContributionIncompressible.C.

References objectiveIncompressible::boundarydJdT(), objectiveManager::getObjectiveFunctions(), boundaryAdjointContributionIncompressible::objectiveManager_, and boundaryAdjointContributionIncompressible::sumContributions().

Here is the call graph for this function:

◆ adjointTMVariable1Source()

tmp< scalarField > adjointTMVariable1Source ( )
virtual

Reimplemented from boundaryAdjointContribution.

Definition at line 187 of file boundaryAdjointContributionIncompressible.C.

References objectiveIncompressible::boundarydJdTMvar1(), objectiveManager::getObjectiveFunctions(), boundaryAdjointContributionIncompressible::objectiveManager_, and boundaryAdjointContributionIncompressible::sumContributions().

Here is the call graph for this function:

◆ adjointTMVariable2Source()

tmp< scalarField > adjointTMVariable2Source ( )
virtual

Reimplemented from boundaryAdjointContribution.

Definition at line 200 of file boundaryAdjointContributionIncompressible.C.

References objectiveIncompressible::boundarydJdTMvar2(), objectiveManager::getObjectiveFunctions(), boundaryAdjointContributionIncompressible::objectiveManager_, and boundaryAdjointContributionIncompressible::sumContributions().

Here is the call graph for this function:

◆ dJdnut()

tmp< scalarField > dJdnut ( )
virtual

Reimplemented from boundaryAdjointContribution.

Definition at line 213 of file boundaryAdjointContributionIncompressible.C.

References objectiveIncompressible::boundarydJdnut(), objectiveManager::getObjectiveFunctions(), boundaryAdjointContributionIncompressible::objectiveManager_, and boundaryAdjointContributionIncompressible::sumContributions().

Here is the call graph for this function:

◆ dJdGradU()

tmp< tensorField > dJdGradU ( )
virtual

Reimplemented from boundaryAdjointContribution.

Definition at line 225 of file boundaryAdjointContributionIncompressible.C.

References objectiveIncompressible::boundarydJdGradU(), objectiveManager::getObjectiveFunctions(), boundaryAdjointContributionIncompressible::objectiveManager_, and boundaryAdjointContributionIncompressible::sumContributions().

Here is the call graph for this function:

◆ momentumDiffusion()

tmp< scalarField > momentumDiffusion ( )
virtual

Implements boundaryAdjointContribution.

Definition at line 236 of file boundaryAdjointContributionIncompressible.C.

References incompressibleAdjointVars::adjointTurbulence(), boundaryAdjointContributionIncompressible::adjointVars(), fvPatch::index(), and boundaryAdjointContribution::patch_.

Here is the call graph for this function:

◆ laminarDiffusivity()

tmp< scalarField > laminarDiffusivity ( )
virtual

Implements boundaryAdjointContribution.

Definition at line 243 of file boundaryAdjointContributionIncompressible.C.

References fvPatch::index(), nu, turbulenceModel::nu(), boundaryAdjointContribution::patch_, boundaryAdjointContributionIncompressible::primalVars_, tmp< T >::ref(), fvPatch::size(), incompressibleVars::turbulence(), and Foam::Zero.

Here is the call graph for this function:

◆ thermalDiffusion()

tmp< scalarField > thermalDiffusion ( )
virtual

Implements boundaryAdjointContribution.

Definition at line 257 of file boundaryAdjointContributionIncompressible.C.

References boundaryAdjointContribution::patch_, fvPatch::size(), WarningInFunction, and Foam::Zero.

Here is the call graph for this function:

◆ wallDistance()

tmp< scalarField > wallDistance ( )
virtual

Implements boundaryAdjointContribution.

Definition at line 276 of file boundaryAdjointContributionIncompressible.C.

References fvPatch::index(), boundaryAdjointContribution::patch_, boundaryAdjointContributionIncompressible::primalVars_, and incompressibleVars::turbulence().

Here is the call graph for this function:

◆ TMVariable1Diffusion()

tmp< scalarField > TMVariable1Diffusion ( )
virtual

Reimplemented from boundaryAdjointContribution.

Definition at line 283 of file boundaryAdjointContributionIncompressible.C.

References incompressibleAdjointVars::adjointTurbulence(), boundaryAdjointContributionIncompressible::adjointVars(), fvPatch::index(), and boundaryAdjointContribution::patch_.

Here is the call graph for this function:

◆ TMVariable2Diffusion()

tmp< scalarField > TMVariable2Diffusion ( )
virtual

Reimplemented from boundaryAdjointContribution.

Definition at line 292 of file boundaryAdjointContributionIncompressible.C.

References incompressibleAdjointVars::adjointTurbulence(), boundaryAdjointContributionIncompressible::adjointVars(), fvPatch::index(), and boundaryAdjointContribution::patch_.

Here is the call graph for this function:

◆ TMVariable1()

tmp< scalarField > TMVariable1 ( )
virtual

Reimplemented from boundaryAdjointContribution.

Definition at line 299 of file boundaryAdjointContributionIncompressible.C.

References fvPatch::index(), boundaryAdjointContribution::patch_, boundaryAdjointContributionIncompressible::primalVars_, and incompressibleVars::RASModelVariables().

Here is the call graph for this function:

◆ TMVariable2()

tmp< scalarField > TMVariable2 ( )
virtual

Reimplemented from boundaryAdjointContribution.

Definition at line 307 of file boundaryAdjointContributionIncompressible.C.

References fvPatch::index(), boundaryAdjointContribution::patch_, boundaryAdjointContributionIncompressible::primalVars_, and incompressibleVars::RASModelVariables().

Here is the call graph for this function:

◆ Ub()

const fvPatchVectorField & Ub ( ) const
virtual

Implements boundaryAdjointContribution.

Definition at line 315 of file boundaryAdjointContributionIncompressible.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), fvPatch::index(), boundaryAdjointContribution::patch_, boundaryAdjointContributionIncompressible::primalVars_, and incompressibleVars::U().

Here is the call graph for this function:

◆ pb()

const fvPatchScalarField & pb ( ) const
virtual

Implements boundaryAdjointContribution.

Definition at line 321 of file boundaryAdjointContributionIncompressible.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), fvPatch::index(), incompressibleVars::p(), boundaryAdjointContribution::patch_, and boundaryAdjointContributionIncompressible::primalVars_.

Here is the call graph for this function:

◆ phib()

const fvsPatchScalarField & phib ( ) const
virtual

Implements boundaryAdjointContribution.

Definition at line 328 of file boundaryAdjointContributionIncompressible.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), fvPatch::index(), boundaryAdjointContribution::patch_, incompressibleVars::phi(), and boundaryAdjointContributionIncompressible::primalVars_.

Here is the call graph for this function:

◆ turbulentDiffusivity()

const fvPatchScalarField & turbulentDiffusivity ( ) const
virtual

Implements boundaryAdjointContribution.

Definition at line 335 of file boundaryAdjointContributionIncompressible.C.

References fvPatch::index(), boundaryAdjointContribution::patch_, boundaryAdjointContributionIncompressible::primalVars_, and incompressibleVars::RASModelVariables().

Here is the call graph for this function:

◆ Uab()

const fvPatchVectorField & Uab ( ) const
virtual

Implements boundaryAdjointContribution.

Definition at line 345 of file boundaryAdjointContributionIncompressible.C.

References boundaryAdjointContributionIncompressible::adjointVars(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), fvPatch::index(), boundaryAdjointContribution::patch_, and incompressibleAdjointMeanFlowVars::UaInst().

Here is the call graph for this function:

◆ pab()

const fvPatchScalarField & pab ( ) const
virtual

Implements boundaryAdjointContribution.

Definition at line 351 of file boundaryAdjointContributionIncompressible.C.

References boundaryAdjointContributionIncompressible::adjointVars(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), fvPatch::index(), incompressibleAdjointMeanFlowVars::paInst(), and boundaryAdjointContribution::patch_.

Here is the call graph for this function:

◆ phiab()

const fvsPatchScalarField & phiab ( ) const
virtual

Implements boundaryAdjointContribution.

Definition at line 358 of file boundaryAdjointContributionIncompressible.C.

References boundaryAdjointContributionIncompressible::adjointVars(), GeometricField< Type, PatchField, GeoMesh >::boundaryField(), fvPatch::index(), boundaryAdjointContribution::patch_, and incompressibleAdjointMeanFlowVars::phiaInst().

Here is the call graph for this function:

◆ primalSolverName()

const word primalSolverName ( ) const
virtual

Implements boundaryAdjointContribution.

Definition at line 364 of file boundaryAdjointContributionIncompressible.C.

References boundaryAdjointContributionIncompressible::primalVars_, and variablesSet::solverName().

Here is the call graph for this function:

◆ adjointSolverName()

const word adjointSolverName ( ) const
virtual

Implements boundaryAdjointContribution.

Definition at line 370 of file boundaryAdjointContributionIncompressible.C.

References boundaryAdjointContributionIncompressible::adjointVars(), and variablesSet::solverName().

Here is the call graph for this function:

◆ primalVars()

const incompressibleVars & primalVars ( ) const

Definition at line 377 of file boundaryAdjointContributionIncompressible.C.

References boundaryAdjointContributionIncompressible::primalVars_.

◆ adjointVars()

const incompressibleAdjointVars & adjointVars ( ) const

Definition at line 384 of file boundaryAdjointContributionIncompressible.C.

References boundaryAdjointContributionIncompressible::adjointSolver_, and incompressibleAdjointSolver::getAdjointVars().

Referenced by boundaryAdjointContributionIncompressible::adjointSolverName(), boundaryAdjointContributionIncompressible::momentumDiffusion(), boundaryAdjointContributionIncompressible::pab(), boundaryAdjointContributionIncompressible::phiab(), boundaryAdjointContributionIncompressible::pressureSource(), boundaryAdjointContributionIncompressible::tangentVelocitySource(), boundaryAdjointContributionIncompressible::TMVariable1Diffusion(), boundaryAdjointContributionIncompressible::TMVariable2Diffusion(), boundaryAdjointContributionIncompressible::Uab(), and boundaryAdjointContributionIncompressible::velocitySource().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ getObjectiveManager()

objectiveManager & getObjectiveManager ( )

Definition at line 391 of file boundaryAdjointContributionIncompressible.C.

References boundaryAdjointContributionIncompressible::objectiveManager_.

◆ sumContributions() [2/2]

Foam::tmp< Foam::Field< returnType > > sumContributions ( PtrList< sourceType > &  sourceList,
const fvPatchField< returnType > &(castType::*)(const label)  boundaryFunction 
)

Definition at line 34 of file boundaryAdjointContributionIncompressibleTemplates.C.

References fvPatch::index(), boundaryAdjointContribution::New(), boundaryAdjointContribution::patch_, fvPatch::size(), and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ objectiveManager_

objectiveManager& objectiveManager_
protected

Definition at line 86 of file boundaryAdjointContributionIncompressible.H.

Referenced by boundaryAdjointContributionIncompressible::adjointTMVariable1Source(), boundaryAdjointContributionIncompressible::adjointTMVariable2Source(), boundaryAdjointContributionIncompressible::dJdGradU(), boundaryAdjointContributionIncompressible::dJdnut(), boundaryAdjointContributionIncompressible::energySource(), boundaryAdjointContributionIncompressible::getObjectiveManager(), boundaryAdjointContributionIncompressible::normalVelocitySource(), boundaryAdjointContributionIncompressible::pressureSource(), boundaryAdjointContributionIncompressible::tangentVelocitySource(), and boundaryAdjointContributionIncompressible::velocitySource().

◆ primalVars_

const incompressibleVars& primalVars_
protected

Definition at line 88 of file boundaryAdjointContributionIncompressible.H.

Referenced by boundaryAdjointContributionIncompressible::laminarDiffusivity(), boundaryAdjointContributionIncompressible::pb(), boundaryAdjointContributionIncompressible::phib(), boundaryAdjointContributionIncompressible::primalSolverName(), boundaryAdjointContributionIncompressible::primalVars(), boundaryAdjointContributionIncompressible::TMVariable1(), boundaryAdjointContributionIncompressible::TMVariable2(), boundaryAdjointContributionIncompressible::turbulentDiffusivity(), boundaryAdjointContributionIncompressible::Ub(), and boundaryAdjointContributionIncompressible::wallDistance().

◆ adjointSolver_

const incompressibleAdjointSolver& adjointSolver_
protected

Note: getting a reference to the adjoint vars in the constructor of boundaryAdjointContributionIncompressible is dangerous since the autoPtr that holds them has not been completed yet. Instead, get a reference to the solver and grab the adjoint vars from there, when necessary

Definition at line 95 of file boundaryAdjointContributionIncompressible.H.

Referenced by boundaryAdjointContributionIncompressible::adjointVars().

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