Abstract base class for coupled patches. More...

Inheritance diagram for coupledFvPatchField< Type >:

Collaboration diagram for coupledFvPatchField< Type >:

Public Member Functions
	TypeName (coupledFvPatch::typeName_())
	Runtime type information. More...

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	coupledFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...

	coupledFvPatchField (const coupledFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given coupledFvPatchField onto a new patch. More...

	coupledFvPatchField (const coupledFvPatchField< Type > &)
	Construct as copy. More...

virtual tmp< fvPatchField< Type > >	clone () const =0
	Construct and return a clone. More...

	coupledFvPatchField (const coupledFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &) const =0
	Construct and return a clone. More...

virtual bool	coupled () const
	Return true if this patch field is derived from. More...

virtual tmp< Field< Type > >	patchNeighbourField () const =0
	Return neighbour field of internal field. More...

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient. More...

virtual tmp< Field< Type > >	snGrad () const
	Return patch-normal gradient. More...

virtual void	initEvaluate (const Pstream::commsTypes commsType)
	Initialise the evaluation of the patch field. More...

virtual void	evaluate (const Pstream::commsTypes commsType)
	Evaluate the patch field. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

virtual void	updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction, const Pstream::commsTypes commsType) const =0
	Update result field based on interface functionality. More...

virtual void	updateInterfaceMatrix (Field< Type > &, const bool add, const lduAddressing &lduAddr, const label patchId, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const =0
	Update result field based on interface functionality. More...

virtual void	write (Ostream &) const
	Write. More...

Public Member Functions inherited from LduInterfaceField< Type >
	TypeName ("LduInterfaceField")
	Runtime type information. More...

	LduInterfaceField (const lduInterface &patch)
	Construct given coupled patch. More...

virtual	~LduInterfaceField ()=default
	Destructor. More...

virtual void	initInterfaceMatrixUpdate (Field< Type > &, const bool add, const lduAddressing &, const label interfacei, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update. More...

virtual void	initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
	Inherit initInterfaceMatrixUpdate from lduInterfaceField. More...

virtual void	updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const=0
	Inherit updateInterfaceMatrix from lduInterfaceField. More...

Public Member Functions inherited from lduInterfaceField
	TypeName ("lduInterfaceField")
	Runtime type information. More...

	lduInterfaceField (const lduInterface &patch)
	Construct given coupled patch. More...

virtual	~lduInterfaceField ()=default
	Destructor. More...

const lduInterface &	interface () const
	Return the interface. More...

virtual const word &	interfaceFieldType () const
	Return the interface type. More...

bool	updatedMatrix () const
	Whether matrix has been updated. More...

bool &	updatedMatrix ()
	Whether matrix has been updated. More...

virtual bool	ready () const
	Is all data available. More...

virtual void	initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &, const label interfacei, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const

template<class Type >
void	addToInternalField (Field< Type > &result, const bool add, const labelUList &faceCells, const scalarField &coeffs, const Field< Type > &vals) const
	Add/subtract weighted contributions to internal field. More...

Public Member Functions inherited from fvPatchField< Type >
	TypeName ("fvPatchField")
	Runtime type information. More...

	declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))

	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))

	declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)
	Construct from patch, internal field and value. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
	Construct from patch and internal field and patch type. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
	Construct from patch, internal field and dictionary. More...

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fvPatchField onto a new patch. More...

	fvPatchField (const fvPatchField< Type > &)
	Construct as copy. More...

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual	~fvPatchField ()=default
	Destructor. More...

bool	useImplicit () const noexcept
	Use implicit formulation for coupled patches only. More...

bool	useImplicit (bool on) noexcept
	Set useImplicit on/off. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual bool	assignable () const
	Return true if the value of the patch field. More...

const objectRegistry &	db () const
	Return local objectRegistry. More...

const fvPatch &	patch () const
	Return patch. More...

const DimensionedField< Type, volMesh > &	internalField () const
	Return dimensioned internal field reference. More...

const Field< Type > &	primitiveField () const
	Return internal field reference. More...

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

bool	updated () const
	Return true if the boundary condition has already been updated. More...

bool	manipulatedMatrix () const
	Return true if the matrix has already been manipulated. More...

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchField< Type > &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	updateWeightedCoeffs (const scalarField &weights)
	Update the coefficients associated with the patch field. More...

virtual tmp< Field< Type > >	patchInternalField () const
	Return internal field next to patch as patch field. More...

virtual void	patchInternalField (Field< Type > &) const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
	Return the matrix source coefficients corresponding to the. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)
	Manipulate matrix. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
	Manipulate matrix with given weights. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)
	Manipulate fvMatrix. More...

void	check (const fvPatchField< Type > &) const
	Check fvPatchField<Type> against given fvPatchField<Type> More...

virtual void	operator= (const UList< Type > &)

virtual void	operator= (const fvPatchField< Type > &)

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

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

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

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

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

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

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

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

virtual void	operator= (const Type &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const Type &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const scalar)

