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

Base class for solution control classes. More...

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

Public Member Functions

 TypeName ("adjointBoundaryCondition")
 Run-time type information. More...
 
template<class Type >
 adjointBoundaryCondition (const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const word &solverName)
 Construct from field and base name. More...
 
 adjointBoundaryCondition (const adjointBoundaryCondition &)
 Construct as copy. More...
 
virtual ~adjointBoundaryCondition ()=default
 Destructor. More...
 
const word & objectiveManagerName () const
 Return objectiveManager name. More...
 
const word & adjointSolverName () const
 Return adjointSolverName. More...
 
const word & simulationType () const
 Return the simulationType. More...
 
void setBoundaryContributionPtr ()
 Set the ptr to the correct boundaryAdjointContribution. More...
 
boundaryAdjointContribution & getBoundaryAdjContribution ()
 Get boundaryContribution. More...
 
const ATCModel & getATC () const
 ATC type might be useful for a number of BCs. Return here. More...
 

Protected Member Functions

template<class Type >
tmp< Field< typename Foam::outerProduct< Foam::vector, Type >::type > > computePatchGrad (word name)
 Get gradient of field on a specific boundary. More...
 
bool addATCUaGradUTerm ()
 Whether to add the extra term from the UaGradU formulation. More...
 

Protected Attributes

const fvPatch & patch_
 Reference to patch. More...
 
word managerName_
 objectiveManager name corresponding to field More...
 
word adjointSolverName_
 adjointSolver name corresponding to field More...
 
word simulationType_
 simulationType corresponding to field. More...
 
autoPtr< boundaryAdjointContribution > boundaryContrPtr_
 
autoPtr< bool > addATCUaGradUTerm_
 Whether to add the extra term from the UaGradU formulation. More...
 

Detailed Description

Base class for solution control classes.

Definition at line 51 of file adjointBoundaryCondition.H.

Constructor & Destructor Documentation

◆ adjointBoundaryCondition() [1/2]

adjointBoundaryCondition ( const fvPatch &  p,
const DimensionedField< Type, volMesh > &  iF,
const word &  solverName 
)

Construct from field and base name.

Definition at line 145 of file adjointBoundaryConditionTemplates.C.

◆ adjointBoundaryCondition() [2/2]

adjointBoundaryCondition ( const adjointBoundaryCondition &  adjointBC)

Construct as copy.

Definition at line 58 of file adjointBoundaryCondition.C.

◆ ~adjointBoundaryCondition()

virtual ~adjointBoundaryCondition ( )
virtualdefault

Destructor.

Member Function Documentation

◆ computePatchGrad()

tmp< Field<typename Foam::outerProduct<Foam::vector, Type>::type> > computePatchGrad ( word  name)
protected

Get gradient of field on a specific boundary.

◆ addATCUaGradUTerm()

bool addATCUaGradUTerm ( )
protected

Whether to add the extra term from the UaGradU formulation.

Definition at line 45 of file adjointBoundaryCondition.C.

References adjointBoundaryCondition::addATCUaGradUTerm_, autoPtr< T >::empty(), adjointBoundaryCondition::getATC(), and autoPtr< T >::reset().

Referenced by adjointOutletPressureFvPatchScalarField::updateCoeffs(), and adjointFarFieldPressureFvPatchScalarField::updateCoeffs().

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

◆ TypeName()

TypeName ( "adjointBoundaryCondition"  )

Run-time type information.

◆ objectiveManagerName()

const word & objectiveManagerName ( ) const

Return objectiveManager name.

Definition at line 82 of file adjointBoundaryCondition.C.

References adjointBoundaryCondition::managerName_.

◆ adjointSolverName()

const word & adjointSolverName ( ) const

Return adjointSolverName.

Definition at line 88 of file adjointBoundaryCondition.C.

References adjointBoundaryCondition::adjointSolverName_.

◆ simulationType()

const word & simulationType ( ) const

Return the simulationType.

Definition at line 94 of file adjointBoundaryCondition.C.

References adjointBoundaryCondition::simulationType_.

◆ setBoundaryContributionPtr()

void setBoundaryContributionPtr ( )

Set the ptr to the correct boundaryAdjointContribution.

Definition at line 100 of file adjointBoundaryCondition.C.

