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

Inheritance diagram for lduInterfaceField:

[legend]

Collaboration diagram for lduInterfaceField:

Public Member Functions
	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...

Private Member Functions
	lduInterfaceField (const lduInterfaceField &)
	Disallow default bitwise copy construct. More...

void	operator= (const lduInterfaceField &)
	Disallow default bitwise assignment. More...

Private Attributes
const lduInterface &	interface_
	Reference to the coupled patch this field is defined for. More...

bool	updatedMatrix_
	Update index used so that updateInterfaceMatrix is called only once. More...

Detailed Description

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

Source files

Definition at line 55 of file lduInterfaceField.H.

Constructor & Destructor Documentation

◆ lduInterfaceField() [1/2]

lduInterfaceField ( const lduInterfaceField & )

private

Disallow default bitwise copy construct.

◆ lduInterfaceField() [2/2]

lduInterfaceField ( const lduInterface & patch )

inline

Construct given coupled patch.

Definition at line 85 of file lduInterfaceField.H.

◆ ~lduInterfaceField()

~lduInterfaceField ( )

virtual

Destructor.

Definition at line 38 of file lduInterfaceField.C.

Member Function Documentation

◆ operator=()

void operator= ( const lduInterfaceField & )

private

Disallow default bitwise assignment.

◆ TypeName()

TypeName ( "lduInterfaceField" )

Runtime type information.

◆ interface()

const lduInterface& interface ( ) const

inline

Return the interface.

Definition at line 101 of file lduInterfaceField.H.

References lduInterfaceField::interface_.

◆ interfaceFieldType()

virtual const word& interfaceFieldType ( ) const

inlinevirtual

Return the interface type.

Reimplemented in energyRegionCoupledFvPatchScalarField, jumpCyclicAMIFvPatchField< Type >, and jumpCyclicFvPatchField< Type >.

Definition at line 107 of file lduInterfaceField.H.

References Foam::type().

Referenced by GAMGInterfaceField::New().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updatedMatrix() [1/2]

bool updatedMatrix ( ) const

inline

Whether matrix has been updated.

Definition at line 116 of file lduInterfaceField.H.

References lduInterfaceField::updatedMatrix_.

Referenced by processorGAMGInterfaceField::initInterfaceMatrixUpdate(), processorFvPatchField< Type >::initInterfaceMatrixUpdate(), processorGAMGInterfaceField::updateInterfaceMatrix(), and processorFvPatchField< Type >::updateInterfaceMatrix().

Here is the caller graph for this function:

◆ updatedMatrix() [2/2]

bool& updatedMatrix ( )

inline

Whether matrix has been updated.

Definition at line 122 of file lduInterfaceField.H.

References lduInterfaceField::updatedMatrix_.

◆ ready()

virtual bool ready ( ) const

inlinevirtual

Is all data available.

Reimplemented in processorFvPatchField< Type >.

Definition at line 128 of file lduInterfaceField.H.

◆ initInterfaceMatrixUpdate()

virtual void initInterfaceMatrixUpdate	(	scalarField &	,
		const scalarField &	,
		const scalarField &	,
		const	direction,
		const Pstream::commsTypes	commsType
	)		const

inlinevirtual

Initialise neighbour matrix update.

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

Definition at line 135 of file lduInterfaceField.H.

◆ updateInterfaceMatrix()

virtual void updateInterfaceMatrix	(	scalarField &	,
		const scalarField &	,
		const scalarField &	,
		const	direction,
		const Pstream::commsTypes	commsType
	)		const

pure virtual

Update result field based on interface functionality.

Field Documentation

◆ interface_

const lduInterface& interface_

private

Reference to the coupled patch this field is defined for.

Definition at line 60 of file lduInterfaceField.H.

Referenced by lduInterfaceField::interface().

◆ updatedMatrix_

bool updatedMatrix_

private

Update index used so that updateInterfaceMatrix is called only once.

during the construction of the matrix

Definition at line 64 of file lduInterfaceField.H.

Referenced by lduInterfaceField::updatedMatrix().

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

src/OpenFOAM/matrices/lduMatrix/lduAddressing/lduInterfaceFields/lduInterfaceField/lduInterfaceField.H
src/OpenFOAM/matrices/lduMatrix/lduAddressing/lduInterfaceFields/lduInterfaceField/lduInterfaceField.C

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ lduInterfaceField() [1/2]

◆ lduInterfaceField() [2/2]

◆ ~lduInterfaceField()

Member Function Documentation

◆ operator=()

◆ TypeName()

◆ interface()

◆ interfaceFieldType()

◆ updatedMatrix() [1/2]

◆ updatedMatrix() [2/2]

◆ ready()

◆ initInterfaceMatrixUpdate()

◆ updateInterfaceMatrix()

Field Documentation

◆ interface_

◆ updatedMatrix_