Wrapper for internally indexed communicator label. Always invokes UPstream::allocateCommunicatorComponents() and UPstream::freeCommunicatorComponents(). More...

#include <UPstream.H>

Public Member Functions
	communicator (const communicator &)=delete
	No copy construct.
void	operator= (const communicator &)=delete
	No copy assignment.
	communicator () noexcept
	Default construct (a placeholder communicator).
	communicator (communicator &&c)
	Move construct, takes ownership.
	communicator (const label parentComm, const labelRange &subRanks)
	Allocate communicator for contiguous sub-ranks on given parent.
	communicator (const label parentComm, const labelUList &subRanks)
	Allocate communicator for sub-ranks on given parent.
	~communicator ()
	Free allocated communicator.
bool	good () const noexcept
	True if communicator is non-negative (ie, was allocated).
label	comm () const noexcept
	The communicator label.
communicator &	constCast () const noexcept
	Return non-const reference to this.
label	release () noexcept
	Release ownership of the communicator, return old value.
void	reset ()
	Free allocated communicator.
void	reset (label parent, const labelRange &subRanks)
	Allocate with contiguous sub-ranks of parent communicator.
void	reset (label parent, const labelUList &subRanks)
	Allocate with sub-ranks of parent communicator.
void	reset (communicator &&c)
	Take ownership, free managed communicator.
void	swap (communicator &c)
	Swap communicator labels.
	operator label () const noexcept
	Implicit cast to label - the same as comm().
void	operator= (communicator &&c)
	Move assignment, takes ownership.
bool	operator== (const communicator &c) const noexcept
	Test for equality.
bool	operator!= (const communicator &c) const noexcept
	Test for inequality.

Static Public Member Functions
static communicator	duplicate (const label parentComm)
	Duplicate the given communicator.
static communicator	split (const label parentComm, const int colour, const bool two_step=true)
	Factory Method : Split the communicator on the given colour.

Detailed Description

Wrapper for internally indexed communicator label. Always invokes UPstream::allocateCommunicatorComponents() and UPstream::freeCommunicatorComponents().

Definition at line 2545 of file UPstream.H.

Constructor & Destructor Documentation

◆ communicator() [1/5]

communicator ( const communicator & )

delete

No copy construct.

References communicator().

Referenced by communicator(), communicator(), constCast(), duplicate(), operator!=(), operator=(), operator=(), operator==(), reset(), split(), and swap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ communicator() [2/5]

communicator ( )

inlinenoexcept

Default construct (a placeholder communicator).

Definition at line 2574 of file UPstream.H.

References Foam::noexcept.

◆ communicator() [3/5]

communicator ( communicator && c )

inline

Move construct, takes ownership.

Definition at line 2579 of file UPstream.H.

References communicator().

Here is the call graph for this function:

◆ communicator() [4/5]

communicator	(	const label	parentComm,
		const labelRange &	subRanks )

inline

Allocate communicator for contiguous sub-ranks on given parent.

Parameters

parentComm	The parent communicator
subRanks	The contiguous sub-ranks of parent to use

Definition at line 2584 of file UPstream.H.

References UPstream::newCommunicator(), and UPstream::UPstream().

Here is the call graph for this function:

◆ communicator() [5/5]

communicator	(	const label	parentComm,
		const labelUList &	subRanks )

inline

Allocate communicator for sub-ranks on given parent.

Parameters

parentComm	The parent communicator
subRanks	The sub-ranks of parent to use (negative values ignored)

Definition at line 2598 of file UPstream.H.

References UPstream::newCommunicator(), and UPstream::UPstream().

Here is the call graph for this function:

◆ ~communicator()

~communicator ( )

inline

Free allocated communicator.

Definition at line 2615 of file UPstream.H.

References UPstream::freeCommunicator().

Here is the call graph for this function:

Member Function Documentation

◆ operator=() [1/2]

void operator= ( const communicator & )

delete

No copy assignment.

References communicator().

Here is the call graph for this function:

◆ duplicate()

communicator duplicate ( const label parentComm )

inlinestatic

Duplicate the given communicator.

Definition at line 2623 of file UPstream.H.

References communicator(), and UPstream::dupCommunicator().

Here is the call graph for this function:

◆ split()

communicator split	(	const label	parentComm,
		const int	colour,
		const bool	two_step = true )

inlinestatic

Factory Method : Split the communicator on the given colour.

Parameters

parentComm	The parent communicator
colour	The colouring to select which ranks to include. Negative values correspond to 'ignore'
two_step	Use MPI_Allgather+MPI_Comm_create_group vs MPI_Comm_split

Definition at line 2634 of file UPstream.H.

References communicator(), and UPstream::splitCommunicator().

Here is the call graph for this function: