An abstract base class for implicitly-coupled interface fields e.g. processor and cyclic patch fields. More...

Inheritance diagram for LduInterfaceField< Type >:

[legend]

Collaboration diagram for LduInterfaceField< Type >:

Public Member Functions
	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	updateInterfaceMatrix (Field< Type > &, const bool add, const lduAddressing &, const label interfacei, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const =0
	Update result field based on interface functionality. 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 lduInterfaceField &)=delete
	No copy construct. More...

void	operator= (const lduInterfaceField &)=delete
	No copy assignment. More...

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

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

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

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

virtual bool	ready () const
	Are all (receive) data available? More...

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

bool	updatedMatrix (bool flag) const noexcept
	Set matrix as update-to-date, return the previous value. 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
	Initialise neighbour matrix update. Add/subtract coupled contributions to matrix. 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
	Update result field based on interface functionality. Add/subtract coupled contributions to matrix. More...

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

bool &	updatedMatrix () noexcept
	Adjust whether matrix has been updated. More...

Detailed Description

template<class Type>
class Foam::LduInterfaceField< Type >

An abstract base class for implicitly-coupled interface fields e.g. processor and cyclic patch fields.

Source files

Definition at line 48 of file LduInterfaceField.H.

Constructor & Destructor Documentation

◆ LduInterfaceField()

LduInterfaceField ( const lduInterface & patch )

inline

Construct given coupled patch.

Definition at line 85 of file LduInterfaceField.H.

◆ ~LduInterfaceField()

virtual ~LduInterfaceField ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "LduInterfaceField< Type >" )

Runtime type information.

◆ initInterfaceMatrixUpdate() [1/2]

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

inlinevirtual

Initialise neighbour matrix update.

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

Definition at line 110 of file LduInterfaceField.H.

◆ updateInterfaceMatrix() [1/2]

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

pure virtual

Update result field based on interface functionality.

◆ initInterfaceMatrixUpdate() [2/2]

virtual void initInterfaceMatrixUpdate

inline

Inherit initInterfaceMatrixUpdate from lduInterfaceField.

Definition at line 165 of file lduInterfaceField.H.

◆ updateInterfaceMatrix() [2/2]

virtual void updateInterfaceMatrix

Inherit updateInterfaceMatrix from lduInterfaceField.

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

src/OpenFOAM/matrices/LduMatrix/LduMatrix/LduInterfaceField/LduInterfaceField.H

Public Member Functions