Inter-processor communications stream. More...
Classes | |
| class | commsStruct |
| Structure for communicating between processors. More... | |
| class | commsStructList |
| Collection of communication structures. More... | |
| class | communicator |
| Wrapper for internally indexed communicator label. Always invokes UPstream::allocateCommunicatorComponents() and UPstream::freeCommunicatorComponents() More... | |
| class | Communicator |
An opaque wrapper for MPI_Comm with a vendor-independent representation without any <mpi.h> header. More... | |
| class | Request |
An opaque wrapper for MPI_Request with a vendor-independent representation without any <mpi.h> header. More... | |
| class | Window |
An opaque wrapper for MPI_Win with a vendor-independent representation and without any <mpi.h> header dependency. More... | |
Public Types | |
| enum | commsTypes : char { buffered, scheduled, nonBlocking, blocking = buffered } |
| Communications types. More... | |
| enum | sendModes : char { normal, sync } |
| Different MPI-send modes (ignored for commsTypes::buffered) More... | |
| enum | dataTypes : char { Basic_begin, type_byte = Basic_begin, type_int16, type_int32, type_int64, type_uint16, type_uint32, type_uint64, type_float, type_double, type_long_double, Basic_end, User_begin = Basic_end, type_3float = User_begin, type_3double, type_6float, type_6double, type_9float, type_9double, invalid, User_end = invalid, DataTypes_end = invalid } |
| Mapping of some fundamental and aggregate types to MPI data types. More... | |
| enum | opCodes : char { Basic_begin, op_min = Basic_begin, op_max, op_sum, op_prod, op_bool_and, op_bool_or, op_bool_xor, op_bit_and, op_bit_or, op_bit_xor, Basic_end, Extra_begin = Basic_end, op_replace = Extra_begin, op_no_op, invalid, Extra_end = invalid, OpCodes_end = invalid } |
| Mapping of some MPI op codes. More... | |
| enum | topoControls : int { broadcast = 1, reduce = 2, gather = 4, combine = 16, mapGather = 32, gatherList = 64 } |
| Some bit masks corresponding to topology controls. More... | |
| typedef IntRange< int > | rangeType |
| Int ranges are used for MPI ranks (processes) More... | |
Public Member Functions | |
| ClassName ("UPstream") | |
| Declare name of the class and its debug switch. More... | |
| UPstream (const commsTypes commsType) noexcept | |
| Construct for given communication type. More... | |
| commsTypes | commsType () const noexcept |
| Get the communications type of the stream. More... | |
| commsTypes | commsType (const commsTypes ct) noexcept |
| Set the communications type of the stream. More... | |
Static Public Member Functions | |
| static bool | usingTopoControl (UPstream::topoControls ctrl) noexcept |
| Test for selection of given topology-aware routine. More... | |
| static constexpr int | commGlobal () noexcept |
| Communicator for all ranks, irrespective of any local worlds. More... | |
| static constexpr int | commSelf () noexcept |
| Communicator within the current rank only. More... | |
| static int | commConstWorld () noexcept |
| Communicator for all ranks (respecting any local worlds). More... | |
| static label | commWorld () noexcept |
| Communicator for all ranks (respecting any local worlds) More... | |
| static label | commWorld (const label communicator) noexcept |
| Set world communicator. Negative values are a no-op. More... | |
| static label | commWarn (const label communicator) noexcept |
| Alter communicator debugging setting. Warns for use of any communicator differing from specified. Negative values disable. More... | |
| static label | nComms () noexcept |
| Number of currently defined communicators. More... | |
| static void | printCommTree (int communicator, bool linear=false) |
| Debugging: print the communication tree. More... | |
| static int | commInterNode () noexcept |
| Communicator between nodes/hosts (respects any local worlds) More... | |
| static int | commLocalNode () noexcept |
| Communicator within the node/host (respects any local worlds) More... | |
| static bool | hasNodeCommunicators () noexcept |
| Both inter-node and local-node communicators have been created. More... | |
| static bool | usingNodeComms (const int communicator) |
| True if node topology-aware routines have been enabled, it is running in parallel, the starting point is the world-communicator and it is not an odd corner case (ie, all processes on one node, all processes on different nodes) More... | |
| static label | newCommunicator (const label parent, const labelRange &subRanks, const bool withComponents=true) |
| Create new communicator with sub-ranks on the parent communicator. More... | |
| static label | newCommunicator (const label parent, const labelUList &subRanks, const bool withComponents=true) |
| Create new communicator with sub-ranks on the parent communicator. More... | |
| static label | dupCommunicator (const label parent) |
| Duplicate the parent communicator. More... | |
| static label | splitCommunicator (const label parent, const int colour, const bool two_step=true) |
| Allocate a new communicator by splitting the parent communicator on the given colour. More... | |
| static void | freeCommunicator (const label communicator, const bool withComponents=true) |
| Free a previously allocated communicator. More... | |
| static int | baseProcNo (label comm, int procID) |
| Return physical processor number (i.e. processor number in worldComm) given communicator and processor. More... | |
| static label | procNo (const label comm, const int baseProcID) |
| Return processor number in communicator (given physical processor number) (= reverse of baseProcNo) More... | |
| static label | procNo (const label comm, const label currentComm, const int currentProcID) |
| Return processor number in communicator (given processor number and communicator) More... | |
| static void | addValidParOptions (HashTable< string > &validParOptions) |
| Add the valid option this type of communications library adds/requires on the command line. More... | |
| static bool | init (int &argc, char **&argv, const bool needsThread) |
| Initialisation function called from main. More... | |
| static bool | initNull () |
| Special purpose initialisation function. More... | |
| static void | barrier (const int communicator, UPstream::Request *req=nullptr) |
| Impose a synchronisation barrier (optionally non-blocking) More... | |
| static void | send_done (const int toProcNo, const int communicator, const int tag=UPstream::msgType()+1970) |
| Impose a point-to-point synchronisation barrier by sending a zero-byte "done" message to given rank. More... | |
| static int | wait_done (const int fromProcNo, const int communicator, const int tag=UPstream::msgType()+1970) |
| Impose a point-to-point synchronisation barrier by receiving a zero-byte "done" message from given rank. More... | |
| static std::pair< int, int64_t > | probeMessage (const UPstream::commsTypes commsType, const int fromProcNo, const int tag=UPstream::msgType(), const int communicator=worldComm) |
| Probe for an incoming message. More... | |
| static void | printNodeCommsControl (Ostream &os) |
| Report the node-communication settings. More... | |
| static void | printTopoControl (Ostream &os) |
| Report the topology routines settings. More... | |
| static label | nRequests () noexcept |
| Number of outstanding requests (on the internal list of requests) More... | |
| static void | resetRequests (const label n) |
| Truncate outstanding requests to given length, which is expected to be in the range [0 to nRequests()]. More... | |
| static void | addRequest (UPstream::Request &req) |
| Transfer the (wrapped) MPI request to the internal global list and invalidate the parameter (ignores null requests) More... | |
| static void | cancelRequest (const label i) |
| Non-blocking comms: cancel and free outstanding request. Corresponds to MPI_Cancel() + MPI_Request_free() More... | |
| static void | cancelRequest (UPstream::Request &req) |
| Non-blocking comms: cancel and free outstanding request. Corresponds to MPI_Cancel() + MPI_Request_free() More... | |
| static void | cancelRequests (UList< UPstream::Request > &requests) |
| Non-blocking comms: cancel and free outstanding requests. Corresponds to MPI_Cancel() + MPI_Request_free() More... | |
| static void | removeRequests (const label pos, label len=-1) |
| Non-blocking comms: cancel/free outstanding requests (from position onwards) and remove from internal list of requests. Corresponds to MPI_Cancel() + MPI_Request_free() More... | |
| static void | freeRequest (UPstream::Request &req) |
| Non-blocking comms: free outstanding request. Corresponds to MPI_Request_free() More... | |
| static void | freeRequests (UList< UPstream::Request > &requests) |
| Non-blocking comms: free outstanding requests. Corresponds to MPI_Request_free() More... | |
| static void | waitRequests (const label pos, label len=-1) |
| Wait until all requests (from position onwards) have finished. Corresponds to MPI_Waitall() More... | |
| static void | waitRequests (UList< UPstream::Request > &requests) |
| Wait until all requests have finished. Corresponds to MPI_Waitall() More... | |
| static bool | waitAnyRequest (const label pos, label len=-1) |
| Wait until any request (from position onwards) has finished. Corresponds to MPI_Waitany() More... | |
| static bool | waitSomeRequests (const label pos, label len=-1, DynamicList< int > *indices=nullptr) |
| Wait until some requests (from position onwards) have finished. Corresponds to MPI_Waitsome() More... | |
| static bool | waitSomeRequests (UList< UPstream::Request > &requests, DynamicList< int > *indices=nullptr) |
| Wait until some requests have finished. Corresponds to MPI_Waitsome() More... | |
| static label | waitAnyRequest (UList< UPstream::Request > &requests) |
| Wait until any request has finished and return its index. Corresponds to MPI_Waitany() More... | |
| static void | waitRequest (const label i) |
| Wait until request i has finished. Corresponds to MPI_Wait() More... | |
| static void | waitRequest (UPstream::Request &req) |
| Wait until specified request has finished. Corresponds to MPI_Wait() More... | |
| static bool | finishedRequest (const label i) |
| Non-blocking comms: has request i finished? Corresponds to MPI_Test() More... | |
| static bool | finishedRequest (UPstream::Request &req) |
| Non-blocking comms: has request finished? Corresponds to MPI_Test() More... | |
| static bool | finishedRequests (const label pos, label len=-1) |
| Non-blocking comms: have all requests (from position onwards) finished? Corresponds to MPI_Testall() More... | |
| static bool | finishedRequests (UList< UPstream::Request > &requests) |
| Non-blocking comms: have all requests finished? Corresponds to MPI_Testall() More... | |
| static bool | finishedRequestPair (label &req0, label &req1) |
| Non-blocking comms: have both requests finished? Corresponds to pair of MPI_Test() More... | |
| static void | waitRequestPair (label &req0, label &req1) |
| Non-blocking comms: wait for both requests to finish. Corresponds to pair of MPI_Wait() More... | |
| static bool | parRun (const bool on) noexcept |
| Set as parallel run on/off. More... | |
| static bool & | parRun () noexcept |
| Test if this a parallel run. More... | |
| static bool | haveThreads () noexcept |
| Have support for threads. More... | |
| static constexpr int | masterNo () noexcept |
| Relative rank for the master process - is always 0. More... | |
| static label | nProcs (const label communicator=worldComm) |
| Number of ranks in parallel run (for given communicator). It is 1 for serial run. More... | |
| static int | myProcNo (const label communicator=worldComm) |
| Rank of this process in the communicator (starting from masterNo()). Negative if the process is not a rank in the communicator. More... | |
| static bool | master (const label communicator=worldComm) |
| True if process corresponds to the master rank in the communicator. More... | |
| static bool | is_rank (const label communicator=worldComm) |
| True if process corresponds to any rank (master or sub-rank) in the given communicator. More... | |
| static bool | is_subrank (const label communicator=worldComm) |
| True if process corresponds to a sub-rank in the given communicator. More... | |
| static bool | is_parallel (const label communicator=worldComm) |
| True if parallel algorithm or exchange is required. More... | |
| static int | numNodes () noexcept |
| The number of shared/host nodes in the (const) world communicator. More... | |
| static label | parent (int communicator) |
| The parent communicator. More... | |
| static List< int > & | procID (int communicator) |
| The list of ranks within a given communicator. More... | |
| static const wordList & | allWorlds () noexcept |
| All worlds. More... | |
| static const labelList & | worldIDs () noexcept |
| The indices into allWorlds for all processes. More... | |
| static label | myWorldID () |
| My worldID. More... | |
| static const word & | myWorld () |
| My world. More... | |
| static rangeType | allProcs (const label communicator=worldComm) |
| Range of process indices for all processes. More... | |
| static rangeType | subProcs (const label communicator=worldComm) |
| Range of process indices for sub-processes. More... | |
| static const List< int > & | interNode_offsets () |
| Processor offsets corresponding to the inter-node communicator. More... | |
| static const rangeType & | localNode_parentProcs () |
| The range (start/size) of the commLocalNode ranks in terms of the (const) world communicator processors. More... | |
| static const commsStructList & | linearCommunication (int communicator) |
| Linear communication schedule (special case) for given communicator. More... | |
| static const commsStructList & | treeCommunication (int communicator) |
| Tree communication schedule (standard case) for given communicator. More... | |
| static const commsStructList & | whichCommunication (const int communicator, bool linear=false) |
Communication schedule for all-to-master (proc 0) as linear/tree/none with switching based on UPstream::nProcsSimpleSum, the is_parallel() state and the optional linear parameter. More... | |
| static int & | msgType () noexcept |
| Message tag of standard messages. More... | |
| static int | msgType (int val) noexcept |
| Set the message tag for standard messages. More... | |
| static int | incrMsgType (int val=1) noexcept |
| Increment the message tag for standard messages. More... | |
| static void | shutdown (int errNo=0) |
| Shutdown (finalize) MPI as required. More... | |
| static void | abort (int errNo=1) |
| Call MPI_Abort with no other checks or cleanup. More... | |
| static void | exit (int errNo=1) |
| Shutdown (finalize) MPI as required and exit program with errNo. More... | |
| static void | allToAll (const UList< int32_t > &sendData, UList< int32_t > &recvData, const int communicator=UPstream::worldComm) |
Exchange int32_t data with all ranks in communicator. More... | |
| static void | allToAllConsensus (const UList< int32_t > &sendData, UList< int32_t > &recvData, const int tag, const int communicator=UPstream::worldComm) |
Exchange non-zero int32_t data between ranks [NBX]. More... | |
| static void | allToAllConsensus (const Map< int32_t > &sendData, Map< int32_t > &recvData, const int tag, const int communicator=UPstream::worldComm) |
Exchange int32_t data between ranks [NBX]. More... | |
| static Map< int32_t > | allToAllConsensus (const Map< int32_t > &sendData, const int tag, const int communicator=UPstream::worldComm) |
Exchange int32_t data between ranks [NBX]. More... | |
| static void | allToAll (const UList< int64_t > &sendData, UList< int64_t > &recvData, const int communicator=UPstream::worldComm) |
Exchange int64_t data with all ranks in communicator. More... | |
| static void | allToAllConsensus (const UList< int64_t > &sendData, UList< int64_t > &recvData, const int tag, const int communicator=UPstream::worldComm) |
Exchange non-zero int64_t data between ranks [NBX]. More... | |
| static void | allToAllConsensus (const Map< int64_t > &sendData, Map< int64_t > &recvData, const int tag, const int communicator=UPstream::worldComm) |
Exchange int64_t data between ranks [NBX]. More... | |
| static Map< int64_t > | allToAllConsensus (const Map< int64_t > &sendData, const int tag, const int communicator=UPstream::worldComm) |
Exchange int64_t data between ranks [NBX]. More... | |
| template<class Type > | |
| static void | mpiGather (const Type *sendData, Type *recvData, int count, const int communicator=UPstream::worldComm) |
| Receive identically-sized (contiguous) data from all ranks. More... | |
| template<class Type > | |
| static void | mpiScatter (const Type *sendData, Type *recvData, int count, const int communicator=UPstream::worldComm) |
| Send identically-sized (contiguous) data to all ranks. More... | |
| template<class Type > | |
| static void | mpiAllGather (Type *allData, int count, const int communicator=UPstream::worldComm) |
| Gather/scatter identically-sized data. More... | |
| template<class Type > | |
| static void | mpiGatherv (const Type *sendData, int sendCount, Type *recvData, const UList< int > &recvCounts, const UList< int > &recvOffsets, const int communicator=UPstream::worldComm) |
| Receive variable length data from all ranks. More... | |
| template<class Type > | |
| static void | mpiScatterv (const Type *sendData, const UList< int > &sendCounts, const UList< int > &sendOffsets, Type *recvData, int recvCount, const int communicator=UPstream::worldComm) |
| Send variable length data to all ranks. More... | |
| template<class T > | |
| static List< T > | allGatherValues (const T &localValue, const int communicator=UPstream::worldComm) |
| Allgather individual values into list locations. More... | |
| template<class T > | |
| static List< T > | listGatherValues (const T &localValue, const int communicator=UPstream::worldComm) |
| Gather individual values into list locations. More... | |
| template<class T > | |
| static T | listScatterValues (const UList< T > &allValues, const int communicator=UPstream::worldComm) |
| Scatter individual values from list locations. More... | |
| template<class Type > | |
| static bool | broadcast (Type *buffer, std::streamsize count, const int communicator) |
| Broadcast buffer contents (contiguous types), from rank=0 to all ranks. The sizes must match on all processes. More... | |
| template<class T > | |
| static void | mpiReduce (T values[], int count, const UPstream::opCodes opCodeId, const int communicator) |
| MPI_Reduce (blocking) for known operators. More... | |
| template<class T > | |
| static void | mpiAllReduce (T values[], int count, const UPstream::opCodes opCodeId, const int communicator) |
| MPI_Allreduce (blocking) for known operators. More... | |
| template<class T > | |
| static void | mpiAllReduce (T values[], int count, const UPstream::opCodes opCodeId, const int communicator, UPstream::Request &req) |
| MPI_Iallreduce (non-blocking) for known operators. More... | |
| static void | reduceAnd (bool &value, const int communicator=worldComm) |
| Logical (and) reduction (MPI_AllReduce) More... | |
| static void | reduceOr (bool &value, const int communicator=worldComm) |
| Logical (or) reduction (MPI_AllReduce) More... | |
| static label | allocateCommunicator (const label parent, const labelRange &subRanks, const bool withComponents=true) |
| Create new communicator with sub-ranks on the parent communicator. More... | |
| static label | allocateCommunicator (const label parent, const labelUList &subRanks, const bool withComponents=true) |
| Create new communicator with sub-ranks on the parent communicator. More... | |
| static label | commInterHost () noexcept |
| Communicator between nodes (respects any local worlds) More... | |
| static label | commIntraHost () noexcept |
| Communicator within the node (respects any local worlds) More... | |
| static void | waitRequests () |
| Wait for all requests to finish. More... | |
| template<class Type > | |
| static void | gather (const Type *send, int count, Type *recv, const UList< int > &counts, const UList< int > &offsets, const int comm=UPstream::worldComm) |
| template<class Type > | |
| static void | scatter (const Type *send, const UList< int > &counts, const UList< int > &offsets, Type *recv, int count, const int comm=UPstream::worldComm) |
Static Public Attributes | |
| static const Enum< commsTypes > | commsTypeNames |
| Enumerated names for the communication types. More... | |
| static int | nodeCommsControl_ |
| Use of host/node topology-aware routines. More... | |
| static int | nodeCommsMin_ |
| Minimum number of nodes before topology-aware routines are enabled. More... | |
| static int | topologyControl_ |
| Selection of topology-aware routines as a bitmask combination of the topoControls enumerations. More... | |
| static bool | floatTransfer |
| Should compact transfer be used in which floats replace doubles reducing the bandwidth requirement at the expense of some loss in accuracy. More... | |
| static int | nProcsSimpleSum |
| Number of processors to change from linear to tree communication. More... | |
| static int | nProcsNonblockingExchange |
| Number of processors to change to nonBlocking consensual exchange (NBX). Ignored for zero or negative values. More... | |
| static int | nPollProcInterfaces |
| Number of polling cycles in processor updates. More... | |
| static commsTypes | defaultCommsType |
| Default commsType. More... | |
| static int | maxCommsSize |
| Optional maximum message size (bytes) More... | |
| static int | tuning_NBX_ |
| Tuning parameters for non-blocking exchange (NBX) More... | |
| static const int | mpiBufferSize |
| MPI buffer-size (bytes) More... | |
| static label | worldComm |
| Communicator for all ranks. May differ from commGlobal() if local worlds are in use. More... | |
| static label | warnComm |
| Debugging: warn for use of any communicator differing from warnComm. More... | |
Static Protected Member Functions | |
| static bool | mpi_broadcast (void *buf, std::streamsize count, const UPstream::dataTypes dataTypeId, const int communicator) |
| Broadcast buffer contents from rank=0 to all ranks. The sizes must match on all processes. More... | |
| static void | mpi_reduce (void *values, int count, const UPstream::dataTypes dataTypeId, const UPstream::opCodes opCodeId, const int communicator, UPstream::Request *req=nullptr) |
In-place reduction of values with result on rank 0. More... | |
| static void | mpi_allreduce (void *values, int count, const UPstream::dataTypes dataTypeId, const UPstream::opCodes opCodeId, const int communicator, UPstream::Request *req=nullptr) |
In-place reduction of values with same result on all ranks. More... | |
| static bool | mpi_send (const UPstream::commsTypes commsType, const void *buf, std::streamsize count, const UPstream::dataTypes dataTypeId, const int toProcNo, const int tag, const int communicator, UPstream::Request *req=nullptr, const UPstream::sendModes sendMode=UPstream::sendModes::normal) |
| Send buffer contents of specified data type to given processor. More... | |
| static std::streamsize | mpi_receive (const UPstream::commsTypes commsType, void *buf, std::streamsize count, const UPstream::dataTypes dataTypeId, const int fromProcNo, const int tag, const int communicator, UPstream::Request *req=nullptr) |
| Receive buffer contents of specified data type from given processor. More... | |
| static void | mpi_gather (const void *sendData, void *recvData, int count, const UPstream::dataTypes dataTypeId, const int communicator, UPstream::Request *req=nullptr) |
| Receive identically-sized (contiguous) data from all ranks, placing the result on rank 0. More... | |
| static void | mpi_scatter (const void *sendData, void *recvData, int count, const UPstream::dataTypes dataTypeId, const int communicator, UPstream::Request *req=nullptr) |
| Send identically-sized (contiguous) data from rank 0 to all other ranks. More... | |
| static void | mpi_allgather (void *allData, int count, const UPstream::dataTypes dataTypeId, const int communicator, UPstream::Request *req=nullptr) |
| Gather/scatter identically-sized data. More... | |
| static void | mpi_gatherv (const void *sendData, int sendCount, void *recvData, const UList< int > &recvCounts, const UList< int > &recvOffsets, const UPstream::dataTypes dataTypeId, const int communicator) |
| Receive variable length data from all ranks, placing the result on rank 0. (caution: known to scale poorly) More... | |
| static void | mpi_scatterv (const void *sendData, const UList< int > &sendCounts, const UList< int > &sendOffsets, void *recvData, int recvCount, const UPstream::dataTypes dataTypeId, const int communicator) |
| Send variable length data from rank 0 to all ranks. (caution: known to scale poorly) More... | |
Int ranges are used for MPI ranks (processes)
Definition at line 72 of file UPstream.H.
|
strong |
Communications types.
Definition at line 77 of file UPstream.H.
|
strong |
Different MPI-send modes (ignored for commsTypes::buffered)
| Enumerator | |
|---|---|
| normal | (MPI_Send, MPI_Isend) |
| sync | (MPI_Ssend, MPI_Issend) |
Definition at line 94 of file UPstream.H.
|
strong |
Mapping of some fundamental and aggregate types to MPI data types.
| Enumerator | |
|---|---|
| Basic_begin | (internal use) begin marker [basic/all types] |
| type_byte | byte, char, unsigned char, ... |
| type_int16 | |
| type_int32 | |
| type_int64 | |
| type_uint16 | |
| type_uint32 | |
| type_uint64 | |
| type_float | |
| type_double | |
| type_long_double | |
| Basic_end | (internal use) end marker [basic types] |
| User_begin | (internal use) begin marker [user types] |
| type_3float | 3*float (eg, floatVector) |
| type_3double | 3*double (eg, doubleVector) |
| type_6float | 6*float (eg, floatSymmTensor, complex vector) |
| type_6double | 6*double (eg, doubleSymmTensor, complex vector) |
| type_9float | 9*float (eg, floatTensor) |
| type_9double | 9*double (eg, doubleTensor) |
| invalid | invalid type (NULL) |
| User_end | (internal use) end marker [user types] |
| DataTypes_end | (internal use) end marker [all types] |
Definition at line 103 of file UPstream.H.
|
strong |
Mapping of some MPI op codes.
Currently excluding min/max location until they are needed
Definition at line 145 of file UPstream.H.
|
strong |
Some bit masks corresponding to topology controls.
These selectively enable topology-aware handling
Definition at line 184 of file UPstream.H.
|
inlineexplicitnoexcept |
Construct for given communication type.
Definition at line 1102 of file UPstream.H.
|
staticprotected |
Broadcast buffer contents from rank=0 to all ranks. The sizes must match on all processes.
For non-parallel : do nothing.
void pointer and the required data type (as per MPI). This means it should almost never be called directly but always via a compile-time checked caller. Definition at line 26 of file UPstreamBroadcast.C.
|
staticprotected |
In-place reduction of values with result on rank 0.
Includes internal parallel guard and checks on data types, opcode.
void pointer and the required data type (as per MPI). This means it should almost never be called directly but always via a compile-time checked caller. | [out] | req | request information (for non-blocking) |
Definition at line 57 of file UPstreamReduce.C.
|
staticprotected |
In-place reduction of values with same result on all ranks.
Includes internal parallel guard and checks on data types, opcode.
void pointer and the required data type (as per MPI). This means it should almost never be called directly but always via a compile-time checked caller. | [out] | req | request information (for non-blocking) |
Definition at line 69 of file UPstreamReduce.C.
|
staticprotected |
Send buffer contents of specified data type to given processor.
void pointer and the required data type (as per MPI). This means it should almost never be called directly but always via a compile-time checked caller. | [out] | req | request information (for non-blocking) |
| sendMode | optional send mode (normal | sync) |
Definition at line 36 of file UOPstreamWrite.C.
References NotImplemented.
|
staticprotected |
Receive buffer contents of specified data type from given processor.
void pointer and the required data type (as per MPI). This means it should almost never be called directly but always via a compile-time checked caller. The commsType will be ignored if UPstream::Request is specified.| [out] | req | request information (for non-blocking) |
Definition at line 27 of file UIPstreamRead.C.
References NotImplemented.
|
staticprotected |
Receive identically-sized (contiguous) data from all ranks, placing the result on rank 0.
Includes internal parallel guard. For non-parallel, does not copy any data. If needed, this must be done by the caller.
| sendData | All ranks: location of individual value to send | |
| recvData | Master: receive buffer with all values. Other ranks: ignored | |
| count | Number of send/recv data per rank. Globally consistent! | |
| [out] | req | request information (for non-blocking) |
Definition at line 26 of file UPstreamGatherScatter.C.
|
staticprotected |
Send identically-sized (contiguous) data from rank 0 to all other ranks.
Includes internal parallel guard.
| sendData | Master: send buffer with all values. Other ranks: ignored | |
| recvData | All ranks: location to receive individual value | |
| count | Number of send/recv data per rank. Globally consistent! | |
| [out] | req | request information (for non-blocking) |
Definition at line 39 of file UPstreamGatherScatter.C.
|
staticprotected |
Gather/scatter identically-sized data.
Send data from proc slot, receive into all slots
| allData | All ranks: the base of the data locations | |
| count | Number of send/recv data per rank. Globally consistent! | |
| [out] | req | request information (for non-blocking) |
Definition at line 52 of file UPstreamGatherScatter.C.
|
staticprotected |
Receive variable length data from all ranks, placing the result on rank 0. (caution: known to scale poorly)
| sendCount | Ignored on master if recvCount[0] == 0 |
| recvData | Ignored on non-root rank |
| recvCounts | Ignored on non-root rank |
| recvOffsets | Ignored on non-root rank |
Definition at line 66 of file UPstreamGatherScatter.C.
|
staticprotected |
Send variable length data from rank 0 to all ranks. (caution: known to scale poorly)
| sendData | Ignored on non-root rank |
| sendCounts | Ignored on non-root rank |
| sendOffsets | Ignored on non-root rank |
Definition at line 80 of file UPstreamGatherScatter.C.
| ClassName | ( | "UPstream" | ) |
Declare name of the class and its debug switch.
|
inlinestaticnoexcept |
Test for selection of given topology-aware routine.
Definition at line 932 of file UPstream.H.
References UPstream::topologyControl_.
|
inlinestaticnoexcept |
Communicator for all ranks, irrespective of any local worlds.
This value never changes during a simulation.
Definition at line 999 of file UPstream.H.
Referenced by multiWorldConnections::createComms(), fileOperation::getManagedComm(), UPstream::myWorld(), UPstream::myWorldID(), and syncObjects::sync().
|
inlinestaticnoexcept |
Communicator within the current rank only.
This value never changes during a simulation.
Definition at line 1006 of file UPstream.H.
Referenced by Foam::getCommPattern(), and fileOperation::getManagedComm().
|
inlinestaticnoexcept |
Communicator for all ranks (respecting any local worlds).
This value never changes after startup. Unlike the commWorld() which can be temporarily overriden.
Definition at line 1014 of file UPstream.H.
Referenced by globalIndex::splitNodeOffsets().
|
inlinestaticnoexcept |
Communicator for all ranks (respecting any local worlds)
Definition at line 1019 of file UPstream.H.
References UPstream::worldComm.
Referenced by mappedPatchBase::calcAMI(), multiWorldConnections::createComms(), mappedPatchBase::distribute(), fileOperation::getManagedComm(), mappedPatchBase::getWorldCommunicator(), profilingPstream::report(), and mappedPatchBase::reverseDistribute().
|
inlinestaticnoexcept |
Set world communicator. Negative values are a no-op.
Definition at line 1026 of file UPstream.H.
References UPstream::worldComm.
|
inlinestaticnoexcept |
Alter communicator debugging setting. Warns for use of any communicator differing from specified. Negative values disable.
Definition at line 1040 of file UPstream.H.
References UPstream::warnComm.
Referenced by mappedPatchBase::calcAMI(), mappedPatchBase::collectSamples(), multiWorldConnections::createComms(), mappedPatchBase::distribute(), mappedPatchBase::findSamples(), cyclicAMIGAMGInterfaceField::initInterfaceMatrixUpdate(), cyclicACMIGAMGInterfaceField::initInterfaceMatrixUpdate(), mappedPatchBase::reverseDistribute(), syncObjects::sync(), and globalMeshData::updateMesh().
|
inlinestaticnoexcept |
Number of currently defined communicators.
Definition at line 1050 of file UPstream.H.
References UList< T >::size().
|
static |
Debugging: print the communication tree.
Definition at line 737 of file UPstream.C.
References Foam::Info, UPstream::master(), and UPstream::whichCommunication().
|
inlinestaticnoexcept |
Communicator between nodes/hosts (respects any local worlds)
Definition at line 1063 of file UPstream.H.
Referenced by UPstream::commInterHost(), and globalIndex::splitNodeOffsets().
|
inlinestaticnoexcept |
Communicator within the node/host (respects any local worlds)
Definition at line 1071 of file UPstream.H.
Referenced by UPstream::commIntraHost().
|
inlinestaticnoexcept |
Both inter-node and local-node communicators have been created.
Definition at line 1079 of file UPstream.H.
|
static |
True if node topology-aware routines have been enabled, it is running in parallel, the starting point is the world-communicator and it is not an odd corner case (ie, all processes on one node, all processes on different nodes)
Definition at line 751 of file UPstream.C.
Referenced by UPstream::printNodeCommsControl(), and UPstream::commsStruct::reset().
|
static |
Create new communicator with sub-ranks on the parent communicator.
| parent | The parent communicator |
| subRanks | The contiguous sub-ranks of parent to use |
| withComponents | Call allocateCommunicatorComponents() |
Definition at line 272 of file UPstream.C.
References IntRange< IntType >::contains(), Foam::ensightOutput::debug, IntRange< IntType >::empty(), Foam::endl(), UPstream::masterNo(), Foam::nl, UPstream::parRun(), Foam::Perr, IntRange< IntType >::size(), and IntRange< IntType >::start().
Referenced by eagerGAMGProcAgglomeration::agglomerate(), manualGAMGProcAgglomeration::agglomerate(), procFacesGAMGProcAgglomeration::agglomerate(), masterCoarsestGAMGProcAgglomeration::agglomerate(), UPstream::allocateCommunicator(), Foam::getCommPattern(), and UPstream::communicator::reset().
|
static |
Create new communicator with sub-ranks on the parent communicator.
| parent | The parent communicator |
| subRanks | The sub-ranks of parent to use (ignore negative values) |
| withComponents | Call allocateCommunicatorComponents() |
Definition at line 322 of file UPstream.C.
References UList< T >::contains(), Foam::BitOps::count(), Foam::ensightOutput::debug, UList< T >::empty(), Foam::endl(), Foam::flatOutput(), UPstream::masterNo(), Foam::nl, UPstream::parRun(), Foam::Perr, UList< T >::size(), and Foam::sort().
|
static |
Duplicate the parent communicator.
Always calls dupCommunicatorComponents() internally
| parent | The parent communicator |
Definition at line 401 of file UPstream.C.
References Foam::ensightOutput::debug, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, FOAM_UNLIKELY, UPstream::parRun(), and Foam::Perr.
Referenced by UPstream::communicator::duplicate().
|
static |
Allocate a new communicator by splitting the parent communicator on the given colour.
Always calls splitCommunicatorComponents() internally
| parent | 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 439 of file UPstream.C.
References Foam::ensightOutput::debug, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, FOAM_UNLIKELY, UPstream::parRun(), and Foam::Perr.
Referenced by UPstream::communicator::split().
|
static |
Free a previously allocated communicator.
Ignores placeholder (negative) communicators.
Definition at line 622 of file UPstream.C.
References Foam::ensightOutput::debug, Foam::endl(), and Foam::Perr.
Referenced by GAMGProcAgglomeration::clearCommunicators(), UPstream::communicator::reset(), collatedFileOperation::~collatedFileOperation(), UPstream::communicator::~communicator(), hostCollatedFileOperation::~hostCollatedFileOperation(), hostUncollatedFileOperation::~hostUncollatedFileOperation(), masterUncollatedFileOperation::~masterUncollatedFileOperation(), OFstreamCollator::~OFstreamCollator(), and uncollatedFileOperation::~uncollatedFileOperation().
|
static |
Return physical processor number (i.e. processor number in worldComm) given communicator and processor.
Definition at line 657 of file UPstream.C.
References UPstream::parent(), and UPstream::procID().
Referenced by UPstream::procNo().
|
static |
Return processor number in communicator (given physical processor number) (= reverse of baseProcNo)
Definition at line 670 of file UPstream.C.
References UPstream::parent(), and UPstream::procID().
Referenced by UPstream::procNo().
|
static |
Return processor number in communicator (given processor number and communicator)
Definition at line 687 of file UPstream.C.
References UPstream::baseProcNo(), and UPstream::procNo().
Add the valid option this type of communications library adds/requires on the command line.
Definition at line 26 of file UPstream.C.
|
static |
Initialisation function called from main.
Spawns sub-processes and initialises inter-communication
Definition at line 40 of file UPstream.C.
References Foam::endl(), Foam::exit(), Foam::FatalError, and FatalErrorInFunction.
Referenced by UPstream::commsStructList::init(), and ParRunControl::runPar().
|
static |
Special purpose initialisation function.
Performs a basic MPI_Init without any other setup. Only used for applications that need MPI communication when OpenFOAM is running in a non-parallel mode.
Definition at line 30 of file UPstream.C.
References Foam::endl(), and WarningInFunction.
Referenced by zoltanRenumber::renumber().
|
static |
Impose a synchronisation barrier (optionally non-blocking)
Definition at line 106 of file UPstream.C.
|
static |
Impose a point-to-point synchronisation barrier by sending a zero-byte "done" message to given rank.
A no-op for non-parallel
| toProcNo | The destination rank |
| communicator | The communicator index (eg, UPstream::worldComm) |
| tag | Message tag (must match on receiving side) |
Definition at line 111 of file UPstream.C.
|
static |
Impose a point-to-point synchronisation barrier by receiving a zero-byte "done" message from given rank.
A no-op for non-parallel
| fromProcNo | The source rank (negative == ANY_SOURCE) |
| communicator | The communicator index (eg, UPstream::worldComm) |
| tag | Message tag (must match on sending side) |
Definition at line 120 of file UPstream.C.
|
static |
Probe for an incoming message.
| commsType | Non-blocking or not |
| fromProcNo | The source rank (negative == ANY_SOURCE) |
| tag | The source message tag |
| communicator | The communicator index |
Definition at line 132 of file UPstream.C.
|
static |
Report the node-communication settings.
Definition at line 56 of file UPstream.C.
References UPstream::nodeCommsControl_, UPstream::nodeCommsMin_, UPstream::nProcs(), UPstream::numNodes(), os(), UPstream::usingNodeComms(), and UPstream::worldComm.
Referenced by argList::parse().
|
static |
Report the topology routines settings.
Definition at line 100 of file UPstream.C.
References Foam::PstreamDetail::broadcast(), Foam::BitOps::count(), Foam::PstreamDetail::gather(), os(), PrintControl, Foam::reduce(), and UPstream::topologyControl_.
Referenced by argList::parse().
|
staticnoexcept |
Number of outstanding requests (on the internal list of requests)
Definition at line 54 of file UPstreamRequest.C.
Referenced by processorGAMGInterfaceField::initInterfaceMatrixUpdate(), faceAreaPairGAMGAgglomeration::movePoints(), syncTools::syncBoundaryFaceList(), syncTools::syncFaceList(), and OFstreamCollator::write().
|
static |
Truncate outstanding requests to given length, which is expected to be in the range [0 to nRequests()].
A no-op for out-of-range values.
Definition at line 56 of file UPstreamRequest.C.
|
static |
Transfer the (wrapped) MPI request to the internal global list and invalidate the parameter (ignores null requests)
A no-op for non-parallel
Definition at line 58 of file UPstreamRequest.C.
|
static |
Non-blocking comms: cancel and free outstanding request. Corresponds to MPI_Cancel() + MPI_Request_free()
A no-op if parRun() == false if there are no pending requests, or if the index is out-of-range (0 to nRequests)
Definition at line 60 of file UPstreamRequest.C.
Referenced by UPstream::Request::cancel().
|
static |
Non-blocking comms: cancel and free outstanding request. Corresponds to MPI_Cancel() + MPI_Request_free()
A no-op for non-parallel
Definition at line 61 of file UPstreamRequest.C.
|
static |
Non-blocking comms: cancel and free outstanding requests. Corresponds to MPI_Cancel() + MPI_Request_free()
A no-op if parRun() == false or list is empty
Definition at line 62 of file UPstreamRequest.C.
|
static |
Non-blocking comms: cancel/free outstanding requests (from position onwards) and remove from internal list of requests. Corresponds to MPI_Cancel() + MPI_Request_free()
A no-op if parRun() == false, if the position is out-of-range [0 to nRequests()], or the internal list of requests is empty.
| pos | starting position within the internal list of requests |
| len | length of slice to remove (negative = until the end) |
Definition at line 64 of file UPstreamRequest.C.
|
static |
Non-blocking comms: free outstanding request. Corresponds to MPI_Request_free()
A no-op if parRun() == false
Definition at line 66 of file UPstreamRequest.C.
Referenced by UPstream::Request::free().
|
static |
Non-blocking comms: free outstanding requests. Corresponds to MPI_Request_free()
A no-op if parRun() == false or list is empty
Definition at line 67 of file UPstreamRequest.C.
|
static |
Wait until all requests (from position onwards) have finished. Corresponds to MPI_Waitall()
A no-op if parRun() == false, if the position is out-of-range [0 to nRequests()], or the internal list of requests is empty.
If checking a trailing portion of the list, it will also trim the list of outstanding requests as a side-effect. This is a feature (not a bug) to conveniently manange the list.
| pos | starting position within the internal list of requests |
| len | length of slice to check (negative = until the end) |
Definition at line 69 of file UPstreamRequest.C.
|
static |
Wait until all requests have finished. Corresponds to MPI_Waitall()
A no-op if parRun() == false, or the list is empty.
Definition at line 70 of file UPstreamRequest.C.
|
static |
Wait until any request (from position onwards) has finished. Corresponds to MPI_Waitany()
A no-op and returns false if parRun() == false, if the position is out-of-range [0 to nRequests()], or the internal list of requests is empty.
| pos | starting position within the internal list of requests |
| len | length of slice to check (negative = until the end) |
Definition at line 72 of file UPstreamRequest.C.
|
static |
Wait until some requests (from position onwards) have finished. Corresponds to MPI_Waitsome()
A no-op and returns false if parRun() == false, if the position is out-of-range [0 to nRequests], or the internal list of requests is empty.
| pos | starting position within the internal list of requests | |
| len | length of slice to check (negative = until the end) | |
| [out] | indices | the completed request indices relative to the starting position. This is an optional parameter that can be used to recover the indices or simply to avoid reallocations when calling within a loop. |
Definition at line 78 of file UPstreamRequest.C.
References DynamicList< T, SizeMin >::clear().
|
static |
Wait until some requests have finished. Corresponds to MPI_Waitsome()
A no-op and returns false if parRun() == false, the list is empty, or if all the requests have already been handled.
| requests | the requests | |
| [out] | indices | the completed request indices relative to the starting position. This is an optional parameter that can be used to recover the indices or simply to avoid reallocations when calling within a loop. |
Definition at line 89 of file UPstreamRequest.C.
References DynamicList< T, SizeMin >::clear().
|
static |
Wait until any request has finished and return its index. Corresponds to MPI_Waitany()
Returns -1 if parRun() == false, or the list is empty, or if all the requests have already been handled
Definition at line 98 of file UPstreamRequest.C.
|
static |
Wait until request i has finished. Corresponds to MPI_Wait()
A no-op if parRun() == false, if there are no pending requests, or if the index is out-of-range (0 to nRequests)
void Foam::UPstream::waitRequests ( UPstream::Request& req0, UPstream::Request& req1 ) { // No-op for non-parallel if (!UPstream::parRun()) { return; }
int count = 0; MPI_Request waitRequests[2];
waitRequests[count] = PstreamUtils::Cast::to_mpi(req0); if (MPI_REQUEST_NULL != waitRequests[count]) { ++count; }
waitRequests[count] = PstreamUtils::Cast::to_mpi(req1); if (MPI_REQUEST_NULL != waitRequests[count]) { ++count; }
// Flag in advance as being handled req0 = UPstream::Request(MPI_REQUEST_NULL); req1 = UPstream::Request(MPI_REQUEST_NULL);
if (!count) { return; }
profilingPstream::beginTiming();
// On success: sets each request to MPI_REQUEST_NULL if (MPI_Waitall(count, waitRequests, MPI_STATUSES_IGNORE)) { FatalErrorInFunction << "MPI_Waitall returned with error" << Foam::abort(FatalError); }
profilingPstream::addWaitTime(); }
Definition at line 103 of file UPstreamRequest.C.
Referenced by processorGAMGInterfaceField::updateInterfaceMatrix(), and UPstream::Request::wait().
|
static |
Wait until specified request has finished. Corresponds to MPI_Wait()
A no-op if parRun() == false or for a null-request
Definition at line 104 of file UPstreamRequest.C.
|
static |
Non-blocking comms: has request i finished? Corresponds to MPI_Test()
A no-op and returns true if parRun() == false, if there are no pending requests, or if the index is out-of-range (0 to nRequests)
Definition at line 106 of file UPstreamRequest.C.
Referenced by UPstream::Request::finished(), processorGAMGInterfaceField::ready(), and processorGAMGInterfaceField::updateInterfaceMatrix().
|
static |
Non-blocking comms: has request finished? Corresponds to MPI_Test()
A no-op and returns true if parRun() == false or for a null-request
Definition at line 107 of file UPstreamRequest.C.
|
static |
Non-blocking comms: have all requests (from position onwards) finished? Corresponds to MPI_Testall()
A no-op and returns true if parRun() == false, if there are no pending requests, or if the index is out-of-range (0 to nRequests) or the addressed range is empty etc.
| pos | starting position within the internal list of requests |
| len | length of slice to check (negative = until the end) |
Definition at line 109 of file UPstreamRequest.C.
Referenced by cyclicAMIGAMGInterfaceField::ready(), and cyclicACMIGAMGInterfaceField::ready().
|
static |
Non-blocking comms: have all requests finished? Corresponds to MPI_Testall()
A no-op and returns true if parRun() == false or list is empty
Definition at line 115 of file UPstreamRequest.C.
|
static |
Non-blocking comms: have both requests finished? Corresponds to pair of MPI_Test()
A no-op and returns true if parRun() == false, if there are no pending requests, or if the indices are out-of-range (0 to nRequests) Each finished request parameter is set to -1 (ie, done).
Definition at line 121 of file UPstreamRequest.C.
|
static |
Non-blocking comms: wait for both requests to finish. Corresponds to pair of MPI_Wait()
A no-op if parRun() == false, if there are no pending requests, or if the indices are out-of-range (0 to nRequests) Each finished request parameter is set to -1 (ie, done).
Definition at line 129 of file UPstreamRequest.C.
|
inlinestaticnoexcept |
|
inlinestaticnoexcept |
Test if this a parallel run.
Modify access is deprecated
Definition at line 1586 of file UPstream.H.
Referenced by snappyLayerDriver::addLayers(), unwatchedIOdictionary::addWatch(), regIOobject::addWatch(), masterUncollatedFileOperation::addWatch(), masterUncollatedFileOperation::addWatches(), meshRefinement::balance(), addPatchCellLayer::calcExtrudeInfo(), processorCyclicPolyPatch::calcGeometry(), processorPolyPatch::calcGeometry(), processorFaPatch::calcGeometry(), surfaceNoise::calculate(), call_window_allocate(), call_window_create(), cyclicAMIPolyPatch::canResetAMI(), designVariablesUpdate::checkConvergence(), faBoundaryMesh::checkParallelSync(), polyBoundaryMesh::checkParallelSync(), AMIInterpolation::checkSymmetricWeights(), fieldValue::combineFields(), limitTurbulenceViscosity::correct(), meshRefinement::countEdgeFaces(), processorFvPatch::coupled(), cyclicAMIPointPatch::coupled(), processorPointPatchField< Type >::coupled(), processorCyclicPointPatchField< Type >::coupled(), processorFaePatchField< Type >::coupled(), processorCyclicFvsPatchField< Type >::coupled(), processorFvsPatchField< Type >::coupled(), calculatedProcessorFvPatchField< Type >::coupled(), processorFaPatchField< Type >::coupled(), processorFvPatchField< Type >::coupled(), cyclicACMIFvPatch::coupled(), cyclicAMIFvPatch::coupled(), processorFaPatch::coupled(), processorPolyPatch::coupled(), simpleGeomDecomp::decompose(), decompositionMethod::decompose(), conformalVoronoiMesh::decomposition(), processorFvPatch::delta(), processorFaPatch::delta(), masterUncollatedFileOperation::dirPath(), refinementHistory::distribute(), fvMeshDistribute::distribute(), distributedTriSurfaceMesh::distribute(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), snappyLayerDriver::doLayers(), snappyRefineDriver::doRefine(), UPstream::dupCommunicator(), ensightSurfaceReader::ensightSurfaceReader(), Foam::exitNow(), faMeshReconstructor::faMeshReconstructor(), masterUncollatedFileOperation::filePath(), polyMesh::findCell(), masterUncollatedFileOperation::findInstance(), distributedTriSurfaceMesh::findLine(), distributedTriSurfaceMesh::findLineAll(), distributedTriSurfaceMesh::findLineAny(), distributedTriSurfaceMesh::findNearest(), masterUncollatedFileOperation::findTimes(), masterUncollatedFileOperation::findWatch(), ensightSurfaceReader::geometry(), Foam::getCommPattern(), zoneDistribute::getDatafromOtherProc(), distributedTriSurfaceMesh::getField(), masterUncollatedFileOperation::getFile(), distributedTriSurfaceMesh::getNormal(), distributedTriSurfaceMesh::getRegion(), masterUncollatedFileOperation::getState(), distributedTriSurfaceMesh::getVolumeType(), faMeshBoundaryHalo::haloSize(), InflationInjection< CloudType >::InflationInjection(), faMesh::init(), processorPolyPatch::initGeometry(), processorFaPatch::initGeometry(), InjectedParticleInjection< CloudType >::initialise(), InjectedParticleDistributionInjection< CloudType >::initialise(), extractEulerianParticles::initialiseBins(), processorPolyPatch::initOrder(), processorPolyPatch::initUpdateMesh(), processorFaPatch::initUpdateMesh(), fileOperation::isIOrank(), fileOperation::lookupAndCacheProcessorsPath(), LUscalarMatrix::LUscalarMatrix(), processorFaPatch::makeCorrectionVectors(), processorFaPatch::makeDeltaCoeffs(), processorFaPatch::makeLPN(), processorFaPatch::makeNonGlobalPatchPoints(), processorFvPatch::makeWeights(), processorFaPatch::makeWeights(), error::master(), mergedSurf::merge(), surfaceWriter::merge(), surfaceWriter::mergeFieldTemplate(), polyBoundaryMesh::neighbourEdges(), UPstream::newCommunicator(), masterUncollatedFileOperation::NewIFstream(), faMeshTools::newMesh(), fvMeshTools::newMesh(), fileWriter::open(), processorPolyPatch::order(), InflationInjection< CloudType >::parcelsToInject(), argList::parse(), meshRefinement::printMeshInfo(), processorTopology::procAdjacency(), collatedFileOperation::processorsDir(), triangulatedPatch::randomGlobalPoint(), surfaceNoise::read(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), lumpedPointState::readData(), Time::readModifiedObjects(), masterUncollatedFileOperation::readObjects(), masterUncollatedFileOperation::readStream(), surfaceNoise::readSurfaceData(), masterUncollatedFileOperation::removeWatch(), parProfiling::report(), profilingPstream::report(), AMIWeights::reportPatch(), faMeshBoundaryHalo::reset(), fvMeshSubset::reset(), globalIndex::reset(), mapDistributeBase::schedule(), Time::setControls(), foamReport::setStaticBuiltins(), surfaceWriter::setSurface(), masterUncollatedFileOperation::setUnmodified(), zoneDistribute::setUpCommforZone(), globalMeshData::sharedPoints(), shortestPathSet::shortestPathSet(), error::simpleExit(), UPstream::splitCommunicator(), globalIndex::splitNodeOffsets(), messageStream::stream(), surfaceWriter::surface(), surfaceNoise::surfaceAverage(), syncObjects::sync(), masterUncollatedFileOperation::sync(), syncTools::syncBoundaryFaceList(), syncTools::syncEdgeMap(), syncTools::syncFaceList(), faMesh::syncGeom(), syncTools::syncPointMap(), triSurfaceMesh::triSurfaceMesh(), fileOperation::uniformFile(), turbulentDFSEMInletFvPatchVectorField::updateCoeffs(), processorPolyPatch::updateMesh(), processorFaPatch::updateMesh(), faMesh::updateMesh(), masterUncollatedFileOperation::updateStates(), fileOperation::updateStates(), dynamicCode::waitForFile(), viewFactorHeatFlux::write(), energySpectrum::write(), ensightCells::write(), vtkWrite::write(), meshToMeshMethod::writeConnectivity(), AMIWeights::writeFileHeader(), fieldMinMax::writeFileHeader(), isoAdvection::writeIsoFaces(), faMeshReconstructor::writeMesh(), patchMeshWriter::writeNeighIDs(), collatedFileOperation::writeObject(), fileWriter::writeProcIDs(), surfaceNoise::writeSurfaceData(), and streamLineBase::writeToFile().
|
inlinestaticnoexcept |
Have support for threads.
Definition at line 1591 of file UPstream.H.
Referenced by OFstreamCollator::write().
|
inlinestaticnoexcept |
Relative rank for the master process - is always 0.
Definition at line 1596 of file UPstream.H.
Referenced by Foam::createReconstructMap(), lduPrimitiveMesh::gather(), UPstream::is_rank(), UPstream::is_subrank(), LUscalarMatrix::LUscalarMatrix(), UPstream::master(), UPstream::newCommunicator(), masterUncollatedFileOperation::NewIFstream(), argList::parse(), decomposedBlockData::readBlocks(), masterUncollatedFileOperation::readHeader(), mapDistributeBase::schedule(), globalMeshData::sharedPoints(), syncTools::syncEdgeMap(), syncTools::syncPointMap(), energySpectrum::write(), decomposedBlockData::writeBlocks(), patchMeshWriter::writeNeighIDs(), patchMeshWriter::writePatchIDs(), and patchMeshWriter::writePoints().
|
inlinestatic |
Number of ranks in parallel run (for given communicator). It is 1 for serial run.
Definition at line 1602 of file UPstream.H.
References UList< T >::size().
Referenced by surfaceZonesInfo::addCellZonesToMesh(), surfaceZonesInfo::addFaceZonesToMesh(), eagerGAMGProcAgglomeration::agglomerate(), manualGAMGProcAgglomeration::agglomerate(), procFacesGAMGProcAgglomeration::agglomerate(), masterCoarsestGAMGProcAgglomeration::agglomerate(), meshRefinement::balance(), faPatch::boundaryProcs(), faMesh::boundaryProcs(), faPatch::boundaryProcSizes(), faMesh::boundaryProcSizes(), mapDistributeBase::calcCompactAddressing(), decomposedBlockData::calcNumProcs(), surfaceNoise::calculate(), meshRefinement::checkCoupledFaceZones(), mappedPatchBase::collectSamples(), fieldValue::combineFields(), sizeDistribution::combineFields(), GAMGAgglomeration::continueAgglomerating(), fvMeshDistribute::countCells(), Foam::createReconstructMap(), meshRefinement::directionalRefineCandidates(), fvMeshDistribute::distribute(), distributedTriSurfaceMesh::distribute(), snappyLayerDriver::doLayers(), mapDistributeBase::exchangeAddressing(), extendedUpwindCellToFaceStencil::extendedUpwindCellToFaceStencil(), distributedTriSurfaceMesh::findNearest(), mappedPatchBase::findSamples(), lduPrimitiveMesh::gather(), decomposedBlockData::gather(), decomposedBlockData::gatherSlaveData(), UPstream::commsStructList::get(), fileOperation::getGlobalHostIORanks(), Foam::getSelectedProcs(), distributedTriSurfaceMesh::getVolumeType(), UPstream::commsStructList::init(), InjectedParticleInjection< CloudType >::initialise(), InjectedParticleDistributionInjection< CloudType >::initialise(), viewFactor::initialise(), UPstream::interNode_offsets(), distributedTriSurfaceMesh::localQueries(), fileOperation::lookupAndCacheProcessorsPath(), LUscalarMatrix::LUscalarMatrix(), mapDistributeBase::mapDistributeBase(), masterUncollatedFileOperation::masterUncollatedFileOperation(), masterUncollatedFileOperation::NewIFstream(), InflationInjection< CloudType >::parcelsToInject(), argList::parse(), pointHistory::pointHistory(), mapDistributeBase::printLayout(), meshRefinement::printMeshInfo(), UPstream::printNodeCommsControl(), fileOperation::printRanks(), processorTopology::procAdjacency(), masterUncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readStream(), meshRefinement::refineCandidates(), Foam::regionSum(), meshRefinement::removeGapCells(), parProfiling::report(), profilingPstream::report(), faMeshBoundaryHalo::reset(), fvMeshSubset::reset(), globalIndex::reset(), mapDistributeBase::schedule(), Time::setControls(), foamReport::setStaticBuiltins(), zoneDistribute::setUpCommforZone(), ParSortableList< Type >::sort(), globalIndex::splitNodeOffsets(), fileOperation::subRanks(), trackingInverseDistance::update(), inverseDistance::update(), oversetFvMeshBase::updateAddressing(), turbulentDFSEMInletFvPatchVectorField::updateCoeffs(), patchInjectionBase::updateMesh(), globalMeshData::updateMesh(), decomposedBlockData::writeBlocks(), externalCoupled::writeGeometry(), isoAdvection::writeIsoFaces(), caseInfo::writeMeta(), and streamLineBase::writeToFile().
|
inlinestatic |
Rank of this process in the communicator (starting from masterNo()). Negative if the process is not a rank in the communicator.
Definition at line 1611 of file UPstream.H.
Referenced by surfaceZonesInfo::addCellZonesToMesh(), surfaceZonesInfo::addFaceZonesToMesh(), eagerGAMGProcAgglomeration::agglomerate(), manualGAMGProcAgglomeration::agglomerate(), masterCoarsestGAMGProcAgglomeration::agglomerate(), faPatch::boundaryProcs(), faMesh::boundaryProcs(), faPatch::boundaryProcSizes(), faMesh::boundaryProcSizes(), Foam::calcCellCellsImpl(), mapDistributeBase::calcCompactAddressing(), globalIndex::calcOffset(), globalIndex::calcRange(), faceAreaWeightAMI::calculate(), viewFactor::calculate(), AMIInterpolation::calculate(), GAMGAgglomeration::calculateRegionMaster(), meshRefinement::checkCoupledFaceZones(), mappedPatchBase::collectSamples(), fieldValue::combineFields(), sizeDistribution::combineFields(), wallDistAddressing::correct(), Foam::createReconstructMap(), noDecomp::decompose(), snappyLayerDriver::determineSidePatches(), fvMeshDistribute::distribute(), distributedTriSurfaceMesh::distribute(), mapDistributeBase::exchangeAddressing(), processorField::execute(), InjectionModel< CloudType >::findCellAtPosition(), patchProbes::findElements(), probes::findElements(), mappedPatchBase::findLocalSamples(), distributedTriSurfaceMesh::findNearest(), mappedPatchBase::findSamples(), decomposedBlockData::gatherSlaveData(), get_edge_list(), get_vertex_list(), zoneDistribute::getDatafromOtherProc(), fileOperation::getGlobalHostIORanks(), meshRefinement::getMasterEdges(), meshRefinement::getMasterPoints(), Foam::getSelectedProcs(), InjectedParticleInjection< CloudType >::initialise(), InjectedParticleDistributionInjection< CloudType >::initialise(), viewFactor::initialise(), globalIndex::inplaceToGlobal(), globalIndex::isLocal(), lduPrimitiveMesh::lduPrimitiveMesh(), globalIndex::localEnd(), UPstream::localNode_parentProcs(), globalIndex::localSize(), globalIndex::localStart(), mapDistribute::mapDistribute(), mapDistributeBase::mapDistributeBase(), masterUncollatedFileOperation::masterUncollatedFileOperation(), PstreamBuffers::maxNonLocalRecvCount(), globalIndex::maxNonLocalSize(), processorColour::myColour(), UPstream::myWorld(), UPstream::myWorldID(), masterUncollatedFileOperation::NewIFstream(), regionSplit::nLocalRegions(), InflationInjection< CloudType >::parcelsToInject(), argList::parse(), pointHistory::pointHistory(), mapDistributeBase::printLayout(), fileOperation::printRanks(), processorTopology::procAdjacency(), backgroundMeshDecomposition::procBounds(), triangulatedPatch::randomGlobalPoint(), globalIndex::range(), masterUncollatedFileOperation::read(), masterUncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readStream(), indexedVertex< Gt, Vb >::referred(), zoltanRenumber::renumber(), mapDistributeBase::renumber(), faMeshBoundaryHalo::reset(), fvMeshSubset::reset(), globalIndex::reset(), mapDistributeBase::schedule(), cellSetOption::setCellSelection(), Time::setControls(), patchInjectionBase::setPositionAndCell(), zoneDistribute::setUpCommforZone(), ParSortableList< Type >::sort(), KinematicSurfaceFilm< CloudType >::splashInteraction(), globalIndex::splitNodeOffsets(), fileOperation::subRanks(), masterUncollatedFileOperation::sync(), globalIndex::toGlobal(), globalIndex::toLocal(), trackingInverseDistance::update(), inverseDistance::update(), oversetFvMeshBase::updateAddressing(), patchInjectionBase::updateMesh(), processorField::updateMesh(), globalMeshData::updateMesh(), propellerInfo::updateSampleDiskCells(), dynamicCode::waitForFile(), globalIndex::whichProcID(), cyclicAMIGAMGInterface::write(), cyclicACMIGAMGInterface::write(), meshToMeshMethod::writeConnectivity(), AMIInterpolation::writeFaceConnectivity(), externalCoupled::writeGeometry(), isoAdvection::writeIsoFaces(), and fileWriter::writeProcIDs().
|
inlinestatic |
True if process corresponds to the master rank in the communicator.
Definition at line 1619 of file UPstream.H.
References UPstream::masterNo().
Referenced by abaqusMeshSet::abaqusMeshSet(), regIOobject::addWatch(), masterUncollatedFileOperation::addWatch(), masterUncollatedFileOperation::addWatches(), Foam::broadcastFile_recursive(), Foam::broadcastFile_single(), mappedPatchBase::calcMapping(), decomposedBlockData::calcNumProcs(), pointNoise::calculate(), viewFactor::calculate(), surfaceNoise::calculate(), writeFile::canResetFile(), writeFile::canWriteHeader(), writeFile::canWriteToFile(), argList::check(), fileWriter::checkFormatterValidity(), argList::checkRootCase(), extractEulerianParticles::collectParticle(), sizeDistribution::combineFields(), logFiles::createFiles(), Foam::createReconstructMap(), simpleGeomDecomp::decompose(), masterUncollatedFileOperation::dirPath(), systemCall::dispatch(), distributedTriSurfaceMesh::distribute(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), snappyVoxelMeshDriver::doRefine(), abort::end(), ensightSurfaceReader::ensightSurfaceReader(), abort::execute(), wallHeatFlux::execute(), Curle::execute(), momentum::execute(), graphFunctionObject::execute(), externalFileCoupler::externalFileCoupler(), masterUncollatedFileOperation::filePath(), logFiles::files(), probes::findElements(), masterUncollatedFileOperation::findInstance(), masterUncollatedFileOperation::findTimes(), masterUncollatedFileOperation::findWatch(), STDMD::fit(), lduPrimitiveMesh::gather(), decomposedBlockData::gather(), decomposedBlockData::gatherSlaveData(), coordSet::gatherSort(), ensightSurfaceReader::geometry(), masterUncollatedFileOperation::getFile(), Foam::getSelectedProcs(), masterUncollatedFileOperation::getState(), Random::globalGaussNormal(), Random::globalPosition(), Random::globalRandomise01(), Random::globalSample01(), surfaceNoise::initialise(), viewFactor::initialise(), interfaceHeight::interfaceHeight(), fileOperation::isIOrank(), JobInfo::JobInfo(), fileOperation::lookupAndCacheProcessorsPath(), LUscalarMatrix::LUscalarMatrix(), NURBS3DVolume::makeFolders(), error::master(), messageStream::masterStream(), surfaceWriter::mergeFieldTemplate(), ensightCase::newCloud(), writeFile::newFile(), writeFile::newFileAtTime(), ensightCase::newGeometry(), masterUncollatedFileOperation::NewIFstream(), faMeshTools::newMesh(), fvMeshTools::newMesh(), fileOperation::nProcs(), objectiveManager::objectiveManager(), fileWriter::open(), InflationInjection< CloudType >::parcelsToInject(), argList::parse(), pointHistory::pointHistory(), porosityModel::porosityModel(), probes::prepare(), UPstream::printCommTree(), meshRefinement::printMeshInfo(), fileOperation::printRanks(), pointNoise::processData(), timeActivatedFileUpdate::read(), decomposedBlockData::read(), writeFile::read(), uncollatedFileOperation::read(), externalCoupled::read(), sampledSets::read(), sampledSurfaces::read(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlocks(), baseIOdictionary::readData(), lumpedPointState::readData(), masterUncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readObjects(), masterUncollatedFileOperation::readStream(), surfaceNoise::readSurfaceData(), externalCoupled::removeDataMaster(), externalCoupled::removeDataSlave(), masterUncollatedFileOperation::removeWatch(), profilingPstream::report(), globalIndex::reset(), logFiles::resetNames(), mapDistributeBase::schedule(), faMatrix< Type >::setReference(), ensightCase::setTime(), masterUncollatedFileOperation::setUnmodified(), globalMeshData::sharedPoints(), shortestPathSet::shortestPathSet(), externalFileCoupler::shutdown(), snappyVoxelMeshDriver::snappyVoxelMeshDriver(), rigidBodyMeshMotionSolver::solve(), rigidBodyMeshMotion::solve(), rigidBodyMotion::solve(), ParSortableList< Type >::sort(), globalIndex::splitNodeOffsets(), messageStream::stream(), surfaceNoise::surfaceAverage(), hexRef8Data::sync(), masterUncollatedFileOperation::sync(), syncTools::syncEdgeMap(), syncTools::syncPointMap(), triSurfaceMesh::triSurfaceMesh(), sixDoFRigidBodyMotion::update(), lumpedPointDisplacementPointPatchVectorField::updateCoeffs(), activePressureForceBaffleVelocityFvPatchVectorField::updateCoeffs(), electrostaticDepositionFvPatchScalarField::updateCoeffs(), fileMonitor::updateStates(), masterUncollatedFileOperation::updateStates(), solution::upgradeSolverDict(), externalFileCoupler::useMaster(), externalFileCoupler::useSlave(), OFstreamCollator::waitAll(), externalFileCoupler::waitForMaster(), externalFileCoupler::waitForSlave(), histogramModel::write(), ensightFaMesh::write(), timeInfo::write(), debugWriter::write(), proxyWriter::write(), energySpectrum::write(), viewFactorHeatFlux::write(), x3dWriter::write(), starcdWriter::write(), OFstreamCollator::write(), rawWriter::write(), foamWriter::write(), yPlus::write(), referenceTemperature::write(), wallShearStress::write(), abaqusWriter::write(), vtkWriter::write(), ensightMesh::write(), boundaryDataWriter::write(), foamReport::write(), caseInfo::write(), vtkCloud::write(), nastranWriter::write(), sizeDistribution::write(), NURBS3DCurve::write(), effectivenessTable::write(), graphFunctionObject::write(), volFieldValue::write(), vtkWrite::write(), regionSizeDistribution::write(), NURBS3DSurface::write(), surfaceFieldValue::write(), propellerInfo::writeAxialWake(), decomposedBlockData::writeBlocks(), volumetricBSplinesDesignVariables::writeBounds(), ensightCells::writeBox(), ensightWriter::writeCollated(), updateMethod::writeCorrection(), NURBS3DVolume::writeCps(), decomposedBlockData::writeData(), lumpedPointMovement::writeData(), lumpedPointMovement::writeForcesAndMomentsVTP(), externalCoupled::writeGeometry(), isoAdvection::writeIsoFaces(), SQPBase::writeMeritFunction(), faMeshReconstructor::writeMesh(), patchMeshWriter::writeNeighIDs(), collatedFileOperation::writeObject(), decomposedBlockData::writeObject(), patchMeshWriter::writePatchIDs(), patchMeshWriter::writePoints(), fileWriter::writeProcIDs(), surfaceNoise::writeSurfaceData(), foamWriter::writeTemplate(), starcdWriter::writeTemplate(), boundaryDataWriter::writeTemplate(), x3dWriter::writeTemplate(), debugWriter::writeTemplate(), vtkWriter::writeTemplate(), streamLineBase::writeToFile(), GCMMA::writeToFiles(), ensightWriter::writeUncollated(), NURBS3DSurface::writeVTK(), propellerInfo::writeWake(), AMIWeights::writeWeightField(), NURBS3DCurve::writeWParses(), and NURBS3DSurface::writeWParses().
|
inlinestatic |
True if process corresponds to any rank (master or sub-rank) in the given communicator.
Definition at line 1628 of file UPstream.H.
References UPstream::masterNo().
Referenced by UPstream::is_parallel(), globalIndex::splitNodeOffsets(), and UPstream::whichCommunication().
|
inlinestatic |
True if process corresponds to a sub-rank in the given communicator.
Definition at line 1636 of file UPstream.H.
References UPstream::masterNo().
Referenced by Foam::broadcastFile_recursive(), and Foam::broadcastFile_single().
|
inlinestatic |
True if parallel algorithm or exchange is required.
This is when parRun() == true, the process corresponds to a rank in the communicator and there is more than one rank in the communicator
Definition at line 1648 of file UPstream.H.
References UPstream::is_rank(), and UPstream::commsStruct::nProcs().
Referenced by globalIndex::calcOffset(), globalIndex::calcRange(), IOobjectList::checkNames(), Foam::reduce(), exprValueFieldTag::reduce(), Foam::sumReduce(), and globalMeshData::updateMesh().
|
inlinestaticnoexcept |
The number of shared/host nodes in the (const) world communicator.
Definition at line 1659 of file UPstream.H.
Referenced by fileOperation::getGlobalHostIORanks(), and UPstream::printNodeCommsControl().
|
inlinestatic |
The parent communicator.
Definition at line 1664 of file UPstream.H.
Referenced by UPstream::allocateCommunicator(), UPstream::baseProcNo(), UPstream::procNo(), and UPstream::communicator::reset().
|
inlinestatic |
The list of ranks within a given communicator.
Definition at line 1672 of file UPstream.H.
Referenced by UPstream::baseProcNo(), Foam::operator<<(), collatedFileOperation::processorsDir(), UPstream::procNo(), and globalIndex::splitNodeOffsets().
|
inlinestaticnoexcept |
All worlds.
Definition at line 1683 of file UPstream.H.
Referenced by mappedPatchBase::calcMapping(), mappedPatchBase::masterWorld(), argList::parse(), Foam::printDOT(), and mappedPatchBase::sameWorld().
|
inlinestaticnoexcept |
The indices into allWorlds for all processes.
Definition at line 1691 of file UPstream.H.
|
inlinestatic |
My worldID.
Definition at line 1699 of file UPstream.H.
References UPstream::commGlobal(), and UPstream::myProcNo().
Referenced by mappedPatchBase::calcMapping(), multiWorldConnections::createComms(), and mappedPatchBase::masterWorld().
|
inlinestatic |
My world.
Definition at line 1707 of file UPstream.H.
References UPstream::commGlobal(), and UPstream::myProcNo().
Referenced by multiWorldConnections::addConnectionById(), multiWorldConnections::addConnectionByName(), mappedPatchBase::calcMapping(), argList::parse(), mappedPatchBase::sameWorld(), and mappedPatchBase::sampleMesh().
Range of process indices for all processes.
Definition at line 1718 of file UPstream.H.
References UPstream::commsStruct::nProcs().
Referenced by refinementHistory::distribute(), Foam::getSelectedProcs(), viewFactor::initialise(), ParSortableList< Type >::sort(), energySpectrum::write(), and externalCoupled::writeGeometry().
Range of process indices for sub-processes.
Definition at line 1727 of file UPstream.H.
References UPstream::commsStruct::nProcs().
Referenced by lduPrimitiveMesh::gather(), LUscalarMatrix::LUscalarMatrix(), masterUncollatedFileOperation::NewIFstream(), argList::parse(), decomposedBlockData::readBlocks(), mapDistributeBase::schedule(), globalMeshData::sharedPoints(), syncTools::syncEdgeMap(), syncTools::syncPointMap(), patchMeshWriter::writeNeighIDs(), patchMeshWriter::writePatchIDs(), and patchMeshWriter::writePoints().
|
static |
Processor offsets corresponding to the inter-node communicator.
Definition at line 776 of file UPstream.C.
References Foam::BitOps::count(), UPstream::nProcs(), and List< T >::null().
Referenced by UPstream::localNode_parentProcs().
|
static |
The range (start/size) of the commLocalNode ranks in terms of the (const) world communicator processors.
Definition at line 817 of file UPstream.C.
References IntRange< IntType >::empty(), Foam::findLower(), UPstream::interNode_offsets(), UPstream::myProcNo(), and IntRange< IntType >::reset().
|
static |
Linear communication schedule (special case) for given communicator.
Definition at line 699 of file UPstream.C.
References UPstream::commsStructList::init().
Referenced by UPstream::whichCommunication().
|
static |
Tree communication schedule (standard case) for given communicator.
Definition at line 718 of file UPstream.C.
References UPstream::commsStructList::init().
Referenced by UPstream::whichCommunication().
|
inlinestatic |
Communication schedule for all-to-master (proc 0) as linear/tree/none with switching based on UPstream::nProcsSimpleSum, the is_parallel() state and the optional linear parameter.
| linear | optionally select linear schedule only |
Definition at line 1760 of file UPstream.H.
References UPstream::is_rank(), UPstream::linearCommunication(), UPstream::commsStruct::nProcs(), UPstream::nProcsSimpleSum, UPstream::commsStructList::null(), and UPstream::treeCommunication().
Referenced by UPstream::printCommTree().
|
inlinestaticnoexcept |
Message tag of standard messages.
Definition at line 1787 of file UPstream.H.
Referenced by solidAbsorption::a(), mappedPatchBase::calcMapping(), faceAreaWeightAMI::calculate(), AMIInterpolation::calculate(), advancingFrontAMI::checkPatches(), masterUncollatedFileOperation::chMod(), mappedPatchBase::collectSamples(), extendedCentredCellToFaceStencil::compact(), extendedCentredFaceToCellStencil::compact(), extendedCentredCellToCellStencil::compact(), GAMGAgglomeration::continueAgglomerating(), masterUncollatedFileOperation::cp(), masterUncollatedFileOperation::dirPath(), mappedPatchBase::distribute(), solidAbsorption::e(), masterUncollatedFileOperation::exists(), masterUncollatedFileOperation::filePath(), masterUncollatedFileOperation::fileSize(), distributedTriSurfaceMesh::findNearest(), mappedPatchBase::findSamples(), Foam::gAverage(), globalMeshData::geometricSharedPoints(), distributedTriSurfaceMesh::getVolumeType(), globalMeshData::globalEdgeNumbering(), globalMeshData::globalPointNumbering(), globalMeshData::globalTransforms(), Foam::gSumCmptProd(), Foam::gSumProd(), Foam::gWeightedAverage(), Foam::gWeightedSum(), masterUncollatedFileOperation::highResLastModified(), viewFactor::initialise(), regionModel::interRegionAMI(), masterUncollatedFileOperation::isDir(), masterUncollatedFileOperation::isFile(), masterUncollatedFileOperation::lastModified(), lduPrimitiveMesh::lduPrimitiveMesh(), masterUncollatedFileOperation::ln(), LUscalarMatrix::LUscalarMatrix(), surfaceWriter::mergeFieldTemplate(), globalMeshData::mergePoints(), masterUncollatedFileOperation::mkDir(), masterUncollatedFileOperation::mode(), masterUncollatedFileOperation::mv(), masterUncollatedFileOperation::mvBak(), masterUncollatedFileOperation::NewIFstream(), fileOperation::printRanks(), processorTopology::procAdjacency(), decomposedBlockData::readBlocks(), masterUncollatedFileOperation::readDir(), masterUncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readStream(), surfaceNoise::readSurfaceData(), lduMesh::reduce(), exprValueFieldTag::reduce(), fvMatrix< Type >::relax(), faMeshBoundaryHalo::reset(), mappedPatchBase::reverseDistribute(), masterUncollatedFileOperation::rm(), masterUncollatedFileOperation::rmDir(), mapDistributeBase::schedule(), globalMeshData::sharedPoints(), surfaceNoise::surfaceAverage(), syncTools::syncBoundaryFaceList(), syncTools::syncEdgeMap(), syncTools::syncFaceList(), syncTools::syncPointMap(), processorFvPatch::tag(), processorFaPatch::tag(), processorCyclicPolyPatch::tag(), processorPolyPatch::tag(), masterUncollatedFileOperation::type(), oversetFvMeshBase::updateAddressing(), wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), MarshakRadiationFvPatchScalarField::updateCoeffs(), filmPyrolysisTemperatureCoupledFvPatchScalarField::updateCoeffs(), filmPyrolysisVelocityCoupledFvPatchVectorField::updateCoeffs(), MarshakRadiationFixedTemperatureFvPatchScalarField::updateCoeffs(), greyDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), thermalBaffle1DFvPatchScalarField< solidType >::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), OFstreamCollator::write(), decomposedBlockData::writeBlocks(), and surfaceNoise::writeSurfaceData().
|
inlinestaticnoexcept |
Set the message tag for standard messages.
Definition at line 1797 of file UPstream.H.
|
inlinestaticnoexcept |
Increment the message tag for standard messages.
Definition at line 1809 of file UPstream.H.
Referenced by solidAbsorption::a(), faceAreaWeightAMI::calculate(), solidAbsorption::e(), globalMeshData::geometricSharedPoints(), globalMeshData::globalEdgeNumbering(), globalMeshData::globalPointNumbering(), globalMeshData::globalTransforms(), regionModel::interRegionAMI(), globalMeshData::mergePoints(), globalMeshData::sharedPoints(), syncTools::syncBoundaryFaceList(), syncTools::syncEdgeMap(), syncTools::syncFaceList(), syncTools::syncPointMap(), wideBandDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), mappedVelocityFluxFixedValueFvPatchField::updateCoeffs(), mappedFlowRateFvPatchVectorField::updateCoeffs(), MarshakRadiationFvPatchScalarField::updateCoeffs(), filmPyrolysisTemperatureCoupledFvPatchScalarField::updateCoeffs(), filmPyrolysisVelocityCoupledFvPatchVectorField::updateCoeffs(), MarshakRadiationFixedTemperatureFvPatchScalarField::updateCoeffs(), greyDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), thermalBaffle1DFvPatchScalarField< solidType >::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), and turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs().
|
inlinenoexcept |
Get the communications type of the stream.
Definition at line 1819 of file UPstream.H.
Referenced by OPstream::send(), and UIPstream::UIPstream().
|
inlinenoexcept |
Set the communications type of the stream.
Definition at line 1829 of file UPstream.H.
|
static |
Shutdown (finalize) MPI as required.
Uses MPI_Abort instead of MPI_Finalize if errNo is non-zero
Definition at line 57 of file UPstream.C.
Referenced by ParRunControl::~ParRunControl().
|
static |
Call MPI_Abort with no other checks or cleanup.
Definition at line 68 of file UPstream.C.
References Foam::abort().
Referenced by error::simpleExit().
|
static |
Shutdown (finalize) MPI as required and exit program with errNo.
Definition at line 61 of file UPstream.C.
References Foam::exit().
Referenced by argList::argList(), designVariablesUpdate::checkConvergence(), Foam::exitNow(), argList::parse(), ParRunControl::runPar(), and error::simpleExit().
|
static |
Exchange int32_t data with all ranks in communicator.
non-parallel : simple copy of sendData to recvData
| [in] | sendData | The value at [proci] is sent to proci |
| [out] | recvData | The data received from the other ranks |
Definition at line 42 of file UPstreamAllToAll.C.
Referenced by fvMeshDistribute::distribute().
|
static |
Exchange non-zero int32_t data between ranks [NBX].
recvData is always initially assigned zero and no non-zero
values are sent/received from other ranks.
non-parallel : simple copy of sendData to recvData
since the implementation uses probing with ANY_SOURCE !!
An initial barrier may help to avoid synchronisation problems
caused elsewhere (See "nbx.tuning" opt switch)
| [in] | sendData | The non-zero value at [proci] is sent to proci |
| [out] | recvData | The non-zero value received from each rank |
| tag | Message tag for the communication |
Definition at line 74 of file UPstreamAllToAll.C.
|
static |
Exchange int32_t data between ranks [NBX].
recvData map is always cleared initially so a simple check
of its keys is sufficient to determine connectivity.
non-parallel : copy own rank (if it exists)
See notes about message tags and "nbx.tuning" opt switch
| [in] | sendData | The value at [proci] is sent to proci. |
| [out] | recvData | The values received from given ranks. |
| tag | Message tag for the communication |
Definition at line 74 of file UPstreamAllToAll.C.
|
inlinestatic |
Exchange int32_t data between ranks [NBX].
| [in] | sendData | The value at [proci] is sent to proci. |
| tag | Message tag for the communication |
Definition at line 1920 of file UPstream.H.
|
static |
Exchange int64_t data with all ranks in communicator.
non-parallel : simple copy of sendData to recvData
| [in] | sendData | The value at [proci] is sent to proci |
| [out] | recvData | The data received from the other ranks |
Definition at line 43 of file UPstreamAllToAll.C.
|
static |
Exchange non-zero int64_t data between ranks [NBX].
recvData is always initially assigned zero and no non-zero
values are sent/received from other ranks.
non-parallel : simple copy of sendData to recvData
since the implementation uses probing with ANY_SOURCE !!
An initial barrier may help to avoid synchronisation problems
caused elsewhere (See "nbx.tuning" opt switch)
| [in] | sendData | The non-zero value at [proci] is sent to proci |
| [out] | recvData | The non-zero value received from each rank |
| tag | Message tag for the communication |
Definition at line 75 of file UPstreamAllToAll.C.
|
static |
Exchange int64_t data between ranks [NBX].
recvData map is always cleared initially so a simple check
of its keys is sufficient to determine connectivity.
non-parallel : copy own rank (if it exists)
See notes about message tags and "nbx.tuning" opt switch
| [in] | sendData | The value at [proci] is sent to proci. |
| [out] | recvData | The values received from given ranks. |
| tag | Message tag for the communication |
Definition at line 75 of file UPstreamAllToAll.C.
|
inlinestatic |
Exchange int64_t data between ranks [NBX].
| [in] | sendData | The value at [proci] is sent to proci. |
| tag | Message tag for the communication |
Definition at line 1921 of file UPstream.H.
|
static |
Receive identically-sized (contiguous) data from all ranks.
| sendData | All ranks: location of individual value to send |
| recvData | Master: receive buffer with all values. Other ranks: ignored |
| count | Number of send/recv data per rank. Globally consistent! |
Referenced by profilingPstream::report().
|
static |
Send identically-sized (contiguous) data to all ranks.
| sendData | Master: send buffer with all values. Other ranks: ignored |
| recvData | All ranks: location to receive individual value |
| count | Number of send/recv data per rank. Globally consistent! |
|
static |
Gather/scatter identically-sized data.
Send data from proc slot, receive into all slots
| allData | All ranks: the base of the data locations |
| count | Number of send/recv data per rank. Globally consistent! |
Referenced by fileOperation::getGlobalHostIORanks(), and globalMeshData::updateMesh().
|
static |
Receive variable length data from all ranks.
| sendCount | Ignored on master if recvCount[0] == 0 |
| recvData | Ignored on non-root rank |
| recvCounts | Ignored on non-root rank |
| recvOffsets | Ignored on non-root rank |
Referenced by decomposedBlockData::gather(), UPstream::gather(), and decomposedBlockData::gatherSlaveData().
|
static |
Send variable length data to all ranks.
| sendData | Ignored on non-root rank |
| sendCounts | Ignored on non-root rank |
| sendOffsets | Ignored on non-root rank |
Referenced by UPstream::scatter().
|
static |
Allgather individual values into list locations.
The returned list has size nProcs, identical on all ranks.
Referenced by globalIndex::calcOffset(), globalIndex::calcRange(), and globalIndex::reset().
|
static |
Gather individual values into list locations.
On master list length == nProcs, otherwise zero length.
For non-parallel : the returned list length is 1 with localValue.
Referenced by triangulatedPatch::randomGlobalPoint(), and globalIndex::reset().
|
static |
Scatter individual values from list locations.
On master input list length == nProcs, ignored on other procs.
For non-parallel : returns the first list element (or default initialized).
|
inlinestatic |
Broadcast buffer contents (contiguous types), from rank=0 to all ranks. The sizes must match on all processes.
For non-parallel : do nothing.
Referenced by Foam::broadcastFile_recursive(), Foam::broadcastFile_single(), and globalIndex::splitNodeOffsets().
|
static |
MPI_Reduce (blocking) for known operators.
For non-parallel : do nothing.
|
static |
MPI_Allreduce (blocking) for known operators.
For non-parallel : do nothing.
Referenced by Foam::reduce(), and Foam::sumReduce().
|
static |
MPI_Iallreduce (non-blocking) for known operators.
For non-parallel : do nothing.
|
static |
Logical (and) reduction (MPI_AllReduce)
For non-parallel : do nothing
Definition at line 28 of file UPstreamReduce.C.
Referenced by faMeshReconstructor::faMeshReconstructor(), displacementPointSmoothingMotionSolver::relax(), displacementSmartPointSmoothingMotionSolver::relax(), Foam::returnReduceAnd(), and mappedPatchBase::upToDate().
|
static |
Logical (or) reduction (MPI_AllReduce)
For non-parallel : do nothing
Definition at line 31 of file UPstreamReduce.C.
Referenced by polyBoundaryMesh::checkDefinition(), NURBS3DVolume::confineInertControlPoints(), snappyLayerDriver::doLayers(), PstreamBuffers::finishedSends(), nullSpace::nullSpace(), masterUncollatedFileOperation::readStream(), and Foam::returnReduceOr().
|
inlinestatic |
Create new communicator with sub-ranks on the parent communicator.
Definition at line 2146 of file UPstream.H.
References UPstream::newCommunicator(), and UPstream::parent().
|
inlinestatic |
Create new communicator with sub-ranks on the parent communicator.
Definition at line 2161 of file UPstream.H.
References UPstream::newCommunicator(), and UPstream::parent().
|
inlinestaticnoexcept |
Communicator between nodes (respects any local worlds)
Definition at line 2174 of file UPstream.H.
References UPstream::commInterNode().
|
inlinestaticnoexcept |
Communicator within the node (respects any local worlds)
Definition at line 2180 of file UPstream.H.
References UPstream::commLocalNode().
|
inlinestatic |
Wait for all requests to finish.
Definition at line 2189 of file UPstream.H.
References UPstream::waitRequests().
Referenced by faceAreaPairGAMGAgglomeration::movePoints(), syncTools::syncBoundaryFaceList(), syncTools::syncFaceList(), UPstream::waitRequests(), and OFstreamCollator::write().
|
inlinestatic |
Definition at line 2197 of file UPstream.H.
References Foam::BitOps::count(), and UPstream::mpiGatherv().
|
inlinestatic |
Definition at line 2215 of file UPstream.H.
References Foam::BitOps::count(), and UPstream::mpiScatterv().
|
static |
Enumerated names for the communication types.
Definition at line 89 of file UPstream.H.
Referenced by debugWriter::debugWriter(), PstreamBuffers::finishedGathers(), PstreamBuffers::finishedScatters(), PstreamBuffers::finishedSends(), argList::parse(), surfaceNoise::read(), decomposedBlockData::readBlocks(), surfaceWriter::surfaceWriter(), and decomposedBlockData::writeBlocks().
|
static |
Use of host/node topology-aware routines.
0: disabled 1: split by hostname [default] 2: split by shared >=4: (debug) split with given number per node
Definition at line 913 of file UPstream.H.
Referenced by UPstream::printNodeCommsControl().
|
static |
Minimum number of nodes before topology-aware routines are enabled.
<= 2 : always >= 3 : when there are more than N nodes
Definition at line 921 of file UPstream.H.
Referenced by UPstream::printNodeCommsControl().
|
static |
Selection of topology-aware routines as a bitmask combination of the topoControls enumerations.
Definition at line 927 of file UPstream.H.
Referenced by UPstream::printTopoControl(), and UPstream::usingTopoControl().
|
static |
Should compact transfer be used in which floats replace doubles reducing the bandwidth requirement at the expense of some loss in accuracy.
Definition at line 942 of file UPstream.H.
Referenced by processorGAMGInterfaceField::initInterfaceMatrixUpdate(), argList::parse(), and processorGAMGInterfaceField::updateInterfaceMatrix().
|
static |
Number of processors to change from linear to tree communication.
Definition at line 947 of file UPstream.H.
Referenced by argList::parse(), and UPstream::whichCommunication().
|
static |
Number of processors to change to nonBlocking consensual exchange (NBX). Ignored for zero or negative values.
Definition at line 953 of file UPstream.H.
Referenced by argList::parse().
|
static |
Number of polling cycles in processor updates.
Definition at line 958 of file UPstream.H.
Referenced by argList::parse().
|
static |
Default commsType.
Definition at line 963 of file UPstream.H.
Referenced by faBoundaryMesh::calcGeometry(), mapDistribute::distribute(), mappedPatchBase::distribute(), Foam::evaluateConstraintTypes(), pointBoundaryMesh::movePoints(), faBoundaryMesh::movePoints(), polyBoundaryMesh::movePoints(), argList::parse(), mapDistribute::reverseDistribute(), mappedPatchBase::reverseDistribute(), syncTools::syncBoundaryFaceList(), pointBoundaryMesh::updateMesh(), faBoundaryMesh::updateMesh(), and polyBoundaryMesh::updateMesh().
|
static |
Optional maximum message size (bytes)
Definition at line 968 of file UPstream.H.
Referenced by Foam::broadcastFile_single(), and argList::parse().
|
static |
Tuning parameters for non-blocking exchange (NBX)
Definition at line 973 of file UPstream.H.
Referenced by argList::parse().
|
static |
MPI buffer-size (bytes)
Definition at line 978 of file UPstream.H.
Referenced by attachOurBuffers().
|
static |
Communicator for all ranks. May differ from commGlobal() if local worlds are in use.
Definition at line 987 of file UPstream.H.
Referenced by regIOobject::addWatch(), masterUncollatedFileOperation::addWatch(), Foam::calcCellCellsImpl(), surfaceNoise::calculate(), multiWorldConnections::comms(), UPstream::commWorld(), masterUncollatedFileOperation::dirPath(), ensightSurfaceReader::ensightSurfaceReader(), masterUncollatedFileOperation::filePath(), masterUncollatedFileOperation::findInstance(), masterUncollatedFileOperation::findTimes(), masterUncollatedFileOperation::findWatch(), ensightSurfaceReader::geometry(), multiWorldConnections::getCommById(), multiWorldConnections::getCommByName(), Foam::getCommPattern(), masterUncollatedFileOperation::getFile(), fileOperation::getGlobalHostIORanks(), Foam::getSelectedProcs(), masterUncollatedFileOperation::getState(), masterUncollatedFileOperation::highResLastModified(), surfaceNoise::initialise(), viewFactor::initialise(), globalIndex::inplaceToGlobal(), globalIndex::isLocal(), masterUncollatedFileOperation::lastModified(), globalIndex::localEnd(), globalIndex::localSize(), globalIndex::localStart(), fileOperation::lookupAndCacheProcessorsPath(), messageStream::masterStream(), globalIndex::maxNonLocalSize(), surfaceWriter::mergeFieldTemplate(), faMeshTools::newMesh(), fvMeshTools::newMesh(), argList::parse(), UPstream::printNodeCommsControl(), fileOperation::printRanks(), globalIndex::range(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), decomposedBlockData::readBlocks(), lumpedPointState::readData(), masterUncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readObjects(), masterUncollatedFileOperation::readStream(), surfaceNoise::readSurfaceData(), exprValueFieldTag::reduce(), masterUncollatedFileOperation::removeWatch(), Time::setMonitoring(), masterUncollatedFileOperation::setUnmodified(), messageStream::stream(), fileOperation::subRanks(), surfaceNoise::surfaceAverage(), masterUncollatedFileOperation::sync(), fileOperation::sync(), globalIndex::toGlobal(), globalIndex::toLocal(), masterUncollatedFileOperation::updateStates(), globalIndex::whichProcID(), and surfaceNoise::writeSurfaceData().
|
static |
Debugging: warn for use of any communicator differing from warnComm.
Definition at line 992 of file UPstream.H.
Referenced by UPstream::commWarn(), messageStream::masterStream(), Foam::reduce(), and Foam::PstreamGlobals::warnCommunicator().
1.8.14