#include <adjointFarFieldVelocityFvPatchVectorField.H>

Inheritance diagram for adjointFarFieldVelocityFvPatchVectorField:

[legend]

Collaboration diagram for adjointFarFieldVelocityFvPatchVectorField:

[legend]

Public Member Functions
	TypeName ("adjointFarFieldVelocity")
	Runtime type information.
	adjointFarFieldVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &)
	Construct from patch and internal field.
	adjointFarFieldVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	adjointFarFieldVelocityFvPatchVectorField (const adjointFarFieldVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given adjointFarFieldVelocityFvPatchVectorField onto a new patch.
	adjointFarFieldVelocityFvPatchVectorField (const adjointFarFieldVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvPatchField< vector > >	clone () const
	Return a clone.
virtual tmp< fvPatchField< vector > >	clone (const DimensionedField< vector, volMesh > &iF) const
	Clone with an internal field reference.
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field.
virtual tmp< Field< vector > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the evaluation of the value of this patchField with given weights.
virtual tmp< Field< vector > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the evaluation of the value of this patchField with given weights.
virtual void	write (Ostream &) const
	Write.
Public Member Functions inherited from adjointBoundaryCondition< vector >
	TypeName ("adjointBoundaryCondition")
	Run-time type information.
	adjointBoundaryCondition (const fvPatch &p, const DimensionedField< vector, volMesh > &iF, const word &solverName)
	Construct from field and base name.
	adjointBoundaryCondition (const adjointBoundaryCondition< vector > &)
	Construct as copy.
virtual	~adjointBoundaryCondition ()=default
	Destructor.
const word &	objectiveManagerName () const
	Return objectiveManager name.
const word &	adjointSolverName () const
	Return adjointSolverName.
const word &	simulationType () const
	Return the simulationType.
void	setBoundaryContributionPtr ()
	Set the ptr to the correct boundaryAdjointContribution.
boundaryAdjointContribution &	getBoundaryAdjContribution ()
	Get boundaryContribution.
const ATCModel &	getATC () const
	ATC type might be useful for a number of BCs. Return here.
virtual tmp< Field< typename Foam::outerProduct< Foam::vector, vector >::type > >	dxdbMult () const
	Return contribution to sensitivity derivatives.
virtual void	updatePrimalBasedQuantities ()
	Update the primal based quantities related to the adjoint boundary conditions.

Additional Inherited Members
Protected Member Functions inherited from adjointBoundaryCondition< vector >
tmp< Field< typename Foam::outerProduct< Foam::vector, Type2 >::type > >	computePatchGrad (word name)
	Get gradient of field on a specific boundary.
bool	addATCUaGradUTerm ()
	Whether to add the extra term from the UaGradU formulation.
Protected Attributes inherited from adjointBoundaryCondition< vector >
const fvPatch &	patch_
	Reference to patch.
word	managerName_
	objectiveManager name corresponding to field
word	adjointSolverName_
	adjointSolver name corresponding to field
word	simulationType_
	simulationType corresponding to field.
autoPtr< boundaryAdjointContribution >	boundaryContrPtr_
	Engine to manage contributions of the objective functions to the adjoint boundary conditions.
Switch	addATCUaGradUTerm_
	Whether to add the extra term from the UaGradU formulation.

Detailed Description

Source files

Definition at line 50 of file adjointFarFieldVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ adjointFarFieldVelocityFvPatchVectorField() [1/4]

adjointFarFieldVelocityFvPatchVectorField	(	const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF )

Construct from patch and internal field.

Definition at line 28 of file adjointFarFieldVelocityFvPatchVectorField.C.

References p.

Referenced by adjointFarFieldVelocityFvPatchVectorField(), adjointFarFieldVelocityFvPatchVectorField(), and TypeName().

Here is the caller graph for this function:

◆ adjointFarFieldVelocityFvPatchVectorField() [2/4]

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

Construct from patch, internal field and dictionary.

Definition at line 54 of file adjointFarFieldVelocityFvPatchVectorField.C.

References dict, IOobjectOption::MUST_READ, and p.

◆ adjointFarFieldVelocityFvPatchVectorField() [3/4]

adjointFarFieldVelocityFvPatchVectorField	(	const adjointFarFieldVelocityFvPatchVectorField &	ptf,
		const fvPatch &	p,
		const DimensionedField< vector, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper )

Construct by mapping given adjointFarFieldVelocityFvPatchVectorField onto a new patch.

Definition at line 40 of file adjointFarFieldVelocityFvPatchVectorField.C.

References adjointFarFieldVelocityFvPatchVectorField(), adjointBoundaryCondition< vector >::adjointSolverName_, and p.

Here is the call graph for this function:

◆ adjointFarFieldVelocityFvPatchVectorField() [4/4]

adjointFarFieldVelocityFvPatchVectorField	(	const adjointFarFieldVelocityFvPatchVectorField &	pivpvf,
		const DimensionedField< vector, volMesh > &	iF )

Construct as copy setting internal field reference.

Definition at line 69 of file adjointFarFieldVelocityFvPatchVectorField.C.

References adjointFarFieldVelocityFvPatchVectorField().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "adjointFarFieldVelocity" )

Runtime type information.

References adjointFarFieldVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ clone() [1/2]

virtual tmp< fvPatchField< vector > > clone ( ) const

inlinevirtual

Return a clone.

Definition at line 108 of file adjointFarFieldVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Clone with an internal field reference.

Definition at line 116 of file adjointFarFieldVelocityFvPatchVectorField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 83 of file adjointFarFieldVelocityFvPatchVectorField.C.

References adjointBoundaryCondition< vector >::boundaryContrPtr_, delta, Foam::neg(), Foam::pos(), and tmp< T >::ref().

Here is the call graph for this function:

◆ valueInternalCoeffs()

Foam::tmp< Foam::Field< Foam::vector > > 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 139 of file adjointFarFieldVelocityFvPatchVectorField.C.

References adjointBoundaryCondition< vector >::boundaryContrPtr_, and Foam::neg().

Here is the call graph for this function:

◆ valueBoundaryCoeffs()

Foam::tmp< Foam::Field< Foam::vector > > 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 158 of file adjointFarFieldVelocityFvPatchVectorField.C.

References adjointBoundaryCondition< vector >::boundaryContrPtr_, and Foam::pos().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 176 of file adjointFarFieldVelocityFvPatchVectorField.C.

References adjointBoundaryCondition< vector >::adjointSolverName_, os(), fvPatchField< Type >::write(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

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

src/optimisation/adjointOptimisation/adjoint/adjointBoundaryConditions/adjointFarFieldVelocity/adjointFarFieldVelocityFvPatchVectorField.H
src/optimisation/adjointOptimisation/adjoint/adjointBoundaryConditions/adjointFarFieldVelocity/adjointFarFieldVelocityFvPatchVectorField.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ adjointFarFieldVelocityFvPatchVectorField() [1/4]

◆ adjointFarFieldVelocityFvPatchVectorField() [2/4]

◆ adjointFarFieldVelocityFvPatchVectorField() [3/4]

◆ adjointFarFieldVelocityFvPatchVectorField() [4/4]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ valueInternalCoeffs()

◆ valueBoundaryCoeffs()

◆ write()