Wrapper class for allocating/freeing communicators. Always invokes allocateCommunicatorComponents() and freeCommunicatorComponents() More...
Public Member Functions | |
communicator (const communicator &)=delete | |
No copy construct. More... | |
void | operator= (const communicator &)=delete |
No copy assignment. More... | |
communicator () noexcept | |
Default construct (a placeholder communicator) More... | |
communicator (communicator &&c) | |
Move construct, takes ownership. More... | |
communicator (const label parentComm, const labelRange &subRanks) | |
Allocate communicator for contiguous sub-ranks on given parent. More... | |
communicator (const label parentComm, const labelUList &subRanks) | |
Allocate communicator for sub-ranks on given parent. More... | |
~communicator () | |
Free allocated communicator. More... | |
bool | good () const noexcept |
True if communicator is non-negative (ie, was allocated) More... | |
label | comm () const noexcept |
The communicator label. More... | |
label | release () noexcept |
Release ownership of the communicator, return old value. More... | |
void | reset () |
Free allocated communicator. More... | |
void | reset (label parent, const labelRange &subRanks) |
Allocate with contiguous sub-ranks of parent communicator. More... | |
void | reset (label parent, const labelUList &subRanks) |
Allocate with sub-ranks of parent communicator. More... | |
void | reset (communicator &&c) |
Take ownership, free allocated communicator. More... | |
void | operator= (communicator &&c) |
Move assignment, takes ownership. More... | |
operator label () const noexcept | |
Cast to label - the same as comm() More... | |
Wrapper class for allocating/freeing communicators. Always invokes allocateCommunicatorComponents() and freeCommunicatorComponents()
Definition at line 578 of file UPstream.H.
|
delete |
No copy construct.
|
inlinenoexcept |
Default construct (a placeholder communicator)
Definition at line 597 of file UPstream.H.
|
inline |
Move construct, takes ownership.
Definition at line 602 of file UPstream.H.
References Foam::constant::universal::c.
|
inline |
Allocate communicator for contiguous sub-ranks on given parent.
parentComm | The parent communicator |
subRanks | The contiguous sub-ranks of parent to use |
Definition at line 608 of file UPstream.H.
|
inline |
Allocate communicator for sub-ranks on given parent.
parentComm | The parent communicator |
subRanks | The sub-ranks of parent to use (negative values ignored) |
Definition at line 623 of file UPstream.H.
|
inline |
Free allocated communicator.
Definition at line 637 of file UPstream.H.
References UPstream::freeCommunicator().
|
delete |
No copy assignment.
|
inlinenoexcept |
True if communicator is non-negative (ie, was allocated)
Definition at line 642 of file UPstream.H.
|
inlinenoexcept |
The communicator label.
Definition at line 647 of file UPstream.H.
|
inlinenoexcept |
Release ownership of the communicator, return old value.
Leave further management to the caller
Definition at line 654 of file UPstream.H.
References Foam::constant::universal::c.
|
inline |
Free allocated communicator.
Definition at line 659 of file UPstream.H.
References UPstream::freeCommunicator().
Referenced by UPstream::communicator::operator=().
|
inline |
Allocate with contiguous sub-ranks of parent communicator.
Definition at line 664 of file UPstream.H.
References UPstream::allocateCommunicator(), UPstream::freeCommunicator(), and UPstream::parent().
|
inline |
Allocate with sub-ranks of parent communicator.
Definition at line 673 of file UPstream.H.
References UPstream::allocateCommunicator(), UPstream::freeCommunicator(), and UPstream::parent().
|
inline |
Take ownership, free allocated communicator.
do not call as self-assignment
Definition at line 684 of file UPstream.H.
References Foam::constant::universal::c, and UPstream::freeCommunicator().
|
inline |
Move assignment, takes ownership.
do not call as self-assignment
Definition at line 696 of file UPstream.H.
References Foam::constant::universal::c, and UPstream::communicator::reset().
|
inlinenoexcept |
Cast to label - the same as comm()
Definition at line 701 of file UPstream.H.