adjointOutletVelocityFvPatchVectorField Class Reference

Provides the adjoint outlet velocity values (i.e. adjoint velocity in case of a zeroGradient U boundary condition). Can have stability issues in cases of backflow of the primal velocity. The adjointOutletVelocityFlux should preferably be used. More...

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

Public Member Functions

 TypeName ("adjointOutletVelocity")
 Runtime type information. More...
 
 adjointOutletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 adjointOutletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 adjointOutletVelocityFvPatchVectorField (const adjointOutletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 
virtual tmp< fvPatchVectorFieldclone () const
 Construct and return a clone. More...
 
 adjointOutletVelocityFvPatchVectorField (const adjointOutletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchVectorFieldclone (const DimensionedField< vector, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual bool assignable () const
 Return true: Allow adjoint solvers to obtain the outlet phia. More...
 
virtual void evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 
virtual void operator= (const fvPatchField< vector > &pvf)
 
 TypeName ("adjointOutletVelocity")
 Runtime type information. More...
 
 adjointOutletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
 Construct from patch and internal field. More...
 
 adjointOutletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 adjointOutletVelocityFvPatchVectorField (const adjointOutletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given adjointOutletVelocityFvPatchVectorField. More...
 
virtual tmp< fvPatchVectorFieldclone () const
 Construct and return a clone. More...
 
 adjointOutletVelocityFvPatchVectorField (const adjointOutletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchVectorFieldclone (const DimensionedField< vector, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from adjointBoundaryCondition< Type >
 TypeName ("adjointBoundaryCondition")
 Run-time type information. More...
 
 adjointBoundaryCondition (const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const word &solverName)
 Construct from field and base name. More...
 
 adjointBoundaryCondition (const adjointBoundaryCondition< Type > &)
 Construct as copy. More...
 
virtual ~adjointBoundaryCondition ()=default
 Destructor. More...
 
const wordobjectiveManagerName () const
 Return objectiveManager name. More...
 
const wordadjointSolverName () const
 Return adjointSolverName. More...
 
const wordsimulationType () const
 Return the simulationType. More...
 
void setBoundaryContributionPtr ()
 Set the ptr to the correct boundaryAdjointContribution. More...
 
boundaryAdjointContributiongetBoundaryAdjContribution ()
 Get boundaryContribution. More...
 
const ATCModelgetATC () const
 ATC type might be useful for a number of BCs. Return here. More...
 
virtual tmp< Field< typename Foam::outerProduct< Foam::vector, Type >::type > > dxdbMult () const
 Return contribution to sensitivity derivatives. More...
 
virtual void updatePrimalBasedQuantities ()
 

Additional Inherited Members

- Protected Member Functions inherited from adjointBoundaryCondition< Type >
template<class Type2 >
tmp< Field< typename Foam::outerProduct< Foam::vector, Type2 >::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 inherited from adjointBoundaryCondition< Type >
const fvPatchpatch_
 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< boundaryAdjointContributionboundaryContrPtr_
 
autoPtr< booladdATCUaGradUTerm_
 Whether to add the extra term from the UaGradU formulation. More...
 

Detailed Description

Provides the adjoint outlet velocity values (i.e. adjoint velocity in case of a zeroGradient U boundary condition). Can have stability issues in cases of backflow of the primal velocity. The adjointOutletVelocityFlux should preferably be used.

Source files

Source files

Definition at line 59 of file adjointOutletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ adjointOutletVelocityFvPatchVectorField() [1/8]

Construct from patch and internal field.

Definition at line 97 of file adjointOutletVelocityFvPatchVectorField.C.

◆ adjointOutletVelocityFvPatchVectorField() [2/8]

adjointOutletVelocityFvPatchVectorField ( const fvPatch p,
const DimensionedField< vector, volMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 123 of file adjointOutletVelocityFvPatchVectorField.C.

References dict, p, and UList< T >::size().

Here is the call graph for this function:

◆ adjointOutletVelocityFvPatchVectorField() [3/8]

Construct by mapping given adjointOutletVelocityFvPatchVectorField onto a new patch

Definition at line 109 of file adjointOutletVelocityFvPatchVectorField.C.

◆ adjointOutletVelocityFvPatchVectorField() [4/8]

Construct as copy setting internal field reference.

Definition at line 141 of file adjointOutletVelocityFvPatchVectorField.C.

◆ adjointOutletVelocityFvPatchVectorField() [5/8]

Construct from patch and internal field.

◆ adjointOutletVelocityFvPatchVectorField() [6/8]

Construct from patch, internal field and dictionary.

◆ adjointOutletVelocityFvPatchVectorField() [7/8]

◆ adjointOutletVelocityFvPatchVectorField() [8/8]

Construct as copy setting internal field reference.

Member Function Documentation

◆ TypeName() [1/2]

TypeName ( "adjointOutletVelocity"  )

Runtime type information.

◆ clone() [1/4]

virtual tmp< fvPatchVectorField > clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 103 of file adjointOutletVelocityFvPatchVectorField.H.

◆ clone() [2/4]

virtual tmp< fvPatchVectorField > clone ( const DimensionedField< vector, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 119 of file adjointOutletVelocityFvPatchVectorField.H.

◆ assignable()

virtual bool assignable ( ) const
inlinevirtual

Return true: Allow adjoint solvers to obtain the outlet phia.

value through HbyA

Definition at line 136 of file adjointOutletVelocityFvPatchVectorField.H.

◆ evaluate()

void evaluate ( const Pstream::commsTypes  commsType = Pstream::commsTypes::blocking)
virtual

Update the coefficients associated with the patch field.

Apply adjoint BCs through evaluate rather than updateCoeffs in order to have the correct Ua boundaryField when computing the adjoint pressure BC

Definition at line 155 of file adjointOutletVelocityFvPatchVectorField.C.

References GeometricBoundaryField< Type, PatchField, GeoMesh >::evaluate().

Here is the call graph for this function:

◆ write() [1/2]

void write ( Ostream os) const
virtual

Write.

Definition at line 165 of file adjointOutletVelocityFvPatchVectorField.C.

References os(), ObukhovLength::write(), and Ostream::writeEntry().

Here is the call graph for this function:

◆ operator=()

void operator= ( const fvPatchField< vector > &  pvf)
virtual

Definition at line 175 of file adjointOutletVelocityFvPatchVectorField.C.

References fvPatchField< Type >::operator=().

Here is the call graph for this function:

◆ TypeName() [2/2]

TypeName ( "adjointOutletVelocity"  )

Runtime type information.

◆ clone() [3/4]

virtual tmp< fvPatchVectorField > clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 88 of file adjointOutletVelocityFvPatchVectorField.H.

◆ clone() [4/4]

virtual tmp< fvPatchVectorField > clone ( const DimensionedField< vector, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 104 of file adjointOutletVelocityFvPatchVectorField.H.

◆ updateCoeffs()

virtual void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

◆ write() [2/2]

virtual void write ( Ostream ) const
virtual

Write.


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