Inheritance diagram for adjointFarFieldPressureFvPatchScalarField:

Collaboration diagram for adjointFarFieldPressureFvPatchScalarField:

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 this_bctype &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping onto a new patch. More...

	adjointFarFieldPressureFvPatchScalarField (const this_bctype &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. More...

	adjointFarFieldPressureFvPatchScalarField (const this_bctype &)=delete
	No copy without an internal field. More...

virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Clone with an internal field reference. More...

virtual tmp< Field< scalar > >	snGrad () const
	Return true if this patch field fixes a value. More...

virtual void	snGrad (UList< scalar > &result) const
	Retrieve patch-normal gradient [contiguous storage]. 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. More...

virtual tmp< Field< scalar > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the evaluation of the gradient of this patchField. More...

virtual tmp< Field< scalar > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the evaluation of the gradient of this patchField. More...

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...

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

Constructor & Destructor Documentation

◆ adjointFarFieldPressureFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 34 of file adjointFarFieldPressureFvPatchScalarField.C.

◆ adjointFarFieldPressureFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 60 of file adjointFarFieldPressureFvPatchScalarField.C.

References dict.

◆ adjointFarFieldPressureFvPatchScalarField() [3/5]

adjointFarFieldPressureFvPatchScalarField	(	const this_bctype &	ptf,
		const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping onto a new patch.

Definition at line 46 of file adjointFarFieldPressureFvPatchScalarField.C.

◆ adjointFarFieldPressureFvPatchScalarField() [4/5]

adjointFarFieldPressureFvPatchScalarField	(	const this_bctype &	tppsf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 75 of file adjointFarFieldPressureFvPatchScalarField.C.

◆ adjointFarFieldPressureFvPatchScalarField() [5/5]

adjointFarFieldPressureFvPatchScalarField ( const this_bctype & )

delete

No copy without an internal field.

Member Function Documentation

◆ TypeName()

TypeName ( "adjointFarFieldPressure" )

Runtime type information.

◆ clone()

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

inlinevirtual

Clone with an internal field reference.

Definition at line 116 of file adjointFarFieldPressureFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ snGrad() [1/2]

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 161 of file adjointFarFieldPressureFvPatchScalarField.C.

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

Here is the call graph for this function:

◆ snGrad() [2/2]

void snGrad ( UList< scalar > & result ) const

virtual

Retrieve patch-normal gradient [contiguous storage].

Definition at line 176 of file adjointFarFieldPressureFvPatchScalarField.C.

References UList< T >::deepCopy(), 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 191 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 209 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 226 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 242 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 87 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 257 of file adjointFarFieldPressureFvPatchScalarField.C.

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

Here is the call graph for this function:

◆ operator=() [1/3]

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

virtual

Definition at line 268 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 280 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::check(), 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 293 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::check(), 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 306 of file adjointFarFieldPressureFvPatchScalarField.C.

References Foam::check(), 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 319 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 338 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 357 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 369 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 381 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 393 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 405 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 417 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 429 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 445 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 457 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:

src/optimisation/adjointOptimisation/adjoint/adjointBoundaryConditions/adjointFarFieldPressure/adjointFarFieldPressureFvPatchScalarField.H
src/optimisation/adjointOptimisation/adjoint/adjointBoundaryConditions/adjointFarFieldPressure/adjointFarFieldPressureFvPatchScalarField.C

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ adjointFarFieldPressureFvPatchScalarField() [1/5]

◆ adjointFarFieldPressureFvPatchScalarField() [2/5]

◆ adjointFarFieldPressureFvPatchScalarField() [3/5]

◆ adjointFarFieldPressureFvPatchScalarField() [4/5]

◆ adjointFarFieldPressureFvPatchScalarField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone()

◆ snGrad() [1/2]

◆ snGrad() [2/2]

◆ valueInternalCoeffs()

◆ valueBoundaryCoeffs()

◆ gradientInternalCoeffs()

◆ gradientBoundaryCoeffs()

◆ updateCoeffs()

◆ write()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator+=() [1/3]

◆ operator-=() [1/3]

◆ operator*=() [1/3]

◆ operator/=() [1/3]

◆ operator+=() [2/3]

◆ operator-=() [2/3]

◆ operator*=() [2/3]

◆ operator/=() [2/3]

◆ operator=() [3/3]

◆ operator+=() [3/3]

◆ operator-=() [3/3]

◆ operator*=() [3/3]

◆ operator/=() [3/3]