processorLduInterface Class Reference

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

#include <processorLduInterface.H>

Inheritance diagram for processorLduInterface:

Public Member Functions
	TypeNameNoDebug ("processorLduInterface")
	Runtime type information.
	processorLduInterface () noexcept=default
	Default construct.
virtual	~processorLduInterface ()=default
	Destructor.
virtual label	comm () const =0
	Return communicator used for parallel communication.
virtual int	myProcNo () const =0
	Return processor number (rank in communicator).
virtual int	neighbProcNo () const =0
	Return neighbour processor number (rank in communicator).
virtual const tensorField &	forwardT () const =0
	Return face transformation tensor.
virtual int	tag () const =0
	Return message tag used for sending.
template<class Type>
void	send (const UPstream::commsTypes commsType, const UList< Type > &f) const
	Raw send function.
template<class Type>
void	receive (const UPstream::commsTypes commsType, UList< Type > &f) const
	Raw receive function.
template<class Type>
tmp< Field< Type > >	receive (const UPstream::commsTypes commsType, const label size) const
	Raw receive function returning field.
template<class Type>
void	compressedSend (const UPstream::commsTypes commsType, const UList< Type > &f) const
	Raw send function with data compression.
template<class Type>
void	compressedReceive (const UPstream::commsTypes commsType, UList< Type > &f) const
	Raw receive function with data compression.
template<class Type>
tmp< Field< Type > >	compressedReceive (const UPstream::commsTypes commsType, const label size) const
	Raw receive function with data compression returning field.
template<class Type>
Foam::tmp< Foam::Field< Type > >	receive (const UPstream::commsTypes commsType, const label size) const
template<class Type>
Foam::tmp< Foam::Field< Type > >	compressedReceive (const UPstream::commsTypes commsType, const label size) const

Detailed Description

An abstract base class for processor coupled interfaces.

Source files

• processorLduInterface.H
• processorLduInterface.C
• processorLduInterfaceTemplates.C

Definition at line 49 of file processorLduInterface.H.

Constructor & Destructor Documentation

processorLduInterface()

processorLduInterface ( )

defaultnoexcept

Default construct.

References Foam::noexcept.

Referenced by calculatedProcessorGAMGInterface::calculatedProcessorGAMGInterface(), processorGAMGInterface::processorGAMGInterface(), and ~processorLduInterface().

Here is the caller graph for this function:

~processorLduInterface()

virtual ~processorLduInterface ( )

virtualdefault

Destructor.

References processorLduInterface().

Here is the call graph for this function:

Member Function Documentation

TypeNameNoDebug()

TypeNameNoDebug

(

"processorLduInterface"

)

Runtime type information.

comm()

virtual label comm ( ) const

pure virtual

Return communicator used for parallel communication.

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

References comm().

Referenced by comm(), compressedReceive(), compressedSend(), receive(), and send().

Here is the call graph for this function:

Here is the caller graph for this function:

myProcNo()

virtual int myProcNo ( ) const

pure virtual

Return processor number (rank in communicator).

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

References myProcNo().

Referenced by lduPrimitiveMesh::lduPrimitiveMesh(), myProcNo(), and oversetFvMeshBase::write().

Here is the call graph for this function:

Here is the caller graph for this function:

neighbProcNo()

virtual int neighbProcNo ( ) const

pure virtual

Return neighbour processor number (rank in communicator).

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

References neighbProcNo().

Referenced by compressedReceive(), compressedSend(), lduPrimitiveMesh::lduPrimitiveMesh(), neighbProcNo(), receive(), send(), and oversetFvMeshBase::write().

Here is the call graph for this function:

Here is the caller graph for this function:

forwardT()

virtual const tensorField & forwardT ( ) const

pure virtual

Return face transformation tensor.

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

References forwardT().

Referenced by forwardT().

Here is the call graph for this function:

Here is the caller graph for this function:

tag()

virtual int tag ( ) const

pure virtual

Return message tag used for sending.

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

