Public Member Functions | List of all members
adjointFarFieldTMVar1FvPatchScalarField Class Reference
Inheritance diagram for adjointFarFieldTMVar1FvPatchScalarField:
Inheritance graph
[legend]
Collaboration diagram for adjointFarFieldTMVar1FvPatchScalarField:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("adjointFarFieldTMVar1")
 Runtime type information. More...
 
 adjointFarFieldTMVar1FvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 adjointFarFieldTMVar1FvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 adjointFarFieldTMVar1FvPatchScalarField (const adjointFarFieldTMVar1FvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given adjointFarFieldTMVar1FvPatchScalarField onto a new patch. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 adjointFarFieldTMVar1FvPatchScalarField (const adjointFarFieldTMVar1FvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, 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 tmp< Field< scalar > > valueInternalCoeffs (const tmp< scalarField > &) const
 Return the matrix diagonal coefficients corresponding to the evaluation of the value of this patchField with given weights. More...
 
virtual tmp< Field< scalar > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 Return the matrix source coefficients corresponding to the evaluation of the value of this patchField with given weights. 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 ()
 Update the primal based quantities related to the adjoint boundary conditions. More...
 

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_
 Engine to manage contributions of the objective functions to the adjoint boundary conditions. More...
 
Switch addATCUaGradUTerm_
 Whether to add the extra term from the UaGradU formulation. More...
 

Detailed Description

Source files

Definition at line 48 of file adjointFarFieldTMVar1FvPatchScalarField.H.

Constructor & Destructor Documentation

◆ adjointFarFieldTMVar1FvPatchScalarField() [1/4]

adjointFarFieldTMVar1FvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 37 of file adjointFarFieldTMVar1FvPatchScalarField.C.

Referenced by adjointFarFieldTMVar1FvPatchScalarField::clone().

Here is the caller graph for this function:

◆ adjointFarFieldTMVar1FvPatchScalarField() [2/4]

adjointFarFieldTMVar1FvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 63 of file adjointFarFieldTMVar1FvPatchScalarField.C.

References dict, and IOobjectOption::MUST_READ.

◆ adjointFarFieldTMVar1FvPatchScalarField() [3/4]

Construct by mapping given adjointFarFieldTMVar1FvPatchScalarField onto a new patch.

Definition at line 49 of file adjointFarFieldTMVar1FvPatchScalarField.C.

◆ adjointFarFieldTMVar1FvPatchScalarField() [4/4]

Construct as copy setting internal field reference.

Definition at line 78 of file adjointFarFieldTMVar1FvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "adjointFarFieldTMVar1"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 97 of file adjointFarFieldTMVar1FvPatchScalarField.H.

References adjointFarFieldTMVar1FvPatchScalarField::adjointFarFieldTMVar1FvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 118 of file adjointFarFieldTMVar1FvPatchScalarField.H.

References adjointFarFieldTMVar1FvPatchScalarField::adjointFarFieldTMVar1FvPatchScalarField().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 90 of file adjointFarFieldTMVar1FvPatchScalarField.C.

References adjointBoundaryCondition< Type >::boundaryContrPtr_, delta, Foam::foamVersion::patch, and Foam::pos().

Here is the call graph for this function:

◆ valueInternalCoeffs()

tmp< Field< scalar > > valueInternalCoeffs ( const tmp< scalarField > &  ) const
virtual

Return the matrix diagonal coefficients corresponding to the evaluation of the value of this patchField with given weights.

Definition at line 124 of file adjointFarFieldTMVar1FvPatchScalarField.C.

References Foam::neg(), and Foam::New().

Here is the call graph for this function:

◆ valueBoundaryCoeffs()

tmp< Field< scalar > > valueBoundaryCoeffs ( const tmp< scalarField > &  ) const
virtual

Return the matrix source coefficients corresponding to the evaluation of the value of this patchField with given weights.

Definition at line 137 of file adjointFarFieldTMVar1FvPatchScalarField.C.

References Foam::New(), and Foam::pos().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

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