adjointFarFieldPressureFvPatchScalarField Class Reference
Inheritance diagram for adjointFarFieldPressureFvPatchScalarField:
[legend]
Collaboration diagram for adjointFarFieldPressureFvPatchScalarField:
[legend]

Public Member Functions

 TypeName ("adjointFarFieldPressure")
 Runtime type information. More...
 
 adjointFarFieldPressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 adjointFarFieldPressureFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 adjointFarFieldPressureFvPatchScalarField (const adjointFarFieldPressureFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given adjointOutletPressureFvPatchScalarField. More...
 
virtual tmp< fvPatchScalarField > clone () const
 Construct and return a clone. More...
 
 adjointFarFieldPressureFvPatchScalarField (const adjointFarFieldPressureFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarField > clone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual tmp< Field< scalar > > snGrad () const
 Return true if this patch field fixes a value. More...
 
virtual tmp< Field< scalar > > valueInternalCoeffs (const tmp< scalarField > &) const
 
virtual tmp< Field< scalar > > valueBoundaryCoeffs (const tmp< scalarField > &) const
 Return the matrix source coefficients corresponding to the. More...
 
virtual tmp< Field< scalar > > gradientInternalCoeffs () const
 
virtual tmp< Field< scalar > > gradientBoundaryCoeffs () const
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 
virtual void operator= (const UList< scalar > &)
 
virtual void operator= (const fvPatchField< scalar > &)
 
virtual void operator+= (const fvPatchField< scalar > &)
 
virtual void operator-= (const fvPatchField< scalar > &)
 
virtual void operator*= (const fvPatchField< scalar > &)
 
virtual void operator/= (const fvPatchField< scalar > &)
 
virtual void operator+= (const Field< scalar > &)
 
virtual void operator-= (const Field< scalar > &)
 
virtual void operator*= (const Field< scalar > &)
 
virtual void operator/= (const Field< scalar > &)
 
virtual void operator= (const scalar)
 
virtual void operator+= (const scalar)
 
virtual void operator-= (const scalar)
 
virtual void operator*= (const scalar)
 
virtual void operator/= (const scalar)
 
- 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 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...
 
virtual tmp< Field< typename Foam::outerProduct< Foam::vector, Type >::type > > dxdbMult () const
 Return contribution to sensitivity derivatives. 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 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

Constructor & Destructor Documentation

◆ adjointFarFieldPressureFvPatchScalarField() [1/4]

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

Construct from patch and internal field.

Definition at line 41 of file adjointFarFieldPressureFvPatchScalarField.C.

Referenced by adjointFarFieldPressureFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ adjointFarFieldPressureFvPatchScalarField() [2/4]

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

Construct from patch, internal field and dictionary.

Definition at line 67 of file adjointFarFieldPressureFvPatchScalarField.C.

References dict, and p.

◆ adjointFarFieldPressureFvPatchScalarField() [3/4]

Construct by mapping given adjointOutletPressureFvPatchScalarField.

onto a new patch

Definition at line 53 of file adjointFarFieldPressureFvPatchScalarField.C.

◆ adjointFarFieldPressureFvPatchScalarField() [4/4]

Construct as copy setting internal field reference.

Definition at line 85 of file adjointFarFieldPressureFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "adjointFarFieldPressure"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 93 of file adjointFarFieldPressureFvPatchScalarField.H.

References adjointFarFieldPressureFvPatchScalarField::adjointFarFieldPressureFvPatchScalarField().

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 110 of file adjointFarFieldPressureFvPatchScalarField.H.

References adjointFarFieldPressureFvPatchScalarField::adjointFarFieldPressureFvPatchScalarField().

Here is the call graph for this function:

◆ snGrad()

Foam::tmp< Foam::Field< Foam::scalar > > snGrad ( ) const
virtual

Return true if this patch field fixes a value.

Needed to check if a level has to be specified while solving Poissons equations. Return gradient at boundary

Definition at line 171 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::foamVersion::patch, and Foam::pos().

Here is the call graph for this function:

◆ valueInternalCoeffs()

Foam::tmp< Foam::Field< Foam::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 187 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::neg().

Here is the call graph for this function:

◆ valueBoundaryCoeffs()

Foam::tmp< Foam::Field< Foam::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 205 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::pos().

Here is the call graph for this function:

◆ gradientInternalCoeffs()

Foam::tmp< Foam::Field< Foam::scalar > > gradientInternalCoeffs ( ) const
virtual

Return the matrix diagonal coefficients corresponding to the evaluation of the gradient of this patchField

Definition at line 222 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::foamVersion::patch, and Foam::pos().

Here is the call graph for this function:

◆ gradientBoundaryCoeffs()

Foam::tmp< Foam::Field< Foam::scalar > > gradientBoundaryCoeffs ( ) const
virtual

Return the matrix source coefficients corresponding to the evaluation of the gradient of this patchField

Definition at line 238 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::foamVersion::patch, and Foam::pos().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 97 of file adjointFarFieldPressureFvPatchScalarField.C.

References adjointBoundaryCondition< Type >::addATCUaGradUTerm(), adjointBoundaryCondition< Type >::boundaryContrPtr_, delta, Foam::neg(), Foam::foamVersion::patch, fvPatchField< Type >::patchInternalField(), Foam::pos(), and tmp< T >::ref().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 253 of file adjointFarFieldPressureFvPatchScalarField.C.

References fvPatchField< scalar >::write(), and Ostream::writeEntry().

Here is the call graph for this function:

◆ operator=() [1/3]

void operator= ( const UList< scalar > &  ul)
virtual

Definition at line 264 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::neg(), Field< Type >::operator=(), and Foam::pos().

Here is the call graph for this function:

◆ operator=() [2/3]

void operator= ( const fvPatchField< scalar > &  ptf)
virtual

Definition at line 276 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::neg(), Field< Type >::operator=(), and Foam::pos().

Here is the call graph for this function:

◆ operator+=() [1/3]

void operator+= ( const fvPatchField< scalar > &  ptf)
virtual

Definition at line 289 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::neg(), Field< Type >::operator=(), and Foam::pos().

Here is the call graph for this function:

◆ operator-=() [1/3]

void operator-= ( const fvPatchField< scalar > &  ptf)
virtual

Definition at line 302 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::neg(), Field< Type >::operator=(), and Foam::pos().

Here is the call graph for this function:

◆ operator*=() [1/3]

void operator*= ( const fvPatchField< scalar > &  ptf)
virtual

Definition at line 315 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::neg(), Field< Type >::operator=(), Foam::foamVersion::patch, and Foam::pos().

Here is the call graph for this function:

◆ operator/=() [1/3]

void operator/= ( const fvPatchField< scalar > &  ptf)
virtual

Definition at line 334 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, Foam::neg(), Field< Type >::operator=(), Foam::foamVersion::patch, and Foam::pos().

Here is the call graph for this function:

◆ operator+=() [2/3]

void operator+= ( const Field< scalar > &  tf)
virtual

Definition at line 353 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::neg(), Field< Type >::operator=(), and Foam::pos().

Here is the call graph for this function:

◆ operator-=() [2/3]

void operator-= ( const Field< scalar > &  tf)
virtual

Definition at line 365 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::neg(), Field< Type >::operator=(), and Foam::pos().

Here is the call graph for this function:

◆ operator*=() [2/3]

void operator*= ( const Field< scalar > &  tf)
virtual

Definition at line 377 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::neg(), Field< Type >::operator=(), and Foam::pos().

Here is the call graph for this function:

◆ operator/=() [2/3]

void operator/= ( const Field< scalar > &  tf)
virtual

Definition at line 389 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::neg(), Field< Type >::operator=(), and Foam::pos().

Here is the call graph for this function:

◆ operator=() [3/3]

void operator= ( const scalar  t)
virtual

Definition at line 401 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::neg(), Field< Type >::operator=(), and Foam::pos().

Here is the call graph for this function:

◆ operator+=() [3/3]

void operator+= ( const scalar  t)
virtual

Definition at line 413 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::neg(), Field< Type >::operator=(), and Foam::pos().

Here is the call graph for this function:

◆ operator-=() [3/3]

void operator-= ( const scalar  t)
virtual

Definition at line 425 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::neg(), Field< Type >::operator=(), and Foam::pos().

Here is the call graph for this function:

◆ operator*=() [3/3]

void operator*= ( const scalar  s)
virtual

Definition at line 441 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::neg(), Field< Type >::operator=(), Foam::pos(), and s.

Here is the call graph for this function:

◆ operator/=() [3/3]

void operator/= ( const scalar  s)
virtual

Definition at line 453 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::neg(), Field< Type >::operator=(), Foam::pos(), and s.

Here is the call graph for this function:

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