processorGAMGInterface Class Reference

GAMG agglomerated processor interface. More...

Inheritance diagram for processorGAMGInterface:
Collaboration diagram for processorGAMGInterface:

Public Member Functions

 TypeName ("processor")
 Runtime type information. More...
 
 processorGAMGInterface (const label index, const lduInterfacePtrsList &coarseInterfaces, const lduInterface &fineInterface, const labelField &restrictAddressing, const labelField &neighbourRestrictAddressing, const label fineLevelIndex, const label coarseComm)
 Construct from fine-level interface,. More...
 
 processorGAMGInterface (const label index, const lduInterfacePtrsList &coarseInterfaces, const labelUList &faceCells, const labelUList &faceRestrictAddresssing, const label coarseComm, const label myProcNo, const label neighbProcNo, const transformer &transform, const int tag)
 Construct from components. More...
 
 processorGAMGInterface (const label index, const lduInterfacePtrsList &coarseInterfaces, Istream &is)
 Construct from Istream. More...
 
 processorGAMGInterface (const processorGAMGInterface &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~processorGAMGInterface ()
 Destructor. More...
 
virtual void initInternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
 Initialise neighbour field transfer. More...
 
virtual tmp< labelFieldinternalFieldTransfer (const Pstream::commsTypes commsType, const labelUList &iF) const
 Transfer and return internal field adjacent to the interface. More...
 
virtual label comm () const
 Processor interface functions. More...
 
virtual int myProcNo () const
 Return processor number (rank in communicator) More...
 
virtual int neighbProcNo () const
 Return neighbour processor number (rank in communicator) More...
 
virtual const transformertransform () const
 Return transformation between the coupled patches. More...
 
virtual int tag () const
 Return message tag used for sending. More...
 
virtual void write (Ostream &) const
 Write to stream. More...
 
void operator= (const processorGAMGInterface &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from GAMGInterface
 TypeName ("GAMGInterface")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, GAMGInterface, lduInterface,(const label index, const lduInterfacePtrsList &coarseInterfaces, const lduInterface &fineInterface, const labelField &localRestrictAddressing, const labelField &neighbourRestrictAddressing, const label fineLevelIndex, const label coarseComm),(index, coarseInterfaces, fineInterface, localRestrictAddressing, neighbourRestrictAddressing, fineLevelIndex, coarseComm))
 
 declareRunTimeSelectionTable (autoPtr, GAMGInterface, Istream,(const label index, const lduInterfacePtrsList &coarseInterfaces, Istream &is),(index, coarseInterfaces, is))
 
 GAMGInterface (const label index, const lduInterfacePtrsList &coarseInterfaces)
 Construct from interfaces, restrict addressing set later on. More...
 
 GAMGInterface (const label index, const lduInterfacePtrsList &coarseInterfaces, const labelUList &faceCells, const labelUList &faceRestrictAddressing)
 Construct from interfaces and restrict addressing. More...
 
 GAMGInterface (const label index, const lduInterfacePtrsList &coarseInterfaces, Istream &is)
 Construct from Istream. More...
 
 GAMGInterface (const GAMGInterface &)=delete
 Disallow default bitwise copy construction. More...
 
virtual label size () const
 Return size. More...
 
virtual label index () const
 
virtual const lduInterfacePtrsListcoarseInterfaces () const
 
virtual const labelUListfaceCells () const
 Return faceCell addressing. More...
 
virtual const labelListfaceRestrictAddressing () const
 Return (local)face restrict addressing. More...
 
virtual labelListfaceRestrictAddressing ()
 Return non-const access to face restrict addressing. More...
 
template<class Type >
tmp< Field< Type > > interfaceInternalField (const UList< Type > &internalData) const
 Return the interface internal field of the given field. More...
 
template<class Type >
void interfaceInternalField (const UList< Type > &internalData, List< Type > &) const
 Get the interface internal field of the given field. More...
 
virtual tmp< labelFieldinterfaceInternalField (const labelUList &internalData) const
 Return the values of the given internal data adjacent to. More...
 
void combine (const GAMGInterface &)
 Merge the next level with this level. More...
 
virtual tmp< scalarFieldagglomerateCoeffs (const scalarField &fineCoeffs) const
 Agglomerating the given fine-level coefficients and return. More...
 
void operator= (const GAMGInterface &)=delete
 Disallow default bitwise assignment. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > interfaceInternalField (const UList< Type > &iF) const
 
- Public Member Functions inherited from lduInterface
 TypeName ("lduInterface")
 Runtime type information. More...
 
 lduInterface ()
 Construct null. More...
 
 lduInterface (const lduInterface &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~lduInterface ()
 Destructor. More...
 
void operator= (const lduInterface &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from processorLduInterface
 TypeName ("processorLduInterface")
 Runtime type information. More...
 
 processorLduInterface ()
 Construct null. More...
 
virtual ~processorLduInterface ()
 Destructor. More...
 
template<class Type >
void send (const Pstream::commsTypes commsType, const UList< Type > &) const
 Raw send function. More...
 
template<class Type >
void receive (const Pstream::commsTypes commsType, UList< Type > &) const
 Raw field receive function. More...
 
template<class Type >
tmp< Field< Type > > receive (const Pstream::commsTypes commsType, const label size) const
 Raw field receive function returning field. More...
 
template<class Type >
void compressedSend (const Pstream::commsTypes commsType, const UList< Type > &) const
 Raw field send function with data compression. More...
 
template<class Type >
void compressedReceive (const Pstream::commsTypes commsType, UList< Type > &) const
 Raw field receive function with data compression. More...
 
template<class Type >
tmp< Field< Type > > compressedReceive (const Pstream::commsTypes commsType, const label size) const
 Raw field receive function with data compression returning field. More...
 
template<class Type >
Foam::tmp< Foam::Field< Type > > receive (const Pstream::commsTypes commsType, const label size) const
 
template<class Type >
Foam::tmp< Foam::Field< Type > > compressedReceive (const Pstream::commsTypes commsType, const label size) const
 

Additional Inherited Members

- Static Public Member Functions inherited from GAMGInterface
static autoPtr< GAMGInterfaceNew (const label index, const lduInterfacePtrsList &coarseInterfaces, const lduInterface &fineInterface, const labelField &localRestrictAddressing, const labelField &neighbourRestrictAddressing, const label fineLevelIndex, const label coarseComm)
 Return a pointer to a new interface created on freestore given. More...
 
static autoPtr< GAMGInterfaceNew (const word &coupleType, const label index, const lduInterfacePtrsList &coarseInterfaces, Istream &is)
 Return a pointer to a new interface created on freestore given. More...
 
- Protected Attributes inherited from GAMGInterface
const label index_
 My index in coarseInterfaces. More...
 
const lduInterfacePtrsListcoarseInterfaces_
 All interfaces. More...
 
labelList faceCells_
 Face-cell addressing. More...
 
labelList faceRestrictAddressing_
 Face restrict addressing. More...
 

Detailed Description

GAMG agglomerated processor interface.

Source files

Definition at line 49 of file processorGAMGInterface.H.

Constructor & Destructor Documentation

◆ processorGAMGInterface() [1/4]

processorGAMGInterface ( const label  index,
const lduInterfacePtrsList coarseInterfaces,
const lduInterface fineInterface,
const labelField restrictAddressing,
const labelField neighbourRestrictAddressing,
const label  fineLevelIndex,
const label  coarseComm 
)

◆ processorGAMGInterface() [2/4]

processorGAMGInterface ( const label  index,
const lduInterfacePtrsList coarseInterfaces,
const labelUList faceCells,
const labelUList faceRestrictAddresssing,
const label  coarseComm,
const label  myProcNo,
const label  neighbProcNo,
const transformer transform,
const int  tag 
)

Construct from components.

Definition at line 143 of file processorGAMGInterface.C.

◆ processorGAMGInterface() [3/4]

processorGAMGInterface ( const label  index,
const lduInterfacePtrsList coarseInterfaces,
Istream is 
)

Construct from Istream.

Definition at line 171 of file processorGAMGInterface.C.

◆ processorGAMGInterface() [4/4]

Disallow default bitwise copy construction.

◆ ~processorGAMGInterface()

~processorGAMGInterface ( )
virtual

Destructor.

Definition at line 189 of file processorGAMGInterface.C.

Member Function Documentation

◆ TypeName()

TypeName ( "processor"  )

Runtime type information.

◆ initInternalFieldTransfer()

void initInternalFieldTransfer ( const Pstream::commsTypes  commsType,
const labelUList iF 
) const
virtual

Initialise neighbour field transfer.

Reimplemented from lduInterface.

Definition at line 195 of file processorGAMGInterface.C.

◆ internalFieldTransfer()

Foam::tmp< Foam::labelField > internalFieldTransfer ( const Pstream::commsTypes  commsType,
const labelUList iF 
) const
virtual

Transfer and return internal field adjacent to the interface.

Implements lduInterface.

Definition at line 205 of file processorGAMGInterface.C.

◆ comm()

virtual label comm ( ) const
inlinevirtual

Processor interface functions.

Return communicator used for sending

Implements processorLduInterface.

Definition at line 144 of file processorGAMGInterface.H.

Referenced by processorGAMGInterfaceField::comm().

Here is the caller graph for this function:

◆ myProcNo()

virtual int myProcNo ( ) const
inlinevirtual

Return processor number (rank in communicator)

Implements processorLduInterface.

Definition at line 150 of file processorGAMGInterface.H.

Referenced by processorGAMGInterfaceField::myProcNo(), and processorGAMGInterface::processorGAMGInterface().

Here is the caller graph for this function:

◆ neighbProcNo()

virtual int neighbProcNo ( ) const
inlinevirtual

Return neighbour processor number (rank in communicator)

Implements processorLduInterface.

Definition at line 156 of file processorGAMGInterface.H.

Referenced by processorGAMGInterfaceField::neighbProcNo(), and processorGAMGInterface::processorGAMGInterface().

Here is the caller graph for this function:

◆ transform()

virtual const transformer& transform ( ) const
inlinevirtual

Return transformation between the coupled patches.

Implements processorLduInterface.

Definition at line 162 of file processorGAMGInterface.H.

Referenced by processorGAMGInterfaceField::transform().

Here is the caller graph for this function:

◆ tag()

virtual int tag ( ) const
inlinevirtual

Return message tag used for sending.

Implements processorLduInterface.

Definition at line 168 of file processorGAMGInterface.H.

◆ write()

void write ( Ostream os) const
virtual

Write to stream.

Implements GAMGInterface.

Definition at line 217 of file processorGAMGInterface.C.

References token::SPACE, and GAMGInterface::write().

Here is the call graph for this function:

◆ operator=()

void operator= ( const processorGAMGInterface )
delete

Disallow default bitwise assignment.


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