References adjointBoundaryCondition::adjointSolverName_, adjointBoundaryCondition::boundaryContrPtr_, fvPatch::boundaryMesh(), Foam::endl(), objectRegistry::foundObject(), adjointBoundaryCondition::managerName_, fvBoundaryMesh::mesh(), boundaryAdjointContribution::New(), Foam::nl, adjointBoundaryCondition::patch_, adjointBoundaryCondition::simulationType_, and WarningInFunction.

Here is the call graph for this function:

◆ getBoundaryAdjContribution()

boundaryAdjointContribution & getBoundaryAdjContribution ( )

Get boundaryContribution.

Definition at line 132 of file adjointBoundaryCondition.C.

References adjointBoundaryCondition::boundaryContrPtr_.

◆ getATC()

const ATCModel & getATC ( ) const

ATC type might be useful for a number of BCs. Return here.

Definition at line 138 of file adjointBoundaryCondition.C.

References adjointBoundaryCondition::adjointSolverName_, fvPatch::boundaryMesh(), objectRegistry::lookupObject(), fvBoundaryMesh::mesh(), and adjointBoundaryCondition::patch_.

Referenced by adjointBoundaryCondition::addATCUaGradUTerm().

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

Member Data Documentation

◆ patch_

const fvPatch& patch_
protected

Reference to patch.

Definition at line 58 of file adjointBoundaryCondition.H.

Referenced by adjointBoundaryCondition::getATC(), and adjointBoundaryCondition::setBoundaryContributionPtr().

◆ managerName_

word managerName_
protected

objectiveManager name corresponding to field

Definition at line 61 of file adjointBoundaryCondition.H.

Referenced by adjointInletNuaTildaFvPatchScalarField::clone(), adjointBoundaryCondition::objectiveManagerName(), and adjointBoundaryCondition::setBoundaryContributionPtr().

◆ adjointSolverName_

word adjointSolverName_
protected

adjointSolver name corresponding to field

Definition at line 64 of file adjointBoundaryCondition.H.

Referenced by adjointBoundaryCondition::adjointSolverName(), adjointBoundaryCondition::getATC(), adjointBoundaryCondition::setBoundaryContributionPtr(), adjointOutletNuaTildaFvPatchScalarField::write(), adjointFarFieldNuaTildaFvPatchScalarField::write(), adjointInletNuaTildaFvPatchScalarField::write(), and adjointOutletNuaTildaFluxFvPatchScalarField::write().

◆ simulationType_

word simulationType_
protected

simulationType corresponding to field.

A placeholder for now

Definition at line 68 of file adjointBoundaryCondition.H.

Referenced by adjointBoundaryCondition::setBoundaryContributionPtr(), and adjointBoundaryCondition::simulationType().

◆ boundaryContrPtr_

autoPtr<boundaryAdjointContribution> boundaryContrPtr_
protected

Engine to manage contributions of the objective functions to the adjoint boundary conditions

Definition at line 72 of file adjointBoundaryCondition.H.

Referenced by adjointBoundaryCondition::getBoundaryAdjContribution(), adjointBoundaryCondition::setBoundaryContributionPtr(), adjointOutletNuaTildaFvPatchScalarField::updateCoeffs(), adjointFarFieldVelocityFvPatchVectorField::updateCoeffs(), adjointWallVelocityLowReFvPatchVectorField::updateCoeffs(), adjointFarFieldNuaTildaFvPatchScalarField::updateCoeffs(), adjointOutletPressureFvPatchScalarField::updateCoeffs(), adjointInletVelocityFvPatchVectorField::updateCoeffs(), adjointOutletVelocityFluxFvPatchVectorField::updateCoeffs(), adjointWallVelocityFvPatchVectorField::updateCoeffs(), and adjointFarFieldPressureFvPatchScalarField::updateCoeffs().

◆ addATCUaGradUTerm_

autoPtr<bool> addATCUaGradUTerm_
protected

Whether to add the extra term from the UaGradU formulation.

autoPtr since ATCModel has not been allocated at the time adjointBoundaryConditions are constructed

Definition at line 78 of file adjointBoundaryCondition.H.

Referenced by adjointBoundaryCondition::addATCUaGradUTerm().

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