UPstream Class Reference

Inter-processor communications stream. More...

Inheritance diagram for UPstream:
Collaboration diagram for UPstream:

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  File
 An opaque wrapper for MPI_File methods without any <mpi.h> header dependency. 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 (label communicator) noexcept
 Set world communicator. Negative values are a no-op. More...
 
static label commWarn (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=UPstream::worldComm)
 A standard or non-blocking probe for an incoming message. More...
 
static std::pair< int, int64_t > probeMessage (const int fromProcNo, const int tag=UPstream::msgType(), const int communicator=UPstream::worldComm)
 A standard probe for an incoming message. More...
 
static void probeMessages (DynamicList< int64_t > &messageSizes, const UList< int > &fromProcs, const int tag=UPstream::msgType(), const int communicator=UPstream::worldComm)
 Probe incoming message sizes from specified ranks. 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 (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 (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 (label pos, label len=-1)
 Wait until any request (from position onwards) has finished. Corresponds to MPI_Waitany() More...
 
static bool waitSomeRequests (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 (label pos, DynamicList< int > &indices)
 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 int 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 activeRequest (const label i)
 Is request i active (!= MPI_REQUEST_NULL)? More...
 
static bool activeRequest (const UPstream::Request &req)
 Is request active (!= MPI_REQUEST_NULL)? 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 (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 (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 (label communicator=worldComm)
 Number of ranks in parallel run (for given communicator). It is 1 for serial run. More...
 
static int myProcNo (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 (label communicator=worldComm)
 True if process corresponds to the master rank in the communicator. More...
 
static bool is_rank (label communicator=worldComm)
 True if process corresponds to any rank (master or sub-rank) in the given communicator. More...
 
static bool is_subrank (label communicator=worldComm)
 True if process corresponds to a sub-rank in the given communicator. More...
 
static bool is_parallel (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 bool sameProcs (int communicator1, int communicator2)
 Test for communicator equality. More...
 
template<typename T1 , typename = std::void_t <std::enable_if_t<std::is_integral_v<T1>>>>
static bool sameProcs (int communicator, const UList< T1 > &procs)
 Test equality of communicator procs with the given list of ranks. Includes a guard for the communicator index. More...
 
template<typename T1 , typename T2 , typename = std::void_t < std::enable_if_t<std::is_integral_v<T1>>, std::enable_if_t<std::is_integral_v<T2>> >>
static bool sameProcs (const UList< T1 > &procs1, const UList< T2 > &procs2)
 Test the equality of two lists of ranks. More...
 
static const wordListallWorlds () noexcept
 All worlds. More...
 
static const labelListworldIDs () noexcept
 The indices into allWorlds for all processes. More...
 
static label myWorldID ()
 My worldID. More...
 
static const wordmyWorld ()
 My world. More...
 
static rangeType allProcs (label communicator=worldComm)
 Range of process indices for all processes. More...
 
static rangeType subProcs (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 rangeTypelocalNode_parentProcs ()
 The range (start/size) of the commLocalNode ranks in terms of the (const) world communicator processors. More...
 
static const commsStructListlinearCommunication (int communicator)
 Linear communication schedule (special case) for given communicator. More...
 
static const commsStructListtreeCommunication (int communicator)
 Tree communication schedule (standard case) for given communicator. More...
 
static const commsStructListwhichCommunication (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< TallGatherValues (const T &localValue, const int communicator=UPstream::worldComm)
 Allgather individual values into list locations. More...
 
template<class T >
static List< TlistGatherValues (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, const int root=UPstream::masterNo())
 Broadcast buffer contents (contiguous types) to all ranks (default: from rank=0). The sizes must match on all processes. More...
 
template<class Type , unsigned N>
static bool broadcast (FixedList< Type, N > &list, const int communicator, const int root=UPstream::masterNo())
 Broadcast fixed-list content (contiguous types) to all ranks (default: from rank=0). 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=UPstream::worldComm)
 MPI_Reduce (blocking) for known operators. More...
 
template<UPstream::opCodes opCode, class T >
static void mpiReduce (T values[], int count, const int communicator=UPstream::worldComm)
 MPI_Reduce (blocking) for known operators. More...
 
template<class T >
static void mpiAllReduce (T values[], int count, const UPstream::opCodes opCodeId, const int communicator=UPstream::worldComm)
 MPI_Allreduce (blocking) for known operators. More...
 
template<UPstream::opCodes opCode, class T >
static void mpiAllReduce (T values[], int count, const int communicator=UPstream::worldComm)
 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...
 
template<UPstream::opCodes opCode, class T >
static void mpiAllReduce (T values[], int count, const int communicator, UPstream::Request &req)
 MPI_Iallreduce (non-blocking) for known operators. More...
 
template<class T >
static void mpiReduce_min (T values[], int count, const int communicator=UPstream::worldComm)
 MPI Reduce min. More...
 
template<class T >
static void mpiAllReduce_min (T values[], int count, const int communicator=UPstream::worldComm)
 MPI Allreduce min. More...
 
template<class T >
static void mpiReduce_max (T values[], int count, const int communicator=UPstream::worldComm)
 MPI Reduce max. More...
 
template<class T >
static void mpiAllReduce_max (T values[], int count, const int communicator=UPstream::worldComm)
 MPI Allreduce max. More...
 
template<class T >
static void mpiReduce_sum (T values[], int count, const int communicator=UPstream::worldComm)
 MPI Reduce sum. More...
 
template<class T >
static void mpiAllReduce_sum (T values[], int count, const int communicator=UPstream::worldComm)
 MPI Allreduce sum. More...
 
template<Foam::UPstream::opCodes opCode, class T >
static void mpiScan (T values[], int count, const int communicator, const bool exclusive=false)
 Inclusive/exclusive scan (in-place). More...
 
template<Foam::UPstream::opCodes opCode, class T >
static T mpiScan (const T &localValue, const int communicator, const bool exclusive=false)
 Inclusive/exclusive scan returning the result. In exclusive mode, the degenerate value on rank=0 has no meaning but is treated like non-exclusive mode (ie, original values) More...
 
template<class T >
static void mpiScan_min (T values[], int count, const int communicator, const bool exclusive=false)
 Inclusive/exclusive min scan (in-place) More...
 
template<class T >
static void mpiExscan_min (T values[], int count, const int communicator)
 Exclusive min scan (in-place) More...
 
template<class T >
static T mpiScan_min (const T &value, const int communicator, const bool exclusive=false)
 Inclusive/exclusive min scan returning result. More...
 
template<class T >
static T mpiExscan_min (const T &value, const int communicator)
 Exclusive min scan returning result. More...
 
template<class T >
static void mpiScan_max (T values[], int count, const int communicator, const bool exclusive=false)
 Inclusive/exclusive max scan (in-place) More...
 
template<class T >
static void mpiExscan_max (T values[], int count, const int communicator)
 Exclusive max scan (in-place) More...
 
template<class T >
static T mpiScan_max (const T &value, const int communicator, const bool exclusive=false)
 Inclusive/exclusive max scan returning result. More...
 
template<class T >
static T mpiExscan_max (const T &value, const int communicator)
 Exclusive max scan returning result. More...
 
template<class T >
static void mpiScan_sum (T values[], int count, const int communicator, const bool exclusive=false)
 Inclusive/exclusive sum scan (in-place) More...
 
template<class T >
static void mpiExscan_sum (T values[], int count, const int communicator)
 Exclusive sum scan (in-place) More...
 
template<class T >
static T mpiScan_sum (const T &value, const int communicator, const bool exclusive=false)
 Inclusive/exclusive sum scan returning result. More...
 
template<class T >
static T mpiExscan_sum (const T &value, const int communicator)
 Exclusive sum scan returning result. More...
 
static void reduceAnd (bool &value, const int communicator=UPstream::worldComm)
 Logical (and) reduction (MPI_AllReduce) More...
 
static void reduceOr (bool &value, const int communicator=UPstream::worldComm)
 Logical (or) reduction (MPI_AllReduce) More...
 
static int find_first (bool condition, int communicator)
 Locate the first rank for which the condition is true, or -1 if no ranks satisfy the condition. More...
 
static int find_last (bool condition, int communicator)
 Locate the last rank for which the condition is true, or -1 if no ranks satisfy the condition. More...
 
static label allocateCommunicator (const label parent, const labelRange &subRanks, const bool withComponents=true)
 
static label allocateCommunicator (const label parent, const labelUList &subRanks, const bool withComponents=true)
 
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< commsTypescommsTypeNames
 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, int root=0)
 Broadcast buffer contents to all ranks (default: from rank=0). 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 void mpi_scan_reduce (void *values, int count, const UPstream::dataTypes dataTypeId, const UPstream::opCodes opCodeId, const int communicator, const bool exclusive)
 In-place scan/exscan reduction of values. 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...
 

Detailed Description

Inter-processor communications stream.

Source files

Definition at line 69 of file UPstream.H.

Member Typedef Documentation

◆ rangeType

typedef IntRange<int> rangeType

Int ranges are used for MPI ranks (processes)

Definition at line 76 of file UPstream.H.

Member Enumeration Documentation

◆ commsTypes

enum commsTypes : char
strong

Communications types.

Enumerator
buffered 

"buffered" : (MPI_Bsend, MPI_Recv)

scheduled 

"scheduled" (MPI standard) : (MPI_Send, MPI_Recv)

nonBlocking 

"nonBlocking" (immediate) : (MPI_Isend, MPI_Irecv)

blocking 

compatibility name for buffered

Definition at line 81 of file UPstream.H.

◆ sendModes

enum sendModes : char
strong

Different MPI-send modes (ignored for commsTypes::buffered)

Enumerator
normal 

(MPI_Send, MPI_Isend)

sync 

(MPI_Ssend, MPI_Issend)

Definition at line 98 of file UPstream.H.

◆ dataTypes

enum dataTypes : char
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 107 of file UPstream.H.

◆ opCodes

enum opCodes : char
strong

Mapping of some MPI op codes.

Currently excluding min/max location until they are needed

Enumerator
Basic_begin 

(internal use) begin marker [reduce/window types]

op_min 

min(x,y)

op_max 

max(x,y)

op_sum 

(x + y)

op_prod 

(x * y)

op_bool_and 

Logical and.

op_bool_or 

Logical or.

op_bool_xor 

Logical xor.

op_bit_and 

Bit-wise and for (unsigned) integral types.

op_bit_or 

Bit-wise or for (unsigned) integral types.

op_bit_xor 

Bit-wise xor for (unsigned) integral types.

Basic_end 

(internal use) end marker [reduce types]

Extra_begin 

(internal use) begin marker [window types]

op_replace 

Replace (window only)

op_no_op 

No-op (window only)

invalid 

invalid op (NULL)

Extra_end 

(internal use) end marker [window types]

OpCodes_end 

(internal use) end marker [all types]

Definition at line 149 of file UPstream.H.

◆ topoControls

enum topoControls : int
strong

Some bit masks corresponding to topology controls.

These selectively enable topology-aware handling

Enumerator
broadcast 

broadcast [MPI]

reduce 

reduce/all-reduce [MPI]

gather 

gather/all-gather [MPI]

combine 

combine/gather (reduction) [manual algorithm]

mapGather 

mapGather (reduction) [manual algorithm]

gatherList 

gatherList [manual algorithm]

Definition at line 188 of file UPstream.H.

Constructor & Destructor Documentation

◆ UPstream()

UPstream ( const commsTypes  commsType)
inlineexplicitnoexcept

Construct for given communication type.

Definition at line 1209 of file UPstream.H.

Member Function Documentation

◆ mpi_broadcast()

bool mpi_broadcast ( void *  buf,
std::streamsize  count,
const UPstream::dataTypes  dataTypeId,
const int  communicator,
int  root = 0 
)
staticprotected

Broadcast buffer contents to all ranks (default: from rank=0). The sizes must match on all processes.

For non-parallel : do nothing.

Note
The method uses a 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.
Returns
True on success
Parameters
rootThe broadcast root (0 == master, -1 = last rank)

Definition at line 26 of file UPstreamBroadcast.C.

◆ mpi_reduce()

void mpi_reduce ( void *  values,
int  count,
const UPstream::dataTypes  dataTypeId,
const UPstream::opCodes  opCodeId,
const int  communicator,
UPstream::Request req = nullptr 
)
staticprotected

In-place reduction of values with result on rank 0.

Includes internal parallel guard and checks on data types, opcode.

Note
The method uses a 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.
Parameters
[out]reqrequest information (for non-blocking)

Definition at line 38 of file UPstreamReduce.C.

◆ mpi_allreduce()

void mpi_allreduce ( void *  values,
int  count,
const UPstream::dataTypes  dataTypeId,
const UPstream::opCodes  opCodeId,
const int  communicator,
UPstream::Request req = nullptr 
)
staticprotected

In-place reduction of values with same result on all ranks.

Includes internal parallel guard and checks on data types, opcode.

Note
The method uses a 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.
Parameters
[out]reqrequest information (for non-blocking)

Definition at line 50 of file UPstreamReduce.C.

Referenced by UPstream::find_first(), and UPstream::find_last().

Here is the caller graph for this function:

◆ mpi_scan_reduce()

void mpi_scan_reduce ( void *  values,
int  count,
const UPstream::dataTypes  dataTypeId,
const UPstream::opCodes  opCodeId,
const int  communicator,
const bool  exclusive 
)
staticprotected

In-place scan/exscan reduction of values.

Includes internal parallel guard and checks on data types, opcode.

Note
The method uses a 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.
Parameters
exclusiveUse exclusive scan

Definition at line 62 of file UPstreamReduce.C.

◆ mpi_send()

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 
)
staticprotected

Send buffer contents of specified data type to given processor.

Note
The method uses a 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.
Returns
True on success (or Fatal)
Parameters
[out]reqrequest information (for non-blocking)
sendModeoptional send mode (normal | sync)

Definition at line 36 of file UOPstreamWrite.C.

References NotImplemented.

◆ mpi_receive()

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 
)
staticprotected

Receive buffer contents of specified data type from given processor.

Note
The method uses a 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.
Returns
number of elements read. May change in the future
Parameters
[out]reqrequest information (for non-blocking)

Definition at line 27 of file UIPstreamRead.C.

References NotImplemented.

◆ mpi_gather()

void mpi_gather ( const void *  sendData,
void *  recvData,
int  count,
const UPstream::dataTypes  dataTypeId,
const int  communicator,
UPstream::Request req = nullptr 
)
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.

Parameters
sendDataAll ranks: location of individual value to send
recvDataMaster: receive buffer with all values. Other ranks: ignored
countNumber of send/recv data per rank. Globally consistent!
[out]reqrequest information (for non-blocking)

Definition at line 26 of file UPstreamGatherScatter.C.

◆ mpi_scatter()

void mpi_scatter ( const void *  sendData,
void *  recvData,
int  count,
const UPstream::dataTypes  dataTypeId,
const int  communicator,
UPstream::Request req = nullptr 
)
staticprotected

Send identically-sized (contiguous) data from rank 0 to all other ranks.

Includes internal parallel guard.

Parameters
sendDataMaster: send buffer with all values. Other ranks: ignored
recvDataAll ranks: location to receive individual value
countNumber of send/recv data per rank. Globally consistent!
[out]reqrequest information (for non-blocking)

Definition at line 39 of file UPstreamGatherScatter.C.

◆ mpi_allgather()

void mpi_allgather ( void *  allData,
int  count,
const UPstream::dataTypes  dataTypeId,
const int  communicator,
UPstream::Request req = nullptr 
)
staticprotected

Gather/scatter identically-sized data.

Send data from proc slot, receive into all slots

Parameters
allDataAll ranks: the base of the data locations
countNumber of send/recv data per rank. Globally consistent!
[out]reqrequest information (for non-blocking)

Definition at line 52 of file UPstreamGatherScatter.C.

◆ mpi_gatherv()

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 
)
staticprotected

Receive variable length data from all ranks, placing the result on rank 0. (caution: known to scale poorly)

Parameters
sendCountIgnored on master if recvCount[0] == 0
recvDataIgnored on non-root rank
recvCountsIgnored on non-root rank
recvOffsetsIgnored on non-root rank

Definition at line 66 of file UPstreamGatherScatter.C.

◆ mpi_scatterv()

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 
)
staticprotected

Send variable length data from rank 0 to all ranks. (caution: known to scale poorly)

Parameters
sendDataIgnored on non-root rank
sendCountsIgnored on non-root rank
sendOffsetsIgnored on non-root rank

Definition at line 80 of file UPstreamGatherScatter.C.

◆ ClassName()

ClassName ( "UPstream"  )

Declare name of the class and its debug switch.

◆ usingTopoControl()

static bool usingTopoControl ( UPstream::topoControls  ctrl)
inlinestaticnoexcept

Test for selection of given topology-aware routine.

Definition at line 1039 of file UPstream.H.

References UPstream::topologyControl_.

◆ commGlobal()

static constexpr int commGlobal ( )
inlinestaticnoexcept

Communicator for all ranks, irrespective of any local worlds.

This value never changes during a simulation.

Definition at line 1106 of file UPstream.H.

Referenced by multiWorldConnections::createComms(), fileOperation::getManagedComm(), UPstream::myWorld(), UPstream::myWorldID(), and syncObjects::sync().

Here is the caller graph for this function:

◆ commSelf()

static constexpr int commSelf ( )
inlinestaticnoexcept

Communicator within the current rank only.

This value never changes during a simulation.

Definition at line 1113 of file UPstream.H.

Referenced by Foam::getCommPattern(), and fileOperation::getManagedComm().

Here is the caller graph for this function:

◆ commConstWorld()

static int commConstWorld ( )
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 1121 of file UPstream.H.

◆ commWorld() [1/2]

static label commWorld ( )
inlinestaticnoexcept

◆ commWorld() [2/2]

static label commWorld ( label  communicator)
inlinestaticnoexcept

Set world communicator. Negative values are a no-op.

Returns
old world communicator index

Definition at line 1133 of file UPstream.H.

References UPstream::worldComm.

◆ commWarn()

static label commWarn ( label  communicator)
inlinestaticnoexcept

Alter communicator debugging setting. Warns for use of any communicator differing from specified. Negative values disable.

Returns
the previous warn index

Definition at line 1147 of file UPstream.H.

References UPstream::warnComm.

Referenced by mappedPatchBase::calcAMI(), mappedPatchBase::collectSamples(), multiWorldConnections::createComms(), mappedPatchBase::distribute(), mappedPatchBase::findSamples(), cyclicACMIGAMGInterfaceField::initInterfaceMatrixUpdate(), cyclicAMIGAMGInterfaceField::initInterfaceMatrixUpdate(), mappedPatchBase::reverseDistribute(), syncObjects::sync(), and globalMeshData::updateMesh().

Here is the caller graph for this function:

◆ nComms()

static label nComms ( )
inlinestaticnoexcept

Number of currently defined communicators.

Definition at line 1157 of file UPstream.H.

References UList< T >::size().

Here is the call graph for this function:

◆ printCommTree()

void printCommTree ( int  communicator,
bool  linear = false 
)
static

Debugging: print the communication tree.

Definition at line 737 of file UPstream.C.

References Foam::Info, UPstream::master(), and UPstream::whichCommunication().

Here is the call graph for this function:

◆ commInterNode()

static int commInterNode ( )
inlinestaticnoexcept

Communicator between nodes/hosts (respects any local worlds)

Definition at line 1170 of file UPstream.H.

Referenced by error::list_mem_hwm(), and error::Pout_mem_hwm().

Here is the caller graph for this function:

◆ commLocalNode()

static int commLocalNode ( )
inlinestaticnoexcept

Communicator within the node/host (respects any local worlds)

Definition at line 1178 of file UPstream.H.

Referenced by error::list_mem_hwm(), error::Pout_mem_hwm(), and distributedTriSurfaceMesh::~distributedTriSurfaceMesh().

Here is the caller graph for this function:

◆ hasNodeCommunicators()

static bool hasNodeCommunicators ( )
inlinestaticnoexcept

Both inter-node and local-node communicators have been created.

Definition at line 1186 of file UPstream.H.

◆ usingNodeComms()

bool usingNodeComms ( const int  communicator)
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().

Here is the caller graph for this function:

◆ newCommunicator() [1/2]

Foam::label newCommunicator ( const label  parent,
const labelRange subRanks,
const bool  withComponents = true 
)
static

Create new communicator with sub-ranks on the parent communicator.

Parameters
parentThe parent communicator
subRanksThe contiguous sub-ranks of parent to use
withComponentsCall 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(), masterCoarsestGAMGProcAgglomeration::agglomerate(), UPstream::allocateCommunicator(), Foam::getCommPattern(), and UPstream::communicator::reset().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ newCommunicator() [2/2]

Foam::label newCommunicator ( const label  parent,
const labelUList subRanks,
const bool  withComponents = true 
)
static

Create new communicator with sub-ranks on the parent communicator.

Parameters
parentThe parent communicator
subRanksThe sub-ranks of parent to use (ignore negative values)
withComponentsCall 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().

Here is the call graph for this function:

◆ dupCommunicator()

Foam::label dupCommunicator ( const label  parent)
static

Duplicate the parent communicator.

Always calls dupCommunicatorComponents() internally

Parameters
parentThe 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().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ splitCommunicator()

Foam::label splitCommunicator ( const label  parent,
const int  colour,
const bool  two_step = true 
)
static

Allocate a new communicator by splitting the parent communicator on the given colour.

Always calls splitCommunicatorComponents() internally

Parameters
parentThe parent communicator
colourThe colouring to select which ranks to include. Negative values correspond to 'ignore'
two_stepUse 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().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ freeCommunicator()

void freeCommunicator ( const label  communicator,
const bool  withComponents = true 
)
static

◆ baseProcNo()

int baseProcNo ( label  comm,
int  procID 
)
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().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ procNo() [1/2]

Foam::label procNo ( const label  comm,
const int  baseProcID 
)
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().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ procNo() [2/2]

Foam::label procNo ( const label  comm,
const label  currentComm,
const int  currentProcID 
)
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().

Here is the call graph for this function:

◆ addValidParOptions()

void addValidParOptions ( HashTable< string > &  validParOptions)
static

Add the valid option this type of communications library adds/requires on the command line.

Definition at line 27 of file UPstream.C.

◆ init()

bool init ( int &  argc,
char **&  argv,
const bool  needsThread 
)
static

Initialisation function called from main.

Spawns sub-processes and initialises inter-communication

Definition at line 41 of file UPstream.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, and FatalErrorInFunction.

Referenced by UPstream::commsStructList::init(), and ParRunControl::runPar().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ initNull()

bool initNull ( )
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.

Note
Behaves as a no-op if MPI has already been initialized. Fatal if MPI has already been finalized.

Definition at line 31 of file UPstream.C.

References Foam::endl(), and WarningInFunction.

Referenced by zoltanRenumber::renumber().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ barrier()

void barrier ( const int  communicator,
UPstream::Request req = nullptr 
)
static

Impose a synchronisation barrier (optionally non-blocking)

Definition at line 107 of file UPstream.C.

◆ send_done()

void send_done ( const int  toProcNo,
const int  communicator,
const int  tag = UPstream::msgType()+1970 
)
static

Impose a point-to-point synchronisation barrier by sending a zero-byte "done" message to given rank.

A no-op for non-parallel

Parameters
toProcNoThe destination rank
communicatorThe communicator index (eg, UPstream::worldComm)
tagMessage tag (must match on receiving side)

Definition at line 112 of file UPstream.C.

◆ wait_done()

int wait_done ( const int  fromProcNo,
const int  communicator,
const int  tag = UPstream::msgType()+1970 
)
static

Impose a point-to-point synchronisation barrier by receiving a zero-byte "done" message from given rank.

A no-op for non-parallel

Returns
the source rank (useful for ANY_SOURCE messages) or -1 for non-parallel
Parameters
fromProcNoThe source rank (negative == ANY_SOURCE)
communicatorThe communicator index (eg, UPstream::worldComm)
tagMessage tag (must match on sending side)

Definition at line 121 of file UPstream.C.

◆ probeMessage() [1/2]

std::pair< int, int64_t > probeMessage ( const UPstream::commsTypes  commsType,
const int  fromProcNo,
const int  tag = UPstream::msgType(),
const int  communicator = UPstream::worldComm 
)
static

A standard or non-blocking probe for an incoming message.

Returns
source rank and message size (bytes) and (-1, 0) on failure
Parameters
commsTypeNon-blocking or otherwise
fromProcNoThe source rank (negative == ANY_SOURCE)
tagThe source message tag
communicatorThe communicator index

Definition at line 133 of file UPstream.C.

Referenced by UPstream::probeMessage(), and decomposedBlockData::readBlocks().

Here is the caller graph for this function:

◆ probeMessage() [2/2]

static std::pair<int,int64_t> probeMessage ( const int  fromProcNo,
const int  tag = UPstream::msgType(),
const int  communicator = UPstream::worldComm 
)
inlinestatic

A standard probe for an incoming message.

Returns
source rank and message size (bytes) and (-1, 0) on failure
Parameters
fromProcNoThe source rank (negative == ANY_SOURCE)
tagThe source message tag
communicatorThe communicator index

Definition at line 1412 of file UPstream.H.

References UPstream::probeMessage(), and UPstream::scheduled.

Here is the call graph for this function:

◆ probeMessages()

void probeMessages ( DynamicList< int64_t > &  messageSizes,
const UList< int > &  fromProcs,
const int  tag = UPstream::msgType(),
const int  communicator = UPstream::worldComm 
)
static

Probe incoming message sizes from specified ranks.

Parameters
[out]messageSizesMessage sizes (bytes)
fromProcsThe source ranks (must be non-negative)
tagThe source message tag: assumed to be identical for all sources
communicatorThe communicator index

Definition at line 145 of file UPstream.C.

References DynamicList< T, SizeMin >::clear().

Here is the call graph for this function:

◆ printNodeCommsControl()

void printNodeCommsControl ( Ostream os)
static

Report the node-communication settings.

Definition at line 56 of file UPstream.C.

References UPstream::nodeCommsControl_, UPstream::nodeCommsMin_, UPstream::nProcs(), UPstream::numNodes(), UPstream::usingNodeComms(), and UPstream::worldComm.

Referenced by argList::parse().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ printTopoControl()

void printTopoControl ( Ostream os)
static

Report the topology routines settings.

Definition at line 100 of file UPstream.C.

References Foam::PstreamDetail::broadcast(), Foam::BitOps::count(), Foam::PstreamDetail::gather(), PrintControl, Foam::reduce(), and UPstream::topologyControl_.

Referenced by argList::parse().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nRequests()

◆ resetRequests()

void resetRequests ( const label  n)
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.

◆ addRequest()

void addRequest ( UPstream::Request req)
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.

◆ cancelRequest() [1/2]

void cancelRequest ( const label  i)
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().

Here is the caller graph for this function:

◆ cancelRequest() [2/2]

void cancelRequest ( UPstream::Request req)
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.

◆ cancelRequests()

void cancelRequests ( UList< UPstream::Request > &  requests)
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.

◆ removeRequests()

void removeRequests ( label  pos,
label  len = -1 
)
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.

Parameters
posstarting position within the internal list of requests
lenlength of slice to remove (negative = until the end)

Definition at line 64 of file UPstreamRequest.C.

◆ freeRequest()

void freeRequest ( UPstream::Request req)
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().

Here is the caller graph for this function:

◆ freeRequests()

void freeRequests ( UList< UPstream::Request > &  requests)
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.

◆ waitRequests() [1/3]

void waitRequests ( label  pos,
label  len = -1 
)
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.

Parameters
posstarting position within the internal list of requests
lenlength of slice to check (negative = until the end)

Definition at line 69 of file UPstreamRequest.C.

◆ waitRequests() [2/3]

void waitRequests ( UList< UPstream::Request > &  requests)
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.

◆ waitAnyRequest() [1/2]

bool waitAnyRequest ( label  pos,
label  len = -1 
)
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.

Parameters
posstarting position within the internal list of requests
lenlength of slice to check (negative = until the end)
Returns
true if any pending request completed.
false if all requests have already been handled.

Definition at line 72 of file UPstreamRequest.C.

◆ waitSomeRequests() [1/3]

bool waitSomeRequests ( label  pos,
label  len = -1,
DynamicList< int > *  indices = nullptr 
)
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.

Parameters
[out]indicesthe 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.
Returns
true if some pending requests completed.
false if all requests have already been handled
Parameters
posstarting position within the internal list of requests
lenlength of slice to check (negative = until the end)

Definition at line 78 of file UPstreamRequest.C.

References DynamicList< T, SizeMin >::clear().

Referenced by UPstream::waitSomeRequests().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ waitSomeRequests() [2/3]

static bool waitSomeRequests ( label  pos,
DynamicList< int > &  indices 
)
inlinestatic

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.

Returns
true if some pending requests completed.
false if all requests have already been handled
Parameters
posstarting position within the internal list of requests
[out]indicescompleted request indices relative to pos

Definition at line 1620 of file UPstream.H.

References Foam::pos(), and UPstream::waitSomeRequests().

Here is the call graph for this function:

◆ waitSomeRequests() [3/3]

bool waitSomeRequests ( UList< UPstream::Request > &  requests,
DynamicList< int > *  indices = nullptr 
)
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.

Parameters
[out]indicesthe 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.
Parameters
requestsThe requests

Definition at line 89 of file UPstreamRequest.C.

References DynamicList< T, SizeMin >::clear().

Here is the call graph for this function:

◆ waitAnyRequest() [2/2]

int waitAnyRequest ( UList< UPstream::Request > &  requests)
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.

◆ waitRequest() [1/2]

void waitRequest ( const label  i)
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 mpiRequests[2];

mpiRequests[count] = PstreamUtils::Cast::to_mpi(req0); if (MPI_REQUEST_NULL != mpiRequests[count]) { ++count; }

mpiRequests[count] = PstreamUtils::Cast::to_mpi(req1); if (MPI_REQUEST_NULL != mpiRequests[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 (count == 1) { // On success: sets request to MPI_REQUEST_NULL if (MPI_Wait(mpiRequests, MPI_STATUS_IGNORE)) { FatalErrorInFunction << "MPI_Wait returned with error" << Foam::abort(FatalError); } } else // (count > 1) { // On success: sets each request to MPI_REQUEST_NULL if (MPI_Waitall(count, mpiRequests, 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(), UPstream::Request::wait(), and decomposedBlockData::writeBlocks().

Here is the caller graph for this function:

◆ waitRequest() [2/2]

void waitRequest ( UPstream::Request req)
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.

◆ activeRequest() [1/2]

bool activeRequest ( const label  i)
static

Is request i active (!= MPI_REQUEST_NULL)?

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.

◆ activeRequest() [2/2]

bool activeRequest ( const UPstream::Request req)
static

Is request active (!= MPI_REQUEST_NULL)?

Definition at line 107 of file UPstreamRequest.C.

◆ finishedRequest() [1/2]

bool finishedRequest ( const label  i)
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 109 of file UPstreamRequest.C.

Referenced by UPstream::Request::finished(), processorGAMGInterfaceField::ready(), and processorGAMGInterfaceField::updateInterfaceMatrix().

Here is the caller graph for this function:

◆ finishedRequest() [2/2]

bool finishedRequest ( UPstream::Request req)
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 110 of file UPstreamRequest.C.

◆ finishedRequests() [1/2]

bool finishedRequests ( label  pos,
label  len = -1 
)
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.

Parameters
posstarting position within the internal list of requests
lenlength of slice to check (negative = until the end)

Definition at line 112 of file UPstreamRequest.C.

Referenced by cyclicACMIGAMGInterfaceField::ready(), and cyclicAMIGAMGInterfaceField::ready().

Here is the caller graph for this function:

◆ finishedRequests() [2/2]

bool finishedRequests ( UList< UPstream::Request > &  requests)
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 118 of file UPstreamRequest.C.

◆ finishedRequestPair()

bool finishedRequestPair ( label &  req0,
label &  req1 
)
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 124 of file UPstreamRequest.C.

◆ waitRequestPair()

void waitRequestPair ( label &  req0,
label &  req1 
)
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 132 of file UPstreamRequest.C.

◆ parRun() [1/2]

static bool parRun ( bool  on)
inlinestaticnoexcept

Set as parallel run on/off.

Returns
the previous value

Definition at line 1762 of file UPstream.H.

◆ parRun() [2/2]

static bool& parRun ( )
inlinestaticnoexcept

Test if this a parallel run.

Modify access is deprecated

Definition at line 1774 of file UPstream.H.

Referenced by snappyLayerDriver::addLayers(), unwatchedIOdictionary::addWatch(), regIOobject::addWatch(), masterUncollatedFileOperation::addWatch(), masterUncollatedFileOperation::addWatches(), decompositionGAMGAgglomeration::agglomerate(), meshRefinement::balance(), AMIInterpolation::calcDistribution(), 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(), processorFaePatchField< Type >::coupled(), processorCyclicFvsPatchField< Type >::coupled(), processorCyclicPointPatchField< 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(), Foam::exitNow(), masterUncollatedFileOperation::filePath(), polyMesh::findCell(), masterUncollatedFileOperation::findInstance(), distributedTriSurfaceMesh::findLine(), distributedTriSurfaceMesh::findLineAll(), distributedTriSurfaceMesh::findLineAny(), distributedTriSurfaceMesh::findNearest(), masterUncollatedFileOperation::findTimes(), masterUncollatedFileOperation::findWatch(), Foam::getCommPattern(), zoneDistribute::getDatafromOtherProc(), distributedTriSurfaceMesh::getField(), masterUncollatedFileOperation::getFile(), distributedTriSurfaceMesh::getNormal(), distributedTriSurfaceMesh::getRegion(), masterUncollatedFileOperation::getState(), distributedTriSurfaceMesh::getVolumeType(), faMeshBoundaryHalo::haloSize(), InflationInjection< CloudType >::InflationInjection(), LocalInteraction< Foam::DSMCCloud >::info(), 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(), polyBoundaryMesh::neighbourEdges(), UPstream::newCommunicator(), masterUncollatedFileOperation::NewIFstream(), fvMeshTools::newMesh(), processorPolyPatch::order(), InflationInjection< CloudType >::parcelsToInject(), argList::parse(), meshRefinement::printMeshInfo(), processorTopology::procAdjacency(), uniformBin::processField(), 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(), cyclicAMIPolyPatch::resetAMI(), mapDistributeBase::schedule(), Time::setControls(), foamReport::setStaticBuiltins(), masterUncollatedFileOperation::setUnmodified(), zoneDistribute::setUpCommforZone(), globalMeshData::sharedPoints(), shortestPathSet::shortestPathSet(), error::simpleExit(), UPstream::splitCommunicator(), messageStream::stream(), surfaceNoise::surfaceAverage(), syncObjects::sync(), masterUncollatedFileOperation::sync(), syncTools::syncBoundaryFaceList(), syncTools::syncEdgeMap(), syncTools::syncFaceList(), faMesh::syncGeom(), syncTools::syncPointMap(), triSurfaceMesh::triSurfaceMesh(), fileOperation::uniformFile(), processorPolyPatch::updateMesh(), processorFaPatch::updateMesh(), faMesh::updateMesh(), masterUncollatedFileOperation::updateStates(), fileOperation::updateStates(), dynamicCode::waitForFile(), viewFactorHeatFlux::write(), energySpectrum::write(), ensightCells::write(), meshToMeshMethod::writeConnectivity(), AMIWeights::writeFileHeader(), isoAdvection::writeIsoFaces(), collatedFileOperation::writeObject(), surfaceNoise::writeSurfaceData(), and streamLineBase::writeToFile().

◆ haveThreads()

static bool haveThreads ( )
inlinestaticnoexcept

Have support for threads.

Definition at line 1779 of file UPstream.H.

Referenced by OFstreamCollator::write().

Here is the caller graph for this function:

◆ masterNo()

◆ nProcs()

static label nProcs ( label  communicator = worldComm)
inlinestatic

Number of ranks in parallel run (for given communicator). It is 1 for serial run.

Definition at line 1790 of file UPstream.H.

References UList< T >::size().

Referenced by surfaceZonesInfo::addCellZonesToMesh(), surfaceZonesInfo::addFaceZonesToMesh(), eagerGAMGProcAgglomeration::agglomerate(), manualGAMGProcAgglomeration::agglomerate(), masterCoarsestGAMGProcAgglomeration::agglomerate(), AMIInterpolation::agglomerate(), bitSet::allGather(), meshRefinement::balance(), faPatch::boundaryProcs(), faMesh::boundaryProcs(), faPatch::boundaryProcSizes(), faMesh::boundaryProcSizes(), mapDistributeBase::calcCompactAddressing(), AMIInterpolation::calcDistribution(), 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(), UPstream::find_first(), distributedTriSurfaceMesh::findNearest(), mappedPatchBase::findSamples(), lduPrimitiveMesh::gather(), decomposedBlockData::gather(), decomposedBlockData::gatherProcData(), bitSet::gatherValues(), 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(), procFacesGAMGProcAgglomeration::procFacesGAMGProcAgglomeration(), decomposedBlockData::readBlocks(), masterUncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readStream(), Foam::PstreamDetail::reduce_offsetRange(), Foam::PstreamDetail::reduce_offsetRanges(), Foam::reduceOffsets(), meshRefinement::refineCandidates(), Foam::regionSum(), meshRefinement::removeGapCells(), parProfiling::report(), profilingPstream::report(), faMeshBoundaryHalo::reset(), fvMeshSubset::reset(), mapDistributeBase::schedule(), foamReport::setStaticBuiltins(), zoneDistribute::setUpCommforZone(), ParSortableList< Type >::sort(), fileOperation::subRanks(), trackingInverseDistance::update(), inverseDistance::update(), oversetFvMeshBase::updateAddressing(), patchInjectionBase::updateMesh(), globalMeshData::updateMesh(), agglomerationInfo::write(), OFstreamCollator::write(), decomposedBlockData::writeBlocks(), externalCoupled::writeGeometry(), isoAdvection::writeIsoFaces(), caseInfo::writeMeta(), and streamLineBase::writeToFile().

Here is the call graph for this function:

◆ myProcNo()

static int myProcNo ( label  communicator = worldComm)
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 1799 of file UPstream.H.

Referenced by surfaceZonesInfo::addCellZonesToMesh(), surfaceZonesInfo::addFaceZonesToMesh(), eagerGAMGProcAgglomeration::agglomerate(), manualGAMGProcAgglomeration::agglomerate(), masterCoarsestGAMGProcAgglomeration::agglomerate(), AMIInterpolation::agglomerate(), faPatch::boundaryProcs(), faMesh::boundaryProcs(), faPatch::boundaryProcSizes(), faMesh::boundaryProcSizes(), bitSet::broadcast(), Foam::calcCellCellsImpl(), mapDistributeBase::calcCompactAddressing(), globalIndex::calcOffset(), 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(), UPstream::find_first(), UPstream::find_last(), InjectionModel< CloudType >::findCellAtPosition(), internalFieldProbe::findElements(), patchFieldProbe::findElements(), mappedPatchBase::findLocalSamples(), distributedTriSurfaceMesh::findNearest(), mappedPatchBase::findSamples(), decomposedBlockData::gatherProcData(), 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(), error::Pout_mem_hwm(), mapDistributeBase::printLayout(), fileOperation::printRanks(), processorTopology::procAdjacency(), backgroundMeshDecomposition::procBounds(), triangulatedPatch::randomGlobalPoint(), globalIndex::range(), masterUncollatedFileOperation::read(), masterUncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readStream(), Foam::PstreamDetail::reduce_offsetRanges(), indexedVertex< Gt, Vb >::referred(), zoltanRenumber::renumber(), mapDistributeBase::renumber(), faMeshBoundaryHalo::reset(), fvMeshSubset::reset(), cyclicAMIPolyPatch::resetAMI(), mapDistributeBase::schedule(), cyclicAMIPolyPatch::setAMIFaces(), cellSetOption::setCellSelection(), Time::setControls(), patchInjectionBase::setPositionAndCell(), zoneDistribute::setUpCommforZone(), globalIndex::slice(), ParSortableList< Type >::sort(), KinematicSurfaceFilm< CloudType >::splashInteraction(), 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(), agglomerationInfo::write(), cyclicAMIGAMGInterface::write(), cyclicACMIGAMGInterface::write(), meshToMeshMethod::writeConnectivity(), AMIInterpolation::writeFaceConnectivity(), externalCoupled::writeGeometry(), isoAdvection::writeIsoFaces(), and distributedTriSurfaceMesh::writeStats().

◆ master()

static bool master ( label  communicator = worldComm)
inlinestatic

True if process corresponds to the master rank in the communicator.

Definition at line 1807 of file UPstream.H.

References UPstream::masterNo().

Referenced by abaqusMeshSet::abaqusMeshSet(), regIOobject::addWatch(), masterUncollatedFileOperation::addWatch(), masterUncollatedFileOperation::addWatches(), Foam::broadcastFile_recursive(), Foam::broadcastFile_single(), AMIInterpolation::calcDistribution(), mappedPatchBase::calcMapping(), pointNoise::calculate(), viewFactor::calculate(), surfaceNoise::calculate(), writeFile::canResetFile(), writeFile::canWriteHeader(), writeFile::canWriteToFile(), argList::check(), argList::checkRootCase(), extractEulerianParticles::collectParticle(), sizeDistribution::combineFields(), logFiles::createFiles(), Foam::createReconstructMap(), simpleGeomDecomp::decompose(), masterUncollatedFileOperation::dirPath(), systemCall::dispatch(), distributedTriSurfaceMesh::distribute(), distributedTriSurfaceMesh::distributedTriSurfaceMesh(), snappyVoxelMeshDriver::doRefine(), abort::end(), abort::execute(), Curle::execute(), momentum::execute(), graphFunctionObject::execute(), externalFileCoupler::externalFileCoupler(), masterUncollatedFileOperation::filePath(), logFiles::files(), internalFieldProbe::findElements(), masterUncollatedFileOperation::findInstance(), distributedTriSurfaceMesh::findLine(), distributedTriSurfaceMesh::findLineAll(), distributedTriSurfaceMesh::findLineAny(), distributedTriSurfaceMesh::findNearest(), masterUncollatedFileOperation::findTimes(), masterUncollatedFileOperation::findWatch(), STDMD::fit(), lduPrimitiveMesh::gather(), decomposedBlockData::gatherProcData(), coordSet::gatherSort(), bitSet::gatherValues(), distributedTriSurfaceMesh::getField(), masterUncollatedFileOperation::getFile(), distributedTriSurfaceMesh::getNormal(), distributedTriSurfaceMesh::getRegion(), Foam::getSelectedProcs(), masterUncollatedFileOperation::getState(), distributedTriSurfaceMesh::getVolumeType(), Random::globalGaussNormal(), globalIndex::globalIndex(), Random::globalPosition(), Random::globalRandomise01(), Random::globalSample01(), distributedTriSurfaceMesh::globalTris(), viewFactor::initialise(), surfaceNoise::initialise(), interfaceHeight::interfaceHeight(), fileOperation::isIOrank(), JobInfo::JobInfo(), fileOperation::lookupAndCacheProcessorsPath(), LUscalarMatrix::LUscalarMatrix(), NURBS3DVolume::makeFolders(), error::master(), messageStream::masterStream(), ensightCase::newCloud(), writeFile::newFile(), writeFile::newFileAtTime(), ensightCase::newGeometry(), masterUncollatedFileOperation::NewIFstream(), fvMeshTools::newMesh(), fileOperation::nProcs(), objectiveManager::objectiveManager(), InflationInjection< CloudType >::parcelsToInject(), argList::parse(), pointHistory::pointHistory(), porosityModel::porosityModel(), error::Pout_mem_hwm(), UPstream::printCommTree(), meshRefinement::printMeshInfo(), fileOperation::printRanks(), pointNoise::processData(), decomposedBlockData::read(), timeActivatedFileUpdate::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(), messageStream::stream(), surfaceNoise::surfaceAverage(), hexRef8Data::sync(), masterUncollatedFileOperation::sync(), syncTools::syncEdgeMap(), syncTools::syncPointMap(), triSurfaceMesh::triSurfaceMesh(), sixDoFRigidBodyMotion::update(), lumpedPointDisplacementPointPatchVectorField::updateCoeffs(), fileMonitor::updateStates(), masterUncollatedFileOperation::updateStates(), solution::upgradeSolverDict(), externalFileCoupler::useMaster(), externalFileCoupler::useSlave(), OFstreamCollator::waitAll(), externalFileCoupler::waitForMaster(), externalFileCoupler::waitForSlave(), histogramModel::write(), ensightOutputSurface::write(), ensightFaMesh::write(), timeInfo::write(), viewFactorHeatFlux::write(), yPlus::write(), OFstreamCollator::write(), energySpectrum::write(), radiometerProbes::write(), referenceTemperature::write(), wallShearStress::write(), ensightMesh::write(), foamReport::write(), caseInfo::write(), sizeDistribution::write(), NURBS3DCurve::write(), effectivenessTable::write(), volFieldValue::write(), graphFunctionObject::write(), regionSizeDistribution::write(), NURBS3DSurface::write(), surfaceFieldValue::write(), propellerInfo::writeAxialWake(), decomposedBlockData::writeBlocks(), volumetricBSplinesDesignVariables::writeBounds(), ensightCells::writeBox(), updateMethod::writeCorrection(), NURBS3DVolume::writeCps(), decomposedBlockData::writeData(), lumpedPointMovement::writeData(), lumpedPointMovement::writeForcesAndMomentsVTP(), externalCoupled::writeGeometry(), isoAdvection::writeIsoFaces(), SQPBase::writeMeritFunction(), decomposedBlockData::writeObject(), surfaceNoise::writeSurfaceData(), streamLineBase::writeToFile(), GCMMA::writeToFiles(), NURBS3DSurface::writeVTK(), propellerInfo::writeWake(), AMIWeights::writeWeightField(), NURBS3DCurve::writeWParses(), and NURBS3DSurface::writeWParses().

Here is the call graph for this function:

◆ is_rank()

static bool is_rank ( label  communicator = worldComm)
inlinestatic

True if process corresponds to any rank (master or sub-rank) in the given communicator.

Definition at line 1816 of file UPstream.H.

References UPstream::masterNo().

Referenced by UPstream::is_parallel(), error::list_mem_hwm(), and UPstream::whichCommunication().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ is_subrank()

static bool is_subrank ( label  communicator = worldComm)
inlinestatic

True if process corresponds to a sub-rank in the given communicator.

Definition at line 1824 of file UPstream.H.

References UPstream::masterNo().

Referenced by Foam::broadcastFile_recursive(), Foam::broadcastFile_single(), decomposedBlockData::readBlocks(), OFstreamCollator::write(), decomposedBlockData::writeBlocks(), and decomposedBlockData::writeData().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ is_parallel()

static bool is_parallel ( label  communicator = worldComm)
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 1836 of file UPstream.H.

References UPstream::is_rank(), and UPstream::commsStruct::nProcs().

Referenced by bitSet::allGather(), bitSet::broadcast(), globalIndex::calcOffset(), IOobjectList::checkNames(), UPstream::find_first(), UPstream::find_last(), bitSet::gatherValues(), Foam::reduce(), exprValueFieldTag::reduce(), Foam::PstreamDetail::reduce_offsetRange(), Foam::PstreamDetail::reduce_offsetRanges(), bitSet::reduceAnd(), Foam::reduceOffsets(), bitSet::reduceOr(), Foam::sumReduce(), and globalMeshData::updateMesh().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ numNodes()

static int numNodes ( )
inlinestaticnoexcept

The number of shared/host nodes in the (const) world communicator.

Definition at line 1847 of file UPstream.H.

Referenced by fileOperation::getGlobalHostIORanks(), and UPstream::printNodeCommsControl().

Here is the caller graph for this function:

◆ parent()

static label parent ( int  communicator)
inlinestatic

The parent communicator.

Definition at line 1852 of file UPstream.H.

Referenced by UPstream::allocateCommunicator(), UPstream::baseProcNo(), UPstream::procNo(), and UPstream::communicator::reset().

Here is the caller graph for this function:

◆ procID()

static List<int>& procID ( int  communicator)
inlinestatic

The list of ranks within a given communicator.

Definition at line 1860 of file UPstream.H.

Referenced by UPstream::baseProcNo(), Foam::operator<<(), collatedFileOperation::processorsDir(), and UPstream::procNo().

Here is the caller graph for this function:

◆ sameProcs() [1/3]

static bool sameProcs ( int  communicator1,
int  communicator2 
)
inlinestatic

Test for communicator equality.

True if they have the same index or address the same ranks

Definition at line 1871 of file UPstream.H.

Referenced by AMIInterpolation::calcDistribution().

Here is the caller graph for this function:

◆ sameProcs() [2/3]

static bool sameProcs ( int  communicator,
const UList< T1 > &  procs 
)
inlinestatic

Test equality of communicator procs with the given list of ranks. Includes a guard for the communicator index.

Definition at line 1886 of file UPstream.H.

◆ sameProcs() [3/3]

static bool sameProcs ( const UList< T1 > &  procs1,
const UList< T2 > &  procs2 
)
inlinestatic

Test the equality of two lists of ranks.

Definition at line 1904 of file UPstream.H.

◆ allWorlds()

static const wordList& allWorlds ( )
inlinestaticnoexcept

All worlds.

Definition at line 1915 of file UPstream.H.

Referenced by mappedPatchBase::calcMapping(), mappedPatchBase::masterWorld(), argList::parse(), Foam::printDOT(), and mappedPatchBase::sameWorld().

Here is the caller graph for this function:

◆ worldIDs()

static const labelList& worldIDs ( )
inlinestaticnoexcept

The indices into allWorlds for all processes.

Definition at line 1923 of file UPstream.H.

◆ myWorldID()

static label myWorldID ( )
inlinestatic

My worldID.

Definition at line 1931 of file UPstream.H.

References UPstream::commGlobal(), and UPstream::myProcNo().

Referenced by mappedPatchBase::calcMapping(), multiWorldConnections::createComms(), and mappedPatchBase::masterWorld().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ myWorld()

static const word& myWorld ( )
inlinestatic

My world.

Definition at line 1939 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().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ allProcs()

static rangeType allProcs ( label  communicator = worldComm)
inlinestatic

Range of process indices for all processes.

Definition at line 1950 of file UPstream.H.

References UPstream::commsStruct::nProcs().

Referenced by refinementHistory::distribute(), Foam::getSelectedProcs(), viewFactor::initialise(), ParSortableList< Type >::sort(), energySpectrum::write(), and externalCoupled::writeGeometry().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ subProcs()

static rangeType subProcs ( label  communicator = worldComm)
inlinestatic

Range of process indices for sub-processes.

Definition at line 1959 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(), and syncTools::syncPointMap().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ interNode_offsets()

const Foam::List< int > & interNode_offsets ( )
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().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ localNode_parentProcs()

const Foam::UPstream::rangeType & 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().

Here is the call graph for this function:

◆ linearCommunication()

const Foam::UPstream::commsStructList & linearCommunication ( int  communicator)
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().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ treeCommunication()

const Foam::UPstream::commsStructList & treeCommunication ( int  communicator)
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().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ whichCommunication()

static const commsStructList& whichCommunication ( const int  communicator,
bool  linear = false 
)
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.

Parameters
linearoptionally select linear schedule only

Definition at line 1992 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().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ msgType() [1/2]

static int& msgType ( )
inlinestaticnoexcept

Message tag of standard messages.

Definition at line 2019 of file UPstream.H.

Referenced by solidAbsorption::a(), mappedPatchBase::calcMapping(), faceAreaWeightAMI::calculate(), AMIInterpolation::calculate(), advancingFrontAMI::checkPatches(), masterUncollatedFileOperation::chMod(), mappedPatchBase::collectSamples(), extendedCentredFaceToCellStencil::compact(), extendedCentredCellToFaceStencil::compact(), extendedCentredCellToCellStencil::compact(), GAMGAgglomeration::continueAgglomerating(), masterUncollatedFileOperation::cp(), masterUncollatedFileOperation::dirPath(), mappedPatchBase::distribute(), solidAbsorption::e(), masterUncollatedFileOperation::exists(), masterUncollatedFileOperation::filePath(), masterUncollatedFileOperation::fileSize(), distributedTriSurfaceMesh::findLine(), distributedTriSurfaceMesh::findLineAll(), distributedTriSurfaceMesh::findLineAny(), distributedTriSurfaceMesh::findNearest(), mappedPatchBase::findSamples(), decomposedBlockData::gatherProcData(), Foam::gAverage(), globalMeshData::geometricSharedPoints(), distributedTriSurfaceMesh::getField(), distributedTriSurfaceMesh::getNormal(), distributedTriSurfaceMesh::getRegion(), 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(), globalMeshData::mergePoints(), masterUncollatedFileOperation::mkDir(), masterUncollatedFileOperation::mode(), masterUncollatedFileOperation::mv(), masterUncollatedFileOperation::mvBak(), masterUncollatedFileOperation::NewIFstream(), AMIInterpolation::normaliseWeights(), fileOperation::printRanks(), processorTopology::procAdjacency(), decomposedBlockData::readBlocks(), masterUncollatedFileOperation::readDir(), masterUncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readStream(), surfaceNoise::readSurfaceData(), lduMesh::reduce(), exprValueFieldTag::reduce(), faMeshBoundaryHalo::reset(), cyclicAMIPolyPatch::resetAMI(), mappedPatchBase::reverseDistribute(), masterUncollatedFileOperation::rm(), masterUncollatedFileOperation::rmDir(), mapDistributeBase::schedule(), cyclicAMIPolyPatch::setAMIFaces(), 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(), MarshakRadiationFvPatchScalarField::updateCoeffs(), filmPyrolysisTemperatureCoupledFvPatchScalarField::updateCoeffs(), filmPyrolysisVelocityCoupledFvPatchVectorField::updateCoeffs(), MarshakRadiationFixedTemperatureFvPatchScalarField::updateCoeffs(), greyDiffusiveRadiationMixedFvPatchScalarField::updateCoeffs(), alphatFilmWallFunctionFvPatchScalarField::updateCoeffs(), turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs(), agglomerationInfo::write(), OFstreamCollator::write(), decomposedBlockData::writeBlocks(), and surfaceNoise::writeSurfaceData().

◆ msgType() [2/2]

static int msgType ( int  val)
inlinestaticnoexcept

Set the message tag for standard messages.

Returns
the previous value

Definition at line 2029 of file UPstream.H.

◆ incrMsgType()

◆ commsType() [1/2]

commsTypes commsType ( ) const
inlinenoexcept

Get the communications type of the stream.

Definition at line 2051 of file UPstream.H.

Referenced by OPstream::send(), and UIPstream::UIPstream().

Here is the caller graph for this function:

◆ commsType() [2/2]

commsTypes commsType ( const commsTypes  ct)
inlinenoexcept

Set the communications type of the stream.

Returns
the previous value

Definition at line 2061 of file UPstream.H.

◆ shutdown()

void shutdown ( int  errNo = 0)
static

Shutdown (finalize) MPI as required.

Uses MPI_Abort instead of MPI_Finalize if errNo is non-zero

Definition at line 58 of file UPstream.C.

Referenced by ParRunControl::~ParRunControl().

Here is the caller graph for this function:

◆ abort()

void abort ( int  errNo = 1)
static

Call MPI_Abort with no other checks or cleanup.

Definition at line 69 of file UPstream.C.

References Foam::abort().

Referenced by error::simpleExit().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ exit()

void exit ( int  errNo = 1)
static

Shutdown (finalize) MPI as required and exit program with errNo.

Definition at line 62 of file UPstream.C.

References Foam::exit().

Referenced by argList::argList(), designVariablesUpdate::checkConvergence(), Foam::exitNow(), argList::parse(), ParRunControl::runPar(), and error::simpleExit().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ allToAll() [1/2]

void allToAll ( const UList< int32_t > &  sendData,
UList< int32_t > &  recvData,
const int  communicator = UPstream::worldComm 
)
static

Exchange int32_t data with all ranks in communicator.

non-parallel : simple copy of sendData to recvData

Parameters
[in]sendDataThe value at [proci] is sent to proci
[out]recvDataThe data received from the other ranks

Definition at line 42 of file UPstreamAllToAll.C.

Referenced by fvMeshDistribute::distribute().

Here is the caller graph for this function:

◆ allToAllConsensus() [1/6]

void allToAllConsensus ( const UList< int32_t > &  sendData,
UList< int32_t > &  recvData,
const int  tag,
const int  communicator = UPstream::worldComm 
)
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

Note
The message tag should be chosen to be a unique value

since the implementation uses probing with ANY_SOURCE !!

An initial barrier may help to avoid synchronisation problems

caused elsewhere (See "nbx.tuning" opt switch)

Parameters
[in]sendDataThe non-zero value at [proci] is sent to proci
[out]recvDataThe non-zero value received from each rank
tagMessage tag for the communication

Definition at line 74 of file UPstreamAllToAll.C.

◆ allToAllConsensus() [2/6]

void allToAllConsensus ( const Map< int32_t > &  sendData,
Map< int32_t > &  recvData,
const int  tag,
const int  communicator = UPstream::worldComm 
)
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

Parameters
[in]sendDataThe value at [proci] is sent to proci.
[out]recvDataThe values received from given ranks.
tagMessage tag for the communication

Definition at line 74 of file UPstreamAllToAll.C.

◆ allToAllConsensus() [3/6]

static Map< int32_t > allToAllConsensus ( const Map< int32_t > &  sendData,
const int  tag,
const int  communicator = UPstream::worldComm 
)
inlinestatic

Exchange int32_t data between ranks [NBX].

Returns
any received data as a Map
Parameters
[in]sendDataThe value at [proci] is sent to proci.
tagMessage tag for the communication

Definition at line 2153 of file UPstream.H.

◆ allToAll() [2/2]

void allToAll ( const UList< int64_t > &  sendData,
UList< int64_t > &  recvData,
const int  communicator = UPstream::worldComm 
)
static

Exchange int64_t data with all ranks in communicator.

non-parallel : simple copy of sendData to recvData

Parameters
[in]sendDataThe value at [proci] is sent to proci
[out]recvDataThe data received from the other ranks

Definition at line 43 of file UPstreamAllToAll.C.

◆ allToAllConsensus() [4/6]

void allToAllConsensus ( const UList< int64_t > &  sendData,
UList< int64_t > &  recvData,
const int  tag,
const int  communicator = UPstream::worldComm 
)
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

Note
The message tag should be chosen to be a unique value

since the implementation uses probing with ANY_SOURCE !!

An initial barrier may help to avoid synchronisation problems

caused elsewhere (See "nbx.tuning" opt switch)

Parameters
[in]sendDataThe non-zero value at [proci] is sent to proci
[out]recvDataThe non-zero value received from each rank
tagMessage tag for the communication

Definition at line 75 of file UPstreamAllToAll.C.

◆ allToAllConsensus() [5/6]

void allToAllConsensus ( const Map< int64_t > &  sendData,
Map< int64_t > &  recvData,
const int  tag,
const int  communicator = UPstream::worldComm 
)
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

Parameters
[in]sendDataThe value at [proci] is sent to proci.
[out]recvDataThe values received from given ranks.
tagMessage tag for the communication

Definition at line 75 of file UPstreamAllToAll.C.

◆ allToAllConsensus() [6/6]

static Map< int64_t > allToAllConsensus ( const Map< int64_t > &  sendData,
const int  tag,
const int  communicator = UPstream::worldComm 
)
inlinestatic

Exchange int64_t data between ranks [NBX].

Returns
any received data as a Map
Parameters
[in]sendDataThe value at [proci] is sent to proci.
tagMessage tag for the communication

Definition at line 2154 of file UPstream.H.

◆ mpiGather()

static void mpiGather ( const Type *  sendData,
Type *  recvData,
int  count,
const int  communicator = UPstream::worldComm 
)
static

Receive identically-sized (contiguous) data from all ranks.

Parameters
sendDataAll ranks: location of individual value to send
recvDataMaster: receive buffer with all values. Other ranks: ignored
countNumber of send/recv data per rank. Globally consistent!

Referenced by decomposedBlockData::gather(), bitSet::gatherValues(), and profilingPstream::report().

Here is the caller graph for this function:

◆ mpiScatter()

static void mpiScatter ( const Type *  sendData,
Type *  recvData,
int  count,
const int  communicator = UPstream::worldComm 
)
static

Send identically-sized (contiguous) data to all ranks.

Parameters
sendDataMaster: send buffer with all values. Other ranks: ignored
recvDataAll ranks: location to receive individual value
countNumber of send/recv data per rank. Globally consistent!

◆ mpiAllGather()

static void mpiAllGather ( Type *  allData,
int  count,
const int  communicator = UPstream::worldComm 
)
static

Gather/scatter identically-sized data.

Send data from proc slot, receive into all slots

Parameters
allDataAll ranks: the base of the data locations
countNumber of send/recv data per rank. Globally consistent!

Referenced by fileOperation::getGlobalHostIORanks(), and globalMeshData::updateMesh().

Here is the caller graph for this function:

◆ mpiGatherv()

static void mpiGatherv ( const Type *  sendData,
int  sendCount,
Type *  recvData,
const UList< int > &  recvCounts,
const UList< int > &  recvOffsets,
const int  communicator = UPstream::worldComm 
)
static

Receive variable length data from all ranks.

Parameters
sendCountIgnored on master if recvCount[0] == 0
recvDataIgnored on non-root rank
recvCountsIgnored on non-root rank
recvOffsetsIgnored on non-root rank

Referenced by UPstream::gather(), and decomposedBlockData::gatherProcData().

Here is the caller graph for this function:

◆ mpiScatterv()

static void mpiScatterv ( const Type *  sendData,
const UList< int > &  sendCounts,
const UList< int > &  sendOffsets,
Type *  recvData,
int  recvCount,
const int  communicator = UPstream::worldComm 
)
static

Send variable length data to all ranks.

Parameters
sendDataIgnored on non-root rank
sendCountsIgnored on non-root rank
sendOffsetsIgnored on non-root rank

Referenced by UPstream::scatter().

Here is the caller graph for this function:

◆ allGatherValues()

static List<T> allGatherValues ( const T localValue,
const int  communicator = UPstream::worldComm 
)
static

Allgather individual values into list locations.

The returned list has size nProcs, identical on all ranks.

◆ listGatherValues()

static List<T> listGatherValues ( const T localValue,
const int  communicator = UPstream::worldComm 
)
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 globalIndex::globalIndex(), error::list_mem_hwm(), triangulatedPatch::randomGlobalPoint(), and globalIndex::reset().

Here is the caller graph for this function:

◆ listScatterValues()

static T listScatterValues ( const UList< T > &  allValues,
const int  communicator = UPstream::worldComm 
)
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).

◆ broadcast() [1/2]

static bool broadcast ( Type *  buffer,
std::streamsize  count,
const int  communicator,
const int  root = UPstream::masterNo() 
)
inlinestatic

Broadcast buffer contents (contiguous types) to all ranks (default: from rank=0). The sizes must match on all processes.

For non-parallel : do nothing.

Returns
True on success
Parameters
rootThe broadcast root (0 == master, -1 = last rank)

Referenced by bitSet::allGather(), bitSet::broadcast(), Foam::broadcastFile_recursive(), Foam::broadcastFile_single(), Foam::PstreamDetail::reduce_offsetRange(), Foam::PstreamDetail::reduce_offsetRanges(), Foam::reduceOffsets(), OFstreamCollator::write(), and decomposedBlockData::writeBlocks().

Here is the caller graph for this function:

◆ broadcast() [2/2]

static bool broadcast ( FixedList< Type, N > &  list,
const int  communicator,
const int  root = UPstream::masterNo() 
)
inlinestatic

Broadcast fixed-list content (contiguous types) to all ranks (default: from rank=0). The sizes must match on all processes.

For non-parallel : do nothing.

Returns
True on success
Parameters
rootThe broadcast root (0 == master, -1 = last rank)

◆ mpiReduce() [1/2]

static void mpiReduce ( T  values[],
int  count,
const UPstream::opCodes  opCodeId,
const int  communicator = UPstream::worldComm 
)
static

MPI_Reduce (blocking) for known operators.

For non-parallel : do nothing.

◆ mpiReduce() [2/2]

static void mpiReduce ( T  values[],
int  count,
const int  communicator = UPstream::worldComm 
)
static

MPI_Reduce (blocking) for known operators.

For non-parallel : do nothing.

◆ mpiAllReduce() [1/4]

static void mpiAllReduce ( T  values[],
int  count,
const UPstream::opCodes  opCodeId,
const int  communicator = UPstream::worldComm 
)
static

MPI_Allreduce (blocking) for known operators.

For non-parallel : do nothing.

Referenced by Foam::reduce(), and Foam::sumReduce().

Here is the caller graph for this function:

◆ mpiAllReduce() [2/4]

static void mpiAllReduce ( T  values[],
int  count,
const int  communicator = UPstream::worldComm 
)
static

MPI_Allreduce (blocking) for known operators.

For non-parallel : do nothing.

◆ mpiAllReduce() [3/4]

static void mpiAllReduce ( T  values[],
int  count,
const UPstream::opCodes  opCodeId,
const int  communicator,
UPstream::Request req 
)
static

MPI_Iallreduce (non-blocking) for known operators.

For non-parallel : do nothing.

◆ mpiAllReduce() [4/4]

static void mpiAllReduce ( T  values[],
int  count,
const int  communicator,
UPstream::Request req 
)
static

MPI_Iallreduce (non-blocking) for known operators.

For non-parallel : do nothing.

◆ mpiReduce_min()

static void mpiReduce_min ( T  values[],
int  count,
const int  communicator = UPstream::worldComm 
)
inlinestatic

MPI Reduce min.

Definition at line 2433 of file UPstream.H.

◆ mpiAllReduce_min()

static void mpiAllReduce_min ( T  values[],
int  count,
const int  communicator = UPstream::worldComm 
)
inlinestatic

MPI Allreduce min.

Definition at line 2433 of file UPstream.H.

Referenced by bitSet::reduceAnd().

Here is the caller graph for this function:

◆ mpiReduce_max()

static void mpiReduce_max ( T  values[],
int  count,
const int  communicator = UPstream::worldComm 
)
inlinestatic

MPI Reduce max.

Definition at line 2434 of file UPstream.H.

Referenced by error::list_mem_hwm().

Here is the caller graph for this function:

◆ mpiAllReduce_max()

static void mpiAllReduce_max ( T  values[],
int  count,
const int  communicator = UPstream::worldComm 
)
inlinestatic

MPI Allreduce max.

Definition at line 2434 of file UPstream.H.

Referenced by bitSet::reduceOr().

Here is the caller graph for this function:

◆ mpiReduce_sum()

static void mpiReduce_sum ( T  values[],
int  count,
const int  communicator = UPstream::worldComm 
)
inlinestatic

MPI Reduce sum.

Definition at line 2435 of file UPstream.H.

Referenced by error::list_mem_hwm(), and error::Pout_mem_hwm().

Here is the caller graph for this function:

◆ mpiAllReduce_sum()

static void mpiAllReduce_sum ( T  values[],
int  count,
const int  communicator = UPstream::worldComm 
)
inlinestatic

MPI Allreduce sum.

Definition at line 2435 of file UPstream.H.

◆ mpiScan() [1/2]

static void mpiScan ( T  values[],
int  count,
const int  communicator,
const bool  exclusive = false 
)
static

Inclusive/exclusive scan (in-place).

In exclusive mode, the degenerate value on rank=0 has no meaning and will normally be treated like non-exclusive mode (ie, original values). However, for the opCodes::op_sum type we can provide a sensible value and overwrite it with a zero-initialized value.

Note
For non-parallel : do nothing.
Parameters
exclusiveUse exclusive scan (MPI_Exscan vs MPI_Scan)

◆ mpiScan() [2/2]

static T mpiScan ( const T localValue,
const int  communicator,
const bool  exclusive = false 
)
static

Inclusive/exclusive scan returning the result. In exclusive mode, the degenerate value on rank=0 has no meaning but is treated like non-exclusive mode (ie, original values)

Note
For non-parallel : return own value
Parameters
exclusiveUse exclusive scan (MPI_Exscan vs MPI_Scan)

◆ mpiScan_min() [1/2]

static void mpiScan_min ( T  values[],
int  count,
const int  communicator,
const bool  exclusive = false 
)
inlinestatic

Inclusive/exclusive min scan (in-place)

See UPstream::mpiScan for notes about the behaviour

Parameters
exclusiveUse exclusive scan (MPI_Exscan vs MPI_Scan)

Definition at line 2539 of file UPstream.H.

◆ mpiExscan_min() [1/2]

static void mpiExscan_min ( T  values[],
int  count,
const int  communicator 
)
inlinestatic

Exclusive min scan (in-place)

See UPstream::mpiScan for notes about the behaviour

Definition at line 2539 of file UPstream.H.

◆ mpiScan_min() [2/2]

static T mpiScan_min ( const T value,
const int  communicator,
const bool  exclusive = false 
)
inlinestatic

Inclusive/exclusive min scan returning result.

See UPstream::mpiScan for notes about the behaviour

Parameters
exclusiveUse exclusive scan (MPI_Exscan vs MPI_Scan)

Definition at line 2539 of file UPstream.H.

◆ mpiExscan_min() [2/2]

static T mpiExscan_min ( const T value,
const int  communicator 
)
inlinestatic

Exclusive min scan returning result.

See UPstream::mpiScan for notes about the behaviour

Definition at line 2539 of file UPstream.H.

◆ mpiScan_max() [1/2]

static void mpiScan_max ( T  values[],
int  count,
const int  communicator,
const bool  exclusive = false 
)
inlinestatic

Inclusive/exclusive max scan (in-place)

See UPstream::mpiScan for notes about the behaviour

Parameters
exclusiveUse exclusive scan (MPI_Exscan vs MPI_Scan)

Definition at line 2540 of file UPstream.H.

◆ mpiExscan_max() [1/2]

static void mpiExscan_max ( T  values[],
int  count,
const int  communicator 
)
inlinestatic

Exclusive max scan (in-place)

See UPstream::mpiScan for notes about the behaviour

Definition at line 2540 of file UPstream.H.

◆ mpiScan_max() [2/2]

static T mpiScan_max ( const T value,
const int  communicator,
const bool  exclusive = false 
)
inlinestatic

Inclusive/exclusive max scan returning result.

See UPstream::mpiScan for notes about the behaviour

Parameters
exclusiveUse exclusive scan (MPI_Exscan vs MPI_Scan)

Definition at line 2540 of file UPstream.H.

◆ mpiExscan_max() [2/2]

static T mpiExscan_max ( const T value,
const int  communicator 
)
inlinestatic

Exclusive max scan returning result.

See UPstream::mpiScan for notes about the behaviour

Definition at line 2540 of file UPstream.H.

◆ mpiScan_sum() [1/2]

static void mpiScan_sum ( T  values[],
int  count,
const int  communicator,
const bool  exclusive = false 
)
inlinestatic

Inclusive/exclusive sum scan (in-place)

See UPstream::mpiScan for notes about the behaviour

Parameters
exclusiveUse exclusive scan (MPI_Exscan vs MPI_Scan)

Definition at line 2541 of file UPstream.H.

◆ mpiExscan_sum() [1/2]

static void mpiExscan_sum ( T  values[],
int  count,
const int  communicator 
)
inlinestatic

Exclusive sum scan (in-place)

See UPstream::mpiScan for notes about the behaviour

Definition at line 2541 of file UPstream.H.

Referenced by Foam::PstreamDetail::reduce_offsetRange(), Foam::PstreamDetail::reduce_offsetRanges(), and Foam::reduceOffsets().

Here is the caller graph for this function:

◆ mpiScan_sum() [2/2]

static T mpiScan_sum ( const T value,
const int  communicator,
const bool  exclusive = false 
)
inlinestatic

Inclusive/exclusive sum scan returning result.

See UPstream::mpiScan for notes about the behaviour

Parameters
exclusiveUse exclusive scan (MPI_Exscan vs MPI_Scan)

Definition at line 2541 of file UPstream.H.

◆ mpiExscan_sum() [2/2]

static T mpiExscan_sum ( const T value,
const int  communicator 
)
inlinestatic

Exclusive sum scan returning result.

See UPstream::mpiScan for notes about the behaviour

Definition at line 2541 of file UPstream.H.

◆ reduceAnd()

void reduceAnd ( bool &  value,
const int  communicator = UPstream::worldComm 
)
static

Logical (and) reduction (MPI_AllReduce)

For non-parallel : do nothing

Definition at line 28 of file UPstreamReduce.C.

Referenced by Foam::reduce(), displacementPointSmoothingMotionSolver::relax(), displacementSmartPointSmoothingMotionSolver::relax(), Foam::returnReduceAnd(), and mappedPatchBase::upToDate().

Here is the caller graph for this function:

◆ reduceOr()

void reduceOr ( bool &  value,
const int  communicator = UPstream::worldComm 
)
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(), Foam::reduce(), and Foam::returnReduceOr().

Here is the caller graph for this function:

◆ find_first()

int find_first ( bool  condition,
int  communicator 
)
static

Locate the first rank for which the condition is true, or -1 if no ranks satisfy the condition.

Definition at line 1055 of file UPstream.C.

References UPstream::is_parallel(), UPstream::mpi_allreduce(), UPstream::myProcNo(), UPstream::nProcs(), UPstream::op_min, and UPstream::type_int32.

Here is the call graph for this function:

◆ find_last()

int find_last ( bool  condition,
int  communicator 
)
static

Locate the last rank for which the condition is true, or -1 if no ranks satisfy the condition.

Definition at line 1087 of file UPstream.C.

References UPstream::is_parallel(), UPstream::mpi_allreduce(), UPstream::myProcNo(), UPstream::op_max, and UPstream::type_int32.

Here is the call graph for this function:

◆ allocateCommunicator() [1/2]

static label allocateCommunicator ( const label  parent,
const labelRange subRanks,
const bool  withComponents = true 
)
inlinestatic
Deprecated:
(2025-02) prefer newCommunicator

Definition at line 2589 of file UPstream.H.

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

Here is the call graph for this function:

◆ allocateCommunicator() [2/2]

static label allocateCommunicator ( const label  parent,
const labelUList subRanks,
const bool  withComponents = true 
)
inlinestatic
Deprecated:
(2025-02) prefer newCommunicator

Definition at line 2603 of file UPstream.H.

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

Here is the call graph for this function:

◆ waitRequests() [3/3]

static void waitRequests ( )
inlinestatic

Wait for all requests to finish.

Deprecated:
(2023-01) Probably not what you want. Should normally be restricted to a particular starting request.

Definition at line 2619 of file UPstream.H.

References UPstream::waitRequests().

Referenced by motionSmootherAlgo::correctBoundaryConditions(), faceAreaPairGAMGAgglomeration::movePoints(), decomposedBlockData::readBlocks(), motionSmootherAlgo::setDisplacementPatchFields(), syncTools::syncBoundaryFaceList(), syncTools::syncFaceList(), UPstream::waitRequests(), OFstreamCollator::write(), and decomposedBlockData::writeBlocks().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ gather()

static void gather ( const Type *  send,
int  count,
Type *  recv,
const UList< int > &  counts,
const UList< int > &  offsets,
const int  comm = UPstream::worldComm 
)
inlinestatic
Deprecated:
(2025-02) prefer mpiGatherv

Definition at line 2627 of file UPstream.H.

References Foam::BitOps::count(), and UPstream::mpiGatherv().

Here is the call graph for this function:

◆ scatter()

static void scatter ( const Type *  send,
const UList< int > &  counts,
const UList< int > &  offsets,
Type *  recv,
int  count,
const int  comm = UPstream::worldComm 
)
inlinestatic
Deprecated:
(2025-02) prefer mpiScatterv

Definition at line 2645 of file UPstream.H.

References Foam::BitOps::count(), and UPstream::mpiScatterv().

Here is the call graph for this function:

Member Data Documentation

◆ commsTypeNames

◆ nodeCommsControl_

int nodeCommsControl_
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 1020 of file UPstream.H.

Referenced by UPstream::printNodeCommsControl().

◆ nodeCommsMin_

int nodeCommsMin_
static

Minimum number of nodes before topology-aware routines are enabled.

<= 2 : always >= 3 : when there are more than N nodes

Definition at line 1028 of file UPstream.H.

Referenced by UPstream::printNodeCommsControl().

◆ topologyControl_

int topologyControl_
static

Selection of topology-aware routines as a bitmask combination of the topoControls enumerations.

Definition at line 1034 of file UPstream.H.

Referenced by UPstream::printTopoControl(), and UPstream::usingTopoControl().

◆ floatTransfer

bool floatTransfer
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 1049 of file UPstream.H.

Referenced by processorGAMGInterfaceField::initInterfaceMatrixUpdate(), argList::parse(), and processorGAMGInterfaceField::updateInterfaceMatrix().

◆ nProcsSimpleSum

int nProcsSimpleSum
static

Number of processors to change from linear to tree communication.

Definition at line 1054 of file UPstream.H.

Referenced by argList::parse(), and UPstream::whichCommunication().

◆ nProcsNonblockingExchange

int nProcsNonblockingExchange
static

Number of processors to change to nonBlocking consensual exchange (NBX). Ignored for zero or negative values.

Definition at line 1060 of file UPstream.H.

Referenced by argList::parse().

◆ nPollProcInterfaces

int nPollProcInterfaces
static

Number of polling cycles in processor updates.

Definition at line 1065 of file UPstream.H.

Referenced by argList::parse().

◆ defaultCommsType

◆ maxCommsSize

int maxCommsSize
static

Optional maximum message size (bytes)

Definition at line 1075 of file UPstream.H.

Referenced by Foam::broadcastFile_single(), and argList::parse().

◆ tuning_NBX_

int tuning_NBX_
static

Tuning parameters for non-blocking exchange (NBX)

Definition at line 1080 of file UPstream.H.

Referenced by argList::parse().

◆ mpiBufferSize

const int mpiBufferSize
static

MPI buffer-size (bytes)

Definition at line 1085 of file UPstream.H.

Referenced by attachOurBuffers().

◆ worldComm

Foam::label worldComm
static

Communicator for all ranks. May differ from commGlobal() if local worlds are in use.

Definition at line 1094 of file UPstream.H.

Referenced by regIOobject::addWatch(), masterUncollatedFileOperation::addWatch(), bitSet::allGather(), bitSet::broadcast(), Foam::calcCellCellsImpl(), surfaceNoise::calculate(), multiWorldConnections::comms(), UPstream::commWorld(), masterUncollatedFileOperation::dirPath(), masterUncollatedFileOperation::filePath(), masterUncollatedFileOperation::findInstance(), masterUncollatedFileOperation::findTimes(), masterUncollatedFileOperation::findWatch(), bitSet::gatherValues(), multiWorldConnections::getCommById(), multiWorldConnections::getCommByName(), Foam::getCommPattern(), masterUncollatedFileOperation::getFile(), fileOperation::getGlobalHostIORanks(), Foam::getSelectedProcs(), masterUncollatedFileOperation::getState(), masterUncollatedFileOperation::highResLastModified(), viewFactor::initialise(), surfaceNoise::initialise(), globalIndex::inplaceToGlobal(), globalIndex::isLocal(), masterUncollatedFileOperation::lastModified(), globalIndex::localEnd(), globalIndex::localSize(), globalIndex::localStart(), fileOperation::lookupAndCacheProcessorsPath(), messageStream::masterStream(), globalIndex::maxNonLocalSize(), fvMeshTools::newMesh(), argList::parse(), UPstream::printNodeCommsControl(), fileOperation::printRanks(), globalIndex::range(), uncollatedFileOperation::read(), masterUncollatedFileOperation::read(), lumpedPointState::readData(), masterUncollatedFileOperation::readHeader(), masterUncollatedFileOperation::readObjects(), masterUncollatedFileOperation::readStream(), surfaceNoise::readSurfaceData(), exprValueFieldTag::reduce(), bitSet::reduceAnd(), bitSet::reduceOr(), masterUncollatedFileOperation::removeWatch(), Time::setMonitoring(), masterUncollatedFileOperation::setUnmodified(), globalIndex::slice(), messageStream::stream(), fileOperation::subRanks(), surfaceNoise::surfaceAverage(), masterUncollatedFileOperation::sync(), fileOperation::sync(), globalIndex::toGlobal(), globalIndex::toLocal(), masterUncollatedFileOperation::updateStates(), globalIndex::whichProcID(), and surfaceNoise::writeSurfaceData().

◆ warnComm

Foam::label warnComm
static

Debugging: warn for use of any communicator differing from warnComm.

Definition at line 1099 of file UPstream.H.

Referenced by UPstream::commWarn(), messageStream::masterStream(), Foam::reduce(), and Foam::PstreamGlobals::warnCommunicator().


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