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 >:
Collaboration diagram for LduInterfaceField< Type >:

Public Member Functions

 TypeName ("LduInterfaceField")
 Runtime type information. More...
 
 LduInterfaceField (const lduInterface &patch)
 Construct given coupled patch. More...
 
 LduInterfaceField (const LduInterfaceField &)=delete
 Disallow default bitwise copy construction. 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...
 
void operator= (const LduInterfaceField &)=delete
 Disallow default bitwise assignment. More...
 
virtual void initInterfaceMatrixUpdate (scalarField &, const scalarField &, const scalarField &, const direction, const Pstream::commsTypes commsType) const
 Inherit initInterfaceMatrixUpdate from lduInterfaceField. More...
 
virtual void updateInterfaceMatrix (scalarField &, const scalarField &, const scalarField &, const direction, 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...
 
 lduInterfaceField (const lduInterfaceField &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~lduInterfaceField ()
 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...
 
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...
 
void operator= (const lduInterfaceField &)=delete
 Disallow default bitwise assignment. 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 56 of file LduInterfaceField.H.

Constructor & Destructor Documentation

◆ LduInterfaceField() [1/2]

LduInterfaceField ( const lduInterface patch)
inline

Construct given coupled patch.

Definition at line 70 of file LduInterfaceField.H.

◆ LduInterfaceField() [2/2]

LduInterfaceField ( const LduInterfaceField< Type > &  )
delete

Disallow default bitwise copy construction.

◆ ~LduInterfaceField()

Destructor.

Definition at line 29 of file LduInterfaceField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "LduInterfaceField< Type >"  )

Runtime type information.

◆ initInterfaceMatrixUpdate() [1/2]

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 91 of file LduInterfaceField.H.

◆ updateInterfaceMatrix() [1/2]

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 >, cyclicFvPatchField< Type >, jumpCyclicFvPatchField< Type >, and coupledFvPatchField< Type >.

◆ operator=()

void operator= ( const LduInterfaceField< Type > &  )
delete

Disallow default bitwise assignment.

◆ initInterfaceMatrixUpdate() [2/2]

virtual void initInterfaceMatrixUpdate
inline

Inherit initInterfaceMatrixUpdate from lduInterfaceField.

Definition at line 128 of file lduInterfaceField.H.

◆ updateInterfaceMatrix() [2/2]

virtual void updateInterfaceMatrix

Inherit updateInterfaceMatrix from lduInterfaceField.


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