Public Member Functions | List of all members
processorLduInterface Class Referenceabstract

An abstract base class for processor coupled interfaces. More...

Inheritance diagram for processorLduInterface:
[legend]

Public Member Functions

 TypeName ("processorLduInterface")
 Runtime type information. More...
 
 processorLduInterface ()=default
 Construct null. More...
 
virtual ~processorLduInterface ()=default
 Destructor. More...
 
virtual label comm () const =0
 Return communicator used for parallel communication. More...
 
virtual int myProcNo () const =0
 Return processor number (rank in communicator) More...
 
virtual int neighbProcNo () const =0
 Return neighbour processor number (rank in communicator) More...
 
virtual const tensorField & forwardT () const =0
 Return face transformation tensor. More...
 
virtual int tag () const =0
 Return message tag used for sending. More...
 
template<class Type >
void send (const Pstream::commsTypes commsType, const UList< Type > &f) const
 Raw send function. More...
 
template<class Type >
void receive (const Pstream::commsTypes commsType, UList< Type > &f) const
 Raw receive function. More...
 
template<class Type >
tmp< Field< Type > > receive (const Pstream::commsTypes commsType, const label size) const
 Raw receive function returning field. More...
 
template<class Type >
void compressedSend (const Pstream::commsTypes commsType, const UList< Type > &f) const
 Raw send function with data compression. More...
 
template<class Type >
void compressedReceive (const Pstream::commsTypes commsType, UList< Type > &f) const
 Raw receive function with data compression. More...
 
template<class Type >
tmp< Field< Type > > compressedReceive (const Pstream::commsTypes commsType, const label size) const
 Raw 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
 

Detailed Description

An abstract base class for processor coupled interfaces.

Source files

Definition at line 53 of file processorLduInterface.H.

Constructor & Destructor Documentation

◆ processorLduInterface()

processorLduInterface ( )
default

Construct null.

◆ ~processorLduInterface()

virtual ~processorLduInterface ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "processorLduInterface"  )

Runtime type information.

◆ comm()

virtual label comm ( ) const
pure virtual

Return communicator used for parallel communication.

Implemented in processorFaPatch, calculatedProcessorGAMGInterface, processorGAMGInterface, lduPrimitiveProcessorInterface, and processorFvPatch.

Referenced by procLduInterface::procLduInterface().

Here is the caller graph for this function:

◆ myProcNo()

virtual int myProcNo ( ) const
pure virtual

Return processor number (rank in communicator)

Implemented in processorFaPatch, calculatedProcessorGAMGInterface, processorGAMGInterface, lduPrimitiveProcessorInterface, and processorFvPatch.

Referenced by lduPrimitiveMesh::lduPrimitiveMesh(), procLduInterface::procLduInterface(), and dynamicOversetFvMesh::write().

Here is the caller graph for this function:

◆ neighbProcNo()

virtual int neighbProcNo ( ) const
pure virtual

Return neighbour processor number (rank in communicator)

Implemented in processorFaPatch, calculatedProcessorGAMGInterface, processorGAMGInterface, lduPrimitiveProcessorInterface, and processorFvPatch.

Referenced by lduPrimitiveMesh::lduPrimitiveMesh(), procLduInterface::procLduInterface(), and dynamicOversetFvMesh::write().

Here is the caller graph for this function:

◆ forwardT()

virtual const tensorField& forwardT ( ) const
pure virtual

Return face transformation tensor.

Implemented in processorFaPatch, calculatedProcessorGAMGInterface, processorGAMGInterface, lduPrimitiveProcessorInterface, processorFvPatch, and processorCyclicFvPatch.

◆ tag()

virtual int tag ( ) const
pure virtual

Return message tag used for sending.

Implemented in processorFaPatch, calculatedProcessorGAMGInterface, processorGAMGInterface, lduPrimitiveProcessorInterface, processorFvPatch, and processorCyclicFvPatch.

Referenced by procLduInterface::procLduInterface().

Here is the caller graph for this function:

◆ send()

void send ( const Pstream::commsTypes  commsType,
const UList< Type > &  f 
) const

Raw send function.

Definition at line 37 of file processorLduInterfaceTemplates.C.

References Foam::exit(), f(), Foam::FatalError, FatalErrorInFunction, Foam::blockMeshTools::read(), and Foam::vtk::write().

Here is the call graph for this function:

◆ receive() [1/3]

void receive ( const Pstream::commsTypes  commsType,
UList< Type > &  f 
) const

Raw receive function.

Definition at line 101 of file processorLduInterfaceTemplates.C.

References Foam::exit(), f(), Foam::FatalError, FatalErrorInFunction, and Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ receive() [2/3]

tmp<Field<Type> > receive ( const Pstream::commsTypes  commsType,
const label  size 
) const

Raw receive function returning field.

◆ compressedSend()

void compressedSend ( const Pstream::commsTypes  commsType,
const UList< Type > &  f 
) const

Raw send function with data compression.

Definition at line 153 of file processorLduInterfaceTemplates.C.

References Foam::exit(), f(), Foam::FatalError, FatalErrorInFunction, Foam::blockMeshTools::read(), and Foam::vtk::write().

Here is the call graph for this function:

◆ compressedReceive() [1/3]

void compressedReceive ( const Pstream::commsTypes  commsType,
UList< Type > &  f 
) const

Raw receive function with data compression.

Definition at line 234 of file processorLduInterfaceTemplates.C.

References Foam::exit(), f(), Foam::FatalError, FatalErrorInFunction, and Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ compressedReceive() [2/3]

tmp<Field<Type> > compressedReceive ( const Pstream::commsTypes  commsType,
const label  size 
) const

Raw receive function with data compression returning field.

◆ receive() [3/3]

Foam::tmp<Foam::Field<Type> > receive ( const Pstream::commsTypes  commsType,
const label  size 
) const

Definition at line 140 of file processorLduInterfaceTemplates.C.

References Foam::New().

Here is the call graph for this function:

◆ compressedReceive() [3/3]

Foam::tmp<Foam::Field<Type> > compressedReceive ( const Pstream::commsTypes  commsType,
const label  size 
) const

Definition at line 292 of file processorLduInterfaceTemplates.C.

References Foam::New().

Here is the call graph for this function:
The documentation for this class was generated from the following files: