GAMG agglomerated processor interface field. More...

#include <processorCyclicGAMGInterfaceField.H>

Inheritance diagram for processorCyclicGAMGInterfaceField:

Collaboration diagram for processorCyclicGAMGInterfaceField:

Public Member Functions
	TypeName ("processorCyclic")
	Runtime type information.
	processorCyclicGAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterface)
	Construct from GAMG interface and fine level interface field.
	processorCyclicGAMGInterfaceField (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
	Construct from GAMG interface and fine level interface field.
	processorCyclicGAMGInterfaceField (const GAMGInterface &GAMGCp, Istream &is)
	Construct from GAMG interface and Istream.
virtual autoPtr< GAMGInterfaceField >	clone (const GAMGInterface &GAMGCp, const UPtrList< lduInterfaceField > &other) const
	Construct by assembling and return a clone.
virtual	~processorCyclicGAMGInterfaceField ()
Public Member Functions inherited from processorGAMGInterfaceField
	TypeName ("processor")
	Runtime type information.
	processorGAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterface)
	Construct from GAMG interface and fine level interface field.
	processorGAMGInterfaceField (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
	Construct from GAMG interface and fine level interface field.
	processorGAMGInterfaceField (const GAMGInterface &GAMGCp, Istream &is)
	Construct from GAMG interface and Istream.
virtual	~processorGAMGInterfaceField ()=default
	Destructor.
label	size () const
	Return size.
virtual bool	ready () const
	Are all (receive) data available?
virtual void	initInterfaceMatrixUpdate (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
	Initialise neighbour matrix update.
virtual void	updateInterfaceMatrix (solveScalarField &result, const bool add, const lduAddressing &lduAddr, const label patchId, const solveScalarField &psiInternal, const scalarField &coeffs, const direction cmpt, const Pstream::commsTypes commsType) const
	Update result field based on interface functionality.
virtual label	comm () const
	Processor interface functions.
virtual int	myProcNo () const
	Return processor number.
virtual int	neighbProcNo () const
	Return neighbour processor number.
virtual bool	doTransform () const
	Does the interface field perform the transformation.
virtual const tensorField &	forwardT () const
	Return face transformation tensor.
virtual int	rank () const
	Return rank of component for transform.
virtual void	write (Ostream &) const
	Write to stream.
Public Member Functions inherited from GAMGInterfaceField
	TypeName ("GAMGInterfaceField")
	Runtime type information.
	declareRunTimeSelectionTable (autoPtr, GAMGInterfaceField, lduInterfaceField,(const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterface),(GAMGCp, fineInterface))
	declareRunTimeSelectionTable (autoPtr, GAMGInterfaceField, lduInterface,(const GAMGInterface &GAMGCp, const bool doTransform, const int rank),(GAMGCp, doTransform, rank))
	declareRunTimeSelectionTable (autoPtr, GAMGInterfaceField, Istream,(const GAMGInterface &GAMGCp, Istream &is),(GAMGCp, is))
	GAMGInterfaceField (const GAMGInterface &GAMGCp, const lduInterfaceField &)
	Construct from GAMG interface and fine level interface field.
	GAMGInterfaceField (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
	Construct from GAMG interface and fine level interface field.
	GAMGInterfaceField (const GAMGInterface &GAMGCp, Istream &is)
	Construct from GAMG interface and fine level interface field.
virtual	~GAMGInterfaceField ()=default
	Destructor.
const GAMGInterface &	interface () const
	Return interface.
Public Member Functions inherited from lduInterfaceField
	TypeName ("lduInterfaceField")
	Runtime type information.
	lduInterfaceField (const lduInterfaceField &)=delete
	No copy construct.
void	operator= (const lduInterfaceField &)=delete
	No copy assignment.
	lduInterfaceField (const lduInterface &patch)
	Construct given coupled patch.
virtual	~lduInterfaceField ()=default
	Destructor.
const lduInterface &	interface () const noexcept
	Return the interface.
virtual const word &	interfaceFieldType () const
	Return the interface type.
bool	updatedMatrix () const noexcept
	Whether matrix has been updated.
bool	updatedMatrix (bool flag) const noexcept
	Set matrix as update-to-date, return the previous value.
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.
bool &	updatedMatrix () noexcept
	Adjust whether matrix has been updated.
Public Member Functions inherited from processorLduInterfaceField
	TypeName ("processorLduInterfaceField")
	Runtime type information.
	processorLduInterfaceField ()=default
	Default construct.
virtual	~processorLduInterfaceField ()=default
	Destructor.
template<class Type>
void	transformCoupleField (Field< Type > &f) const
	Transform given patch field.
void	transformCoupleField (solveScalarField &f, const direction cmpt) const
	Transform given patch component field.

Additional Inherited Members
Static Public Member Functions inherited from GAMGInterfaceField
static autoPtr< GAMGInterfaceField >	New (const GAMGInterface &GAMGCp, const lduInterfaceField &fineInterface)
	Return a pointer to a new interface created on freestore given.
static autoPtr< GAMGInterfaceField >	New (const GAMGInterface &GAMGCp, const bool doTransform, const int rank)
	Return a pointer to a new interface created on freestore given.
static autoPtr< GAMGInterfaceField >	New (const word &patchFieldType, const GAMGInterface &GAMGCp, Istream &is)
	Return a pointer to a new interface created on freestore given.

Detailed Description

GAMG agglomerated processor interface field.

Source files

Definition at line 46 of file processorCyclicGAMGInterfaceField.H.

Constructor & Destructor Documentation

◆ processorCyclicGAMGInterfaceField() [1/3]

processorCyclicGAMGInterfaceField	(	const GAMGInterface &	GAMGCp,
		const lduInterfaceField &	fineInterface )

Construct from GAMG interface and fine level interface field.

Definition at line 53 of file processorCyclicGAMGInterfaceField.C.

◆ processorCyclicGAMGInterfaceField() [2/3]

processorCyclicGAMGInterfaceField	(	const GAMGInterface &	GAMGCp,
		const bool	doTransform,
		const int	rank )

Construct from GAMG interface and fine level interface field.

Definition at line 63 of file processorCyclicGAMGInterfaceField.C.

References processorGAMGInterfaceField::doTransform(), and processorGAMGInterfaceField::rank().

Here is the call graph for this function:

◆ processorCyclicGAMGInterfaceField() [3/3]

processorCyclicGAMGInterfaceField	(	const GAMGInterface &	GAMGCp,
		Istream &	is )

Construct from GAMG interface and Istream.

Definition at line 74 of file processorCyclicGAMGInterfaceField.C.

◆ ~processorCyclicGAMGInterfaceField()

~processorCyclicGAMGInterfaceField ( )

virtual

Definition at line 86 of file processorCyclicGAMGInterfaceField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "processorCyclic" )

Runtime type information.

References processorGAMGInterfaceField::doTransform(), and processorGAMGInterfaceField::rank().

Here is the call graph for this function:

◆ clone()

virtual autoPtr< GAMGInterfaceField > clone	(	const GAMGInterface &	GAMGCp,
		const UPtrList< lduInterfaceField > &	other ) const

inlinevirtual

Construct by assembling and return a clone.

Reimplemented from processorGAMGInterfaceField.

Definition at line 107 of file processorCyclicGAMGInterfaceField.H.

References NotImplemented.

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

src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/interfaceFields/processorCyclicGAMGInterfaceField/processorCyclicGAMGInterfaceField.H
src/OpenFOAM/matrices/lduMatrix/solvers/GAMG/interfaceFields/processorCyclicGAMGInterfaceField/processorCyclicGAMGInterfaceField.C

Public Member Functions

Additional Inherited Members