virtual void	operator== (const fvPatchField< Type > &)

virtual void	operator== (const Field< Type > &)

virtual void	operator== (const Type &)

template<class Type2 >
Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch

typedef calculatedFvPatchField< Type >	Calculated

Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)
	Return a pointer to a new calculatedFvPatchField created on. More...

template<class Type2 >
static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static const word &	calculatedType ()
	Return the type of the calculated for of fvPatchField. More...

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

Detailed Description

template<class Type>
class Foam::coupledFvPatchField< Type >

Abstract base class for coupled patches.

Source files

Definition at line 57 of file coupledFvPatchField.H.

Constructor & Destructor Documentation

◆ coupledFvPatchField() [1/6]

coupledFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct from patch and internal field.

Definition at line 34 of file coupledFvPatchField.C.

◆ coupledFvPatchField() [2/6]

coupledFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const Field< Type > &	f
	)

Construct from patch and internal field and patch field.

Definition at line 46 of file coupledFvPatchField.C.

◆ coupledFvPatchField() [3/6]

coupledFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict,
		const bool	valueRequired = `true`
	)

Construct from patch, internal field and dictionary.

Definition at line 73 of file coupledFvPatchField.C.

◆ coupledFvPatchField() [4/6]

coupledFvPatchField	(	const coupledFvPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping the given coupledFvPatchField onto a new patch.

Definition at line 59 of file coupledFvPatchField.C.

◆ coupledFvPatchField() [5/6]

coupledFvPatchField ( const coupledFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 87 of file coupledFvPatchField.C.

◆ coupledFvPatchField() [6/6]

coupledFvPatchField	(	const coupledFvPatchField< Type > &	ptf,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 98 of file coupledFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( coupledFvPatch::typeName_() )

Runtime type information.

◆ clone() [1/2]

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

pure virtual

Construct and return a clone.

Reimplemented from fvPatchField< Type >.

◆ clone() [2/2]

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

pure virtual

Construct and return a clone.

Reimplemented from fvPatchField< Type >.

Implemented in swirlFanVelocityFvPatchField, fixedJumpFvPatchField< vector >, cyclicFvPatchField< vector >, fanFvPatchField< Type >, fixedJumpFvPatchField< Type >, uniformJumpFvPatchField< Type >, uniformJumpAMIFvPatchField< Type >, cyclicAMIFvPatchField< Type >, fixedJumpAMIFvPatchField< Type >, processorFvPatchField< Type >, cyclicACMIFvPatchField< Type >, cyclicFvPatchField< Type >, calculatedProcessorFvPatchField< Type >, processorCyclicFvPatchField< Type >, cyclicSlipFvPatchField< Type >, nonuniformTransformCyclicFvPatchField< Type >, porousBafflePressureFvPatchField< Type >, fixedJumpFvPatchField< scalar >, cyclicAMIFvPatchField< scalar >, fixedJumpAMIFvPatchField< scalar >, cyclicFvPatchField< scalar >, energyJumpFvPatchScalarField, and energyJumpAMIFvPatchScalarField.

◆ coupled()

virtual bool coupled ( ) const

inlinevirtual

Return true if this patch field is derived from.

coupledFvPatchField<Type>.

Reimplemented from fvPatchField< Type >.

Reimplemented in calculatedProcessorFvPatchField< Type >, cyclicAMIFvPatchField< Type >, cyclicAMIFvPatchField< scalar >, cyclicACMIFvPatchField< Type >, and processorFvPatchField< Type >.

Definition at line 133 of file coupledFvPatchField.H.

◆ patchNeighbourField()

virtual tmp<Field<Type> > patchNeighbourField ( ) const

pure virtual

Return neighbour field of internal field.

Reimplemented from fvPatchField< Type >.

Implemented in calculatedProcessorFvPatchField< Type >, cyclicACMIFvPatchField< Type >, cyclicAMIFvPatchField< Type >, cyclicAMIFvPatchField< scalar >, processorFvPatchField< Type >, cyclicFvPatchField< Type >, cyclicFvPatchField< scalar >, cyclicFvPatchField< vector >, jumpCyclicAMIFvPatchField< Type >, jumpCyclicAMIFvPatchField< scalar >, jumpCyclicFvPatchField< Type >, jumpCyclicFvPatchField< scalar >, and jumpCyclicFvPatchField< vector >.

◆ snGrad() [1/2]

Foam::tmp< Foam::Field< Type > > snGrad ( const scalarField & deltaCoeffs ) const

virtual

Return patch-normal gradient.

Reimplemented from fvPatchField< Type >.

Reimplemented in processorFvPatchField< Type >.

Definition at line 112 of file coupledFvPatchField.C.

◆ snGrad() [2/2]

virtual tmp<Field<Type> > snGrad ( ) const

inlinevirtual

Return patch-normal gradient.

Reimplemented from fvPatchField< Type >.

Definition at line 151 of file coupledFvPatchField.H.

◆ initEvaluate()

void initEvaluate ( const Pstream::commsTypes commsType )

virtual

Initialise the evaluation of the patch field.

Reimplemented from fvPatchField< Type >.

Reimplemented in calculatedProcessorFvPatchField< Type >, and processorFvPatchField< Type >.

Definition at line 123 of file coupledFvPatchField.C.

◆ evaluate()

void evaluate ( const Pstream::commsTypes commsType )

virtual

Evaluate the patch field.

Reimplemented from fvPatchField< Type >.

Reimplemented in calculatedProcessorFvPatchField< Type >, and processorFvPatchField< Type >.

Definition at line 133 of file coupledFvPatchField.C.

◆ valueInternalCoeffs()

Foam::tmp< Foam::Field< Type > > valueInternalCoeffs ( const tmp< scalarField > & w ) const

virtual

Return the matrix diagonal coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Definition at line 153 of file coupledFvPatchField.C.

◆ valueBoundaryCoeffs()

Foam::tmp< Foam::Field< Type > > valueBoundaryCoeffs ( const tmp< scalarField > & w ) const

virtual

Return the matrix source coefficients corresponding to the.

evaluation of the value of this patchField with given weights

Definition at line 164 of file coupledFvPatchField.C.

◆ gradientInternalCoeffs() [1/2]

Foam::tmp< Foam::Field< Type > > gradientInternalCoeffs ( const scalarField & deltaCoeffs ) const

virtual

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from fvPatchField< Type >.

Definition at line 175 of file coupledFvPatchField.C.

◆ gradientInternalCoeffs() [2/2]

Foam::tmp< Foam::Field< Type > > gradientInternalCoeffs ( ) const

virtual

Return the matrix diagonal coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from fvPatchField< Type >.

Definition at line 185 of file coupledFvPatchField.C.

◆ gradientBoundaryCoeffs() [1/2]

Foam::tmp< Foam::Field< Type > > gradientBoundaryCoeffs ( const scalarField & deltaCoeffs ) const

virtual

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from fvPatchField< Type >.

Definition at line 195 of file coupledFvPatchField.C.

◆ gradientBoundaryCoeffs() [2/2]

Foam::tmp< Foam::Field< Type > > gradientBoundaryCoeffs ( ) const

virtual

Return the matrix source coefficients corresponding to the.

evaluation of the gradient of this patchField

Reimplemented from fvPatchField< Type >.

Definition at line 205 of file coupledFvPatchField.C.

◆ updateInterfaceMatrix() [1/2]

virtual void updateInterfaceMatrix	(	solveScalarField &	result,
		const bool	add,
		const lduAddressing &	lduAddr,
		const label	patchId,
		const solveScalarField &	psiInternal,
		const scalarField &	coeffs,
		const	direction,
		const Pstream::commsTypes	commsType
	)		const

pure virtual

Update result field based on interface functionality.

Implements lduInterfaceField.

◆ updateInterfaceMatrix() [2/2]

virtual void updateInterfaceMatrix	(	Field< Type > &	,
		const bool	add,
		const lduAddressing &	lduAddr,
		const label	patchId,
		const Field< Type > &	,
		const scalarField &	,
		const Pstream::commsTypes	commsType
	)		const

pure virtual

Update result field based on interface functionality.

Implements LduInterfaceField< Type >.

Implemented in cyclicFvPatchField< vector >, jumpCyclicFvPatchField< vector >, calculatedProcessorFvPatchField< Type >, processorFvPatchField< Type >, cyclicFvPatchField< Type >, cyclicACMIFvPatchField< Type >, cyclicAMIFvPatchField< Type >, jumpCyclicAMIFvPatchField< Type >, jumpCyclicFvPatchField< Type >, cyclicFvPatchField< scalar >, cyclicAMIFvPatchField< scalar >, jumpCyclicAMIFvPatchField< scalar >, and jumpCyclicFvPatchField< scalar >.

◆ write()

void write ( Ostream & os ) const

virtual

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

src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.H
src/finiteVolume/fields/fvPatchFields/basic/coupled/coupledFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::coupledFvPatchField< Type >

Constructor & Destructor Documentation

◆ coupledFvPatchField() [1/6]

◆ coupledFvPatchField() [2/6]

◆ coupledFvPatchField() [3/6]

◆ coupledFvPatchField() [4/6]

◆ coupledFvPatchField() [5/6]

◆ coupledFvPatchField() [6/6]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ coupled()

◆ patchNeighbourField()

◆ snGrad() [1/2]

◆ snGrad() [2/2]

◆ initEvaluate()

◆ evaluate()

◆ valueInternalCoeffs()

◆ valueBoundaryCoeffs()

◆ gradientInternalCoeffs() [1/2]

◆ gradientInternalCoeffs() [2/2]

◆ gradientBoundaryCoeffs() [1/2]

◆ gradientBoundaryCoeffs() [2/2]

◆ updateInterfaceMatrix() [1/2]

◆ updateInterfaceMatrix() [2/2]

◆ write()

template<class Type>
class Foam::coupledFvPatchField< Type >