Loading...
Searching...
No Matches
boundaryAdjointContribution Class Referenceabstract

Abstract base class for computing contributions of the objective functions to the adjoint boundary conditions. More...

#include <boundaryAdjointContribution.H>

Inheritance diagram for boundaryAdjointContribution:
Inheritance graph
[legend]
Collaboration diagram for boundaryAdjointContribution:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("boundaryAdjointContribution")
 Runtime type information.
 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.
virtual ~boundaryAdjointContribution ()=default
 Destructor.
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 tmp< fvPatchScalarField > turbulentDiffusivity () const
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
template<class returnType, class sourceType, class castType>
Foam::tmp< Foam::Field< returnType > > sumContributions (PtrList< sourceType > &sourceList, const fvPatchField< returnType > &(castType::*boundaryFunction)(const label), bool(castType::*hasFunction)() const)

Static Public Member Functions

static autoPtr< boundaryAdjointContribution > New (const word &managerName, const word &adjointSolverName, const word &simulationType, const fvPatch &patch)
 Return a reference to the selected turbulence model.

Protected Member Functions

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

Protected Attributes

const fvPatch & patch_

Detailed Description

Abstract base class for computing contributions of the objective functions to the adjoint boundary conditions.

Source files

Definition at line 54 of file boundaryAdjointContribution.H.

Constructor & Destructor Documentation

◆ boundaryAdjointContribution()

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

Construct from components.

Definition at line 38 of file boundaryAdjointContribution.C.

References adjointSolverName(), and patch_.

Here is the call graph for this function:

◆ ~boundaryAdjointContribution()

virtual ~boundaryAdjointContribution ( )
virtualdefault

Destructor.

Member Function Documentation

◆ sumContributions() [1/2]

template<class returnType, class sourceType, class castType>
tmp< Field< returnType > > sumContributions ( PtrList< sourceType > & sourceList,
const fvPatchField< returnType > &(castType::* boundaryFunction )(const label),
bool(castType::* hasFunction )() const )
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 ( "boundaryAdjointContribution" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr ,
boundaryAdjointContribution ,
dictionary ,
(const word &managerName, const word &adjointSolverName, const word &simulationType, const fvPatch &patch) ,
(managerName, adjointSolverName, simulationType, patch)  )

References adjointSolverName().

Here is the call graph for this function:

◆ New()

autoPtr< boundaryAdjointContribution > New ( const word & managerName,
const word & adjointSolverName,
const word & simulationType,
const fvPatch & patch )
static

Return a reference to the selected turbulence model.

Definition at line 52 of file boundaryAdjointContribution.C.

References adjointSolverName(), Foam::exit(), Foam::FatalError, and FatalErrorInLookup.

Referenced by adjointSpalartAllmaras::distanceSensitivities(), adjointBoundaryCondition< Type >::setBoundaryContributionPtr(), and sumContributions().

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

◆ pressureSource()

virtual tmp< scalarField > pressureSource ( )
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ velocitySource()

virtual tmp< vectorField > velocitySource ( )
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ tangentVelocitySource()

virtual tmp< vectorField > tangentVelocitySource ( )
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ normalVelocitySource()

virtual tmp< vectorField > normalVelocitySource ( )
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ adjointTMVariable1Source()

tmp< scalarField > adjointTMVariable1Source ( )
virtual

Reimplemented in boundaryAdjointContributionIncompressible.

Definition at line 88 of file boundaryAdjointContribution.C.

References tmp< T >::New(), patch_, and Foam::Zero.

Here is the call graph for this function:

◆ adjointTMVariable2Source()

tmp< scalarField > adjointTMVariable2Source ( )
virtual

Reimplemented in boundaryAdjointContributionIncompressible.

Definition at line 94 of file boundaryAdjointContribution.C.

References tmp< T >::New(), patch_, and Foam::Zero.

Here is the call graph for this function:

◆ dJdnut()

tmp< scalarField > dJdnut ( )
virtual

Reimplemented in boundaryAdjointContributionIncompressible.

Definition at line 100 of file boundaryAdjointContribution.C.

References tmp< T >::New(), patch_, and Foam::Zero.

Here is the call graph for this function:

◆ dJdGradU()

tmp< tensorField > dJdGradU ( )
virtual

Reimplemented in boundaryAdjointContributionIncompressible.

Definition at line 106 of file boundaryAdjointContribution.C.

References tmp< T >::New(), patch_, and Foam::Zero.

Here is the call graph for this function:

◆ energySource()

virtual tmp< scalarField > energySource ( )
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ momentumDiffusion()

