Public Member Functions | List of all members
LduInterfaceField< Type > Class Template Referenceabstract

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 >:
[legend]

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 Field< Type > &, const scalarField &, const Pstream::commsTypes commsType) const
 Initialise neighbour matrix update. More...
 
virtual void updateInterfaceMatrix (Field< Type > &, const bool add, 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 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 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 solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
 
virtual void updateInterfaceMatrix (solveScalarField &result, const bool add, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const =0
 
template<class Type >
void addToInternalField (Field< Type > &result, const bool add, const scalarField &coeffs, const Field< Type > &vals) const
 Add/subtract weighted contributions to internal field. 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 59 of file LduInterfaceField.H.

Constructor & Destructor Documentation

◆ LduInterfaceField()

LduInterfaceField ( const lduInterface &  patch)
inline

Construct given coupled patch.

Definition at line 81 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 Field< Type > &  ,
const scalarField &  ,
const Pstream::commsTypes  commsType 
) const
inlinevirtual

Initialise neighbour matrix update.

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

Definition at line 100 of file LduInterfaceField.H.

◆ updateInterfaceMatrix() [1/2]

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

Update result field based on interface functionality.

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

◆ initInterfaceMatrixUpdate() [2/2]

virtual void initInterfaceMatrixUpdate
inline

Inherit initInterfaceMatrixUpdate from lduInterfaceField.

Definition at line 139 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: