LduInterfaceField< Type > Class Template Reference

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

Inheritance diagram for LduInterfaceField< Type >:

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 ()
	Destructor. More...
virtual void	initInterfaceMatrixUpdate (Field< Type > &, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update. More...
virtual void	updateInterfaceMatrix (Field< Type > &, const Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const =0
	Update result field based on interface functionality. More...
Public Member Functions inherited from lduInterfaceField
	TypeName ("lduInterfaceField")
	Runtime type information. More...
	lduInterfaceField (const lduInterface &patch)
	Construct given coupled patch. More...
virtual	~lduInterfaceField ()
	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 (scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update. More...
virtual void	updateInterfaceMatrix (scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const =0
	Update result field based on interface functionality. 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

• LduInterfaceField.H
• LduInterfaceField.C

Definition at line 56 of file LduInterfaceField.H.

Constructor & Destructor Documentation

LduInterfaceField()

LduInterfaceField ( const lduInterface &  patch )

inline

Construct given coupled patch.

Definition at line 78 of file LduInterfaceField.H.

References LduInterfaceField< Type >::initInterfaceMatrixUpdate(), lduInterfaceField::initInterfaceMatrixUpdate(), and LduInterfaceField< Type >::~LduInterfaceField().

Here is the call graph for this function:

~LduInterfaceField()

~LduInterfaceField ( )

virtual

Destructor.

Definition at line 29 of file LduInterfaceField.C.

Referenced by LduInterfaceField< Type >::LduInterfaceField().

Here is the caller graph for this function:

Member Function Documentation

TypeName()

TypeName

(

"LduInterfaceField< Type >"

)

Runtime type information.

initInterfaceMatrixUpdate()

virtual void initInterfaceMatrixUpdate ( Field< Type > &  , const Field< Type > &  , const scalarField &  , const Pstream::commsTypes  commsType  ) const

inlinevirtual

Initialise neighbour matrix update.

Reimplemented in processorFvPatchField< Type >.

Definition at line 97 of file LduInterfaceField.H.

References LduInterfaceField< Type >::updateInterfaceMatrix(), and lduInterfaceField::updateInterfaceMatrix().

Referenced by LduInterfaceField< Type >::LduInterfaceField().

Here is the call graph for this function:

Here is the caller graph for this function:

updateInterfaceMatrix()

virtual void updateInterfaceMatrix ( Field< Type > &  , const Field< Type > &  , const scalarField &  , const Pstream::commsTypes  commsType  ) const

pure virtual

Update result field based on interface functionality.

Implemented in processorFvPatchField< Type >, coupledFvPatchField< Type >, cyclicAMIFvPatchField< Type >, cyclicFvPatchField< Type >, jumpCyclicAMIFvPatchField< Type >, and jumpCyclicFvPatchField< Type >.

Referenced by LduInterfaceField< Type >::initInterfaceMatrixUpdate().

Here is the caller graph for this function:

---

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

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