References f(), receive(), send(), and tag().

Referenced by compressedReceive(), compressedSend(), receive(), send(), and tag().

Here is the call graph for this function:

Here is the caller graph for this function:

send()

template<class Type>

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

Raw send function.

Definition at line 29 of file processorLduInterfaceTemplates.C.

References Foam::abort(), UPstream::buffered, comm(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, fld(), Foam::is_contiguous_v, neighbProcNo(), UPstream::nonBlocking, UIPstream::read(), UPstream::scheduled, tag(), and UOPstream::write().

Referenced by compressedSend(), calculatedProcessorGAMGInterface::initInternalFieldTransfer(), lduPrimitiveProcessorInterface::initInternalFieldTransfer(), lduPrimitiveProcessorInterface::initInternalFieldTransfer(), processorFaPatch::initInternalFieldTransfer(), processorFvPatch::initInternalFieldTransfer(), processorFvPatch::initInternalFieldTransfer(), processorGAMGInterface::initInternalFieldTransfer(), processorGAMGInterface::initInternalFieldTransfer(), processorFaPatch::initTransfer(), and tag().

Here is the call graph for this function:

Here is the caller graph for this function:

receive() [1/3]

template<class Type>

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

Raw receive function.

Definition at line 105 of file processorLduInterfaceTemplates.C.

References Foam::abort(), UPstream::buffered, comm(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, fld(), Foam::is_contiguous_v, neighbProcNo(), UPstream::nonBlocking, UIPstream::read(), UPstream::scheduled, and tag().

Referenced by compressedReceive(), calculatedProcessorGAMGInterface::internalFieldTransfer(), lduPrimitiveProcessorInterface::internalFieldTransfer(), processorFaPatch::internalFieldTransfer(), processorFaPatch::internalFieldTransfer(), processorFvPatch::internalFieldTransfer(), processorGAMGInterface::internalFieldTransfer(), receive(), tag(), and processorFaPatch::transfer().

Here is the call graph for this function:

Here is the caller graph for this function:

receive() [2/3]

template<class Type>

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

Raw receive function returning field.

References compressedReceive(), compressedSend(), f(), and receive().

Here is the call graph for this function:

compressedSend()

template<class Type>

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

Raw send function with data compression.

Definition at line 165 of file processorLduInterfaceTemplates.C.

References UPstream::buffered, comm(), Foam::exit(), f(), Foam::FatalError, FatalErrorInFunction, UPstream::floatTransfer, neighbProcNo(), UPstream::nonBlocking, UIPstream::read(), UPstream::scheduled, send(), tag(), and UOPstream::write().

Referenced by receive().

Here is the call graph for this function:

Here is the caller graph for this function:

compressedReceive() [1/3]

template<class Type>

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

Raw receive function with data compression.

Definition at line 254 of file processorLduInterfaceTemplates.C.

References UPstream::buffered, comm(), Foam::exit(), f(), Foam::FatalError, FatalErrorInFunction, UPstream::floatTransfer, neighbProcNo(), UPstream::nonBlocking, UIPstream::read(), receive(), UPstream::scheduled, and tag().

Referenced by compressedReceive(), and receive().

Here is the call graph for this function:

Here is the caller graph for this function:

compressedReceive() [2/3]

template<class Type>

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

Raw receive function with data compression returning field.

References compressedReceive().

Here is the call graph for this function:

receive() [3/3]

template<class Type>

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

Definition at line 152 of file processorLduInterfaceTemplates.C.

References Foam::New(), and receive().

Here is the call graph for this function:

compressedReceive() [3/3]

template<class Type>

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

Definition at line 320 of file processorLduInterfaceTemplates.C.

References compressedReceive(), and Foam::New().

Here is the call graph for this function:

---

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

• src/OpenFOAM/matrices/lduMatrix/lduAddressing/lduInterface/processorLduInterface.H
• src/OpenFOAM/matrices/lduMatrix/lduAddressing/lduInterface/processorLduInterfaceTemplates.C