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 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 lduInterface &patch)
 Construct given coupled patch. More...
 
virtual ~lduInterfaceField ()=default
 Destructor. More...
 
const lduInterfaceinterface () const
 Return the interface. More...
 
virtual const wordinterfaceFieldType () const
 Return the interface type. More...
 
bool updatedMatrix () const
 Whether matrix has been updated. More...
 
boolupdatedMatrix ()
 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
 
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
 
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...
 

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 lduAddressing ,
const label  interfacei,
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 99 of file LduInterfaceField.H.

◆ updateInterfaceMatrix() [1/2]

◆ initInterfaceMatrixUpdate() [2/2]

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
inlinevirtual

Inherit initInterfaceMatrixUpdate from lduInterfaceField.

Reimplemented from lduInterfaceField.

Definition at line 138 of file lduInterfaceField.H.

◆ updateInterfaceMatrix() [2/2]


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