virtual tmp< scalarField > momentumDiffusion ( )
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ laminarDiffusivity()

virtual tmp< scalarField > laminarDiffusivity ( )
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ thermalDiffusion()

virtual tmp< scalarField > thermalDiffusion ( )
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ wallDistance()

virtual tmp< scalarField > wallDistance ( )
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ TMVariable1Diffusion()

tmp< scalarField > TMVariable1Diffusion ( )
virtual

Reimplemented in boundaryAdjointContributionIncompressible.

Definition at line 112 of file boundaryAdjointContribution.C.

References tmp< T >::New(), patch_, and Foam::Zero.

Here is the call graph for this function:

◆ TMVariable2Diffusion()

tmp< scalarField > TMVariable2Diffusion ( )
virtual

Reimplemented in boundaryAdjointContributionIncompressible.

Definition at line 118 of file boundaryAdjointContribution.C.

References tmp< T >::New(), patch_, and Foam::Zero.

Here is the call graph for this function:

◆ TMVariable1()

tmp< scalarField > TMVariable1 ( )
virtual

Reimplemented in boundaryAdjointContributionIncompressible.

Definition at line 124 of file boundaryAdjointContribution.C.

References tmp< T >::New(), patch_, and Foam::Zero.

Here is the call graph for this function:

◆ TMVariable2()

tmp< scalarField > TMVariable2 ( )
virtual

Reimplemented in boundaryAdjointContributionIncompressible.

Definition at line 130 of file boundaryAdjointContribution.C.

References tmp< T >::New(), patch_, and Foam::Zero.

Here is the call graph for this function:

◆ Ub()

virtual const fvPatchVectorField & Ub ( ) const
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ pb()

virtual const fvPatchScalarField & pb ( ) const
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ phib()

virtual const fvsPatchScalarField & phib ( ) const
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ turbulentDiffusivity()

tmp< fvPatchScalarField > turbulentDiffusivity ( ) const
virtual

Reimplemented in boundaryAdjointContributionIncompressible.

Definition at line 137 of file boundaryAdjointContribution.C.

References NotImplemented.

◆ Uab()

virtual const fvPatchVectorField & Uab ( ) const
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ pab()

virtual const fvPatchScalarField & pab ( ) const
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ phiab()

virtual const fvsPatchScalarField & phiab ( ) const
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ primalSolverName()

virtual const word primalSolverName ( ) const
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

◆ adjointSolverName()

virtual const word adjointSolverName ( ) const
pure virtual

Implemented in boundaryAdjointContributionIncompressible.

Referenced by boundaryAdjointContribution(), declareRunTimeSelectionTable(), and New().

Here is the caller graph for this function:

◆ sumContributions() [2/2]

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

Definition at line 27 of file boundaryAdjointContributionTemplates.C.

References New(), patch_, Foam::refCast(), and Foam::Zero.

Here is the call graph for this function:

Member Data Documentation

◆ patch_

const fvPatch& patch_
protected

Definition at line 78 of file boundaryAdjointContribution.H.

Referenced by adjointTMVariable1Source(), adjointTMVariable2Source(), boundaryAdjointContribution(), boundaryAdjointContributionIncompressible::boundaryAdjointContributionIncompressible(), dJdGradU(), dJdnut(), boundaryAdjointContributionIncompressible::laminarDiffusivity(), boundaryAdjointContributionIncompressible::momentumDiffusion(), boundaryAdjointContributionIncompressible::pab(), boundaryAdjointContributionIncompressible::pb(), boundaryAdjointContributionIncompressible::phiab(), boundaryAdjointContributionIncompressible::phib(), boundaryAdjointContributionIncompressible::pressureSource(), sumContributions(), boundaryAdjointContributionIncompressible::tangentVelocitySource(), boundaryAdjointContributionIncompressible::thermalDiffusion(), TMVariable1(), boundaryAdjointContributionIncompressible::TMVariable1(), TMVariable1Diffusion(), boundaryAdjointContributionIncompressible::TMVariable1Diffusion(), TMVariable2(), boundaryAdjointContributionIncompressible::TMVariable2(), TMVariable2Diffusion(), boundaryAdjointContributionIncompressible::TMVariable2Diffusion(), boundaryAdjointContributionIncompressible::turbulentDiffusivity(), boundaryAdjointContributionIncompressible::Uab(), boundaryAdjointContributionIncompressible::Ub(), boundaryAdjointContributionIncompressible::velocitySource(), and boundaryAdjointContributionIncompressible::wallDistance().

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