Output inter-processor communications stream using MPI send/recv etc. - operating on external buffer. More...

Inheritance diagram for UOPstream:

Collaboration diagram for UOPstream:

Public Member Functions
	UOPstream (const UPstream::commsTypes commsType, const int toProcNo, DynamicList< char > &sendBuf, const int tag=UPstream::msgType(), const int communicator=UPstream::worldComm, const bool sendAtDestruct=true, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
	Construct given process index to write to using the given attached send buffer, optional communication characteristics and IO format. More...

	UOPstream (const int toProcNo, PstreamBuffers &buffers)
	Construct given buffers. More...

	UOPstream (DynamicList< char > &sendBuf, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
	Construct for writing into a standalone buffer. Data transfer is handled externally by the caller. More...

virtual	~UOPstream ()
	Destructor, usually sends buffer on destruct. More...

bool	send ()
	Send buffer contents now and not in destructor [advanced usage]. Returns true on success. More...

virtual bool	write (const token &tok) override
	Use all write methods from base class. More...

virtual Ostream &	write (const char c) override
	Use all write methods from base class. More...

virtual Ostream &	write (const char *str) override
	Use all write methods from base class. More...

virtual Ostream &	write (const word &str) override
	Use all write methods from base class. More...

virtual Ostream &	write (const std::string &str) override
	Use all write methods from base class. More...

virtual Ostream &	write (const int32_t val) override
	Use all write methods from base class. More...

virtual Ostream &	write (const int64_t val) override
	Use all write methods from base class. More...

virtual Ostream &	write (const float val) override
	Use all write methods from base class. More...

virtual Ostream &	write (const double val) override
	Use all write methods from base class. More...

virtual Ostream &	write (const char *data, std::streamsize count) override
	Use all write methods from base class. More...

Public Member Functions inherited from UOPstreamBase
virtual	~UOPstreamBase ()
	Destructor. More...

virtual std::ios_base::fmtflags	flags () const override
	Return current stream flags. Dummy for parallel stream, returns 0. More...

virtual std::ios_base::fmtflags	flags (std::ios_base::fmtflags) override
	Set stream flags, return old stream flags. Dummy for parallel stream, returns 0. More...

virtual bool	write (const token &tok) override
	Write token to stream or otherwise handle it. More...

virtual Ostream &	write (const char c) override
	Write single character. Whitespace is suppressed. More...

virtual Ostream &	writeQuoted (const char *str, std::streamsize len, const bool quoted=true) override
	Write character/string content, with/without surrounding quotes. More...

virtual Ostream &	write (const char *str) override
	Write the word-characters of a character string. More...

virtual Ostream &	write (const word &str) override
	Write word. More...

virtual Ostream &	write (const std::string &str) override
	Write string. More...

virtual Ostream &	write (const int32_t val) override
	Write int32_t as a label. More...

virtual Ostream &	write (const int64_t val) override
	Write int64_t as a label. More...

virtual Ostream &	write (const float val) override
	Write float. More...

virtual Ostream &	write (const double val) override
	Write double. More...

virtual Ostream &	write (const char *data, std::streamsize count) override
	Write binary block with 8-byte alignment. More...

virtual Ostream &	writeRaw (const char *data, std::streamsize count) override
	Low-level raw binary output. More...

virtual bool	beginRawWrite (std::streamsize count) override
	Begin marker for low-level raw binary output. More...

virtual bool	endRawWrite () override
	End marker for low-level raw binary output. More...

virtual void	indent () override
	Add indentation characters. More...

virtual void	flush () override
	Flush stream. More...

virtual void	endl () override
	Add newline and flush stream. More...

virtual char	fill () const override
	Get the current padding character. More...

virtual char	fill (const char) override
	Set padding character for formatted field up to field width. More...

virtual int	width () const override
	Get width of output field. More...

virtual int	width (const int) override
	Set width of output field. More...

virtual int	precision () const override
	Get precision of output field. More...

virtual int	precision (const int) override
	Set precision of output field. More...

virtual void	rewind ()
	Rewind the send buffer for overwriting. More...

void	print (Ostream &os) const override
	Print stream description to Ostream. More...

virtual Ostream &	writeQuoted (const char *str, std::streamsize len, const bool quoted=true)=0
	Inherit write methods from Ostream. More...

virtual Ostream &	writeQuoted (const std::string &str, const bool quoted=true)
	Inherit write methods from Ostream. More...

Public Member Functions inherited from UPstream
	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...

Public Member Functions inherited from Ostream
	Ostream (const Ostream &)=default
	Copy construct. More...

virtual	~Ostream ()=default
	Destructor. More...

	Ostream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option. More...

	Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format (uncompressed) More...

virtual Ostream &	writeQuoted (const std::string &str, const bool quoted=true)
	Write string content, with/without surrounding quotes. More...

virtual Ostream &	write (const keyType &kw)
	Write keyType. More...

unsigned short	indentSize () const noexcept
	Return indent size (spaces per level) More...

unsigned short	indentSize (unsigned short val) noexcept
	Change indent size (spaces per level), return old value. More...

unsigned short	indentLevel () const noexcept
	Return the indent level. More...

unsigned short	indentLevel (unsigned short val) noexcept
	Change the indent level, return old value. More...

void	incrIndent () noexcept
	Increment the indent level. More...

void	decrIndent ()
	Decrement the indent level. More...

virtual Ostream &	writeKeyword (const keyType &kw)
	Write the keyword followed by an appropriate indentation. More...

virtual Ostream &	beginBlock (const keyType &kw)
	Write begin block group with the given name. More...

virtual Ostream &	beginBlock ()
	Write begin block group without a name. More...

virtual Ostream &	endBlock ()
	Write end block group. More...

virtual Ostream &	endEntry ()
	Write end entry (';') followed by newline. More...

template<class T >
Ostream &	writeEntry (const keyType &key, const T &value)
	Write a keyword/value entry. More...

template<class T >
Ostream &	writeEntryIfDifferent (const word &key, const T &value1, const T &value2)
	Write a keyword/value entry only when the two values differ. More...

Ostream &	operator() () const
	Return a non-const reference to const Ostream. More...

unsigned short &	indentLevel () noexcept
	Access to indent level. More...

unsigned short &	indentSize () noexcept
	Access to indent size. More...

Public Member Functions inherited from IOstream
	IOstream (const IOstream &)=default
	Copy construct. More...

virtual	~IOstream ()=default
	Destructor. More...

	IOstream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option. More...

	IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format, version (compression) More...

virtual const fileName &	name () const
	The name of the stream. More...

fileName	relativeName () const
	Return the name of the stream relative to the current case. More...

virtual bool	check (const char *operation) const
	Check IOstream status for given operation. More...

bool	fatalCheck (const char *operation) const
	Check IOstream status for given operation. More...

bool	opened () const noexcept
	True if stream has been opened. More...

bool	closed () const noexcept
	True if stream is closed. More...

bool	good () const noexcept
	True if next operation might succeed. More...

bool	eof () const noexcept
	True if end of input seen. More...

bool	fail () const noexcept
	True if next operation will fail. More...

bool	bad () const noexcept
	True if stream is corrupted. More...

	operator bool () const noexcept
	True if the stream has not failed. More...

bool	operator! () const noexcept
	True if the stream has failed. More...

unsigned	labelByteSize () const noexcept
	The sizeof (label) in bytes associated with the stream. More...

unsigned	scalarByteSize () const noexcept
	The sizeof (scalar) in bytes associated with the stream. More...

void	setLabelByteSize (unsigned nbytes) noexcept
	Set the sizeof (label) in bytes associated with the stream. More...

void	setScalarByteSize (unsigned nbytes) noexcept
	Set the sizeof (scalar) in bytes associated with the stream. More...

template<class T = label>
std::enable_if_t< std::is_integral_v< T >, bool >	checkLabelSize () const noexcept
	Check if the label byte-size associated with the stream is the same as the given type. More...

template<class T = scalar>
std::enable_if_t< std::is_floating_point_v< T >, bool >	checkScalarSize () const noexcept
	Check if the scalar byte-size associated with the stream is the same as the given type. More...

label	lineNumber () const noexcept
	Const access to the current stream line number. More...

label &	lineNumber () noexcept
	Non-const access to the current stream line number. More...

label	lineNumber (const label num) noexcept
	Set the stream line number. More...

void	setEof () noexcept
	Set stream state as reached 'eof'. More...

void	setFail () noexcept
	Set stream state as 'failed'. More...

void	setBad () noexcept
	Set stream state to be 'bad'. More...

std::ios_base::fmtflags	setf (std::ios_base::fmtflags f)
	Set stream flag(s), return old stream flags. More...

std::ios_base::fmtflags	setf (const std::ios_base::fmtflags f, const std::ios_base::fmtflags mask)
	Set stream flag(s) with mask, return old stream flags. More...

std::ios_base::fmtflags	unsetf (std::ios_base::fmtflags f)
	Unset stream flags, return old stream flags. More...

void	print (Ostream &os, const int streamState) const
	Print information about the stream state bits. More...

InfoProxy< IOstream >	info () const noexcept
	Return info proxy, used to print IOstream information to a stream. More...

Public Member Functions inherited from IOstreamOption
constexpr	IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	Default construct (ASCII, UNCOMPRESSED, currentVersion) or construct with format, compression. More...

constexpr	IOstreamOption (streamFormat fmt, compressionType comp, versionNumber ver) noexcept
	Construct from components (format, compression, version) More...

constexpr	IOstreamOption (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	Construct from components (format, version, compression) More...

	IOstreamOption (const IOstreamOption &opt, streamFormat fmt) noexcept
	Copy construct with change of format. More...

streamFormat	format () const noexcept
	Get the current stream format. More...

streamFormat	format (const streamFormat fmt) noexcept
	Set the stream format. More...

streamFormat	format (const word &formatName)
	Set the stream format from string value. More...

compressionType	compression () const noexcept
	Get the stream compression. More...

compressionType	compression (const compressionType comp) noexcept
	Set the stream compression. More...

compressionType	compression (const word &compName)
	Set the stream compression from string value. More...

versionNumber	version () const noexcept
	Get the stream version. More...

versionNumber	version (const versionNumber ver) noexcept
	Set the stream version. More...

versionNumber	version (const token &tok)
	Set the stream version from token. More...

Static Public Member Functions
template<class Type >
static bool	write (const UPstream::commsTypes commsType, const int toProcNo, const Type buffer, std::streamsize count, const int tag=UPstream::msgType(), const int communicator=UPstream::worldComm, UPstream::Request req=nullptr, const UPstream::sendModes sendMode=UPstream::sendModes::normal)
	Write buffer contents (contiguous types only) to given processor. More...

template<class Type >
static bool	write (UPstream::Request &req, const int toProcNo, const Type *buffer, std::streamsize count, const int tag=UPstream::msgType(), const int communicator=UPstream::worldComm, const UPstream::sendModes sendMode=UPstream::sendModes::normal)
	Write buffer contents (contiguous types only) to given processor. More...

template<class Type >
static bool	write (const UPstream::commsTypes commsType, const int toProcNo, const UList< Type > &buffer, const int tag=UPstream::msgType(), const int communicator=UPstream::worldComm, UPstream::Request *req=nullptr, const UPstream::sendModes sendMode=UPstream::sendModes::normal)
	Send UList contiguous contents to given processor. More...

template<class Type >
static bool	write (const UPstream::commsTypes commsType, const int toProcNo, const SubList< Type > buffer, const int tag=UPstream::msgType(), const int communicator=UPstream::worldComm, UPstream::Request *req=nullptr, const UPstream::sendModes sendMode=UPstream::sendModes::normal)
	Send SubList contiguous contents to given processor. More...

template<class Type >
static bool	write (UPstream::Request &req, const int toProcNo, const UList< Type > &buffer, const int tag=UPstream::msgType(), const int communicator=UPstream::worldComm, const UPstream::sendModes sendMode=UPstream::sendModes::normal)
	Send UList contiguous contents (non-blocking) to given processor. More...

template<class Type >
static bool	write (UPstream::Request &req, const int toProcNo, const SubList< Type > buffer, const int tag=UPstream::msgType(), const int communicator=UPstream::worldComm, const UPstream::sendModes sendMode=UPstream::sendModes::normal)
	Send SubList contiguous contents (non-blocking) to given processor. More...

Static Public Member Functions inherited from UPstream
static bool	usingTopoControl (UPstream::topoControls ctrl) noexcept
	Test for selection of given topology-aware routine. More...

static constexpr int	commGlobal () noexcept
	Communicator for all ranks, irrespective of any local worlds. More...

static constexpr int	commSelf () noexcept
	Communicator within the current rank only. More...

static int	commConstWorld () noexcept
	Communicator for all ranks (respecting any local worlds). More...

static label	commWorld () noexcept
	Communicator for all ranks (respecting any local worlds) More...

static label	commWorld (const label communicator) noexcept
	Set world communicator. Negative values are a no-op. More...

static label	commWarn (const label communicator) noexcept
	Alter communicator debugging setting. Warns for use of any communicator differing from specified. Negative values disable. More...

static label	nComms () noexcept
	Number of currently defined communicators. More...

static void	printCommTree (int communicator, bool linear=false)
	Debugging: print the communication tree. More...

static int	commInterNode () noexcept
	Communicator between nodes/hosts (respects any local worlds) More...

static int	commLocalNode () noexcept
	Communicator within the node/host (respects any local worlds) More...

static bool	hasNodeCommunicators () noexcept
	Both inter-node and local-node communicators have been created. More...

static bool	usingNodeComms (const int communicator)
	True if node topology-aware routines have been enabled, it is running in parallel, the starting point is the world-communicator and it is not an odd corner case (ie, all processes on one node, all processes on different nodes) More...

static label	newCommunicator (const label parent, const labelRange &subRanks, const bool withComponents=true)
	Create new communicator with sub-ranks on the parent communicator. More...

static label	newCommunicator (const label parent, const labelUList &subRanks, const bool withComponents=true)
	Create new communicator with sub-ranks on the parent communicator. More...

static label	dupCommunicator (const label parent)
	Duplicate the parent communicator. More...

static label	splitCommunicator (const label parent, const int colour, const bool two_step=true)
	Allocate a new communicator by splitting the parent communicator on the given colour. More...

static void	freeCommunicator (const label communicator, const bool withComponents=true)
	Free a previously allocated communicator. More...

static int	baseProcNo (label comm, int procID)
	Return physical processor number (i.e. processor number in worldComm) given communicator and processor. More...

static label	procNo (const label comm, const int baseProcID)
	Return processor number in communicator (given physical processor number) (= reverse of baseProcNo) More...

static label	procNo (const label comm, const label currentComm, const int currentProcID)
	Return processor number in communicator (given processor number and communicator) More...

static void	addValidParOptions (HashTable< string > &validParOptions)
	Add the valid option this type of communications library adds/requires on the command line. More...

static bool	init (int &argc, char **&argv, const bool needsThread)
	Initialisation function called from main. More...

static bool	initNull ()
	Special purpose initialisation function. More...

static void	barrier (const int communicator, UPstream::Request *req=nullptr)
	Impose a synchronisation barrier (optionally non-blocking) More...

static void	send_done (const int toProcNo, const int communicator, const int tag=UPstream::msgType()+1970)
	Impose a point-to-point synchronisation barrier by sending a zero-byte "done" message to given rank. More...

static int	wait_done (const int fromProcNo, const int communicator, const int tag=UPstream::msgType()+1970)
	Impose a point-to-point synchronisation barrier by receiving a zero-byte "done" message from given rank. More...

static std::pair< int, int64_t >	probeMessage (const UPstream::commsTypes commsType, const int fromProcNo, const int tag=UPstream::msgType(), const int communicator=worldComm)
	Probe for an incoming message. More...

static void	printNodeCommsControl (Ostream &os)
	Report the node-communication settings. More...

static void	printTopoControl (Ostream &os)
	Report the topology routines settings. More...

static label	nRequests () noexcept
	Number of outstanding requests (on the internal list of requests) More...

static void	resetRequests (const label n)
	Truncate outstanding requests to given length, which is expected to be in the range [0 to nRequests()]. More...

static void	addRequest (UPstream::Request &req)
	Transfer the (wrapped) MPI request to the internal global list and invalidate the parameter (ignores null requests) More...

static void	cancelRequest (const label i)
	Non-blocking comms: cancel and free outstanding request. Corresponds to MPI_Cancel() + MPI_Request_free() More...

static void	cancelRequest (UPstream::Request &req)
	Non-blocking comms: cancel and free outstanding request. Corresponds to MPI_Cancel() + MPI_Request_free() More...

static void	cancelRequests (UList< UPstream::Request > &requests)
	Non-blocking comms: cancel and free outstanding requests. Corresponds to MPI_Cancel() + MPI_Request_free() More...

static void	removeRequests (const label pos, label len=-1)
	Non-blocking comms: cancel/free outstanding requests (from position onwards) and remove from internal list of requests. Corresponds to MPI_Cancel() + MPI_Request_free() More...

static void	freeRequest (UPstream::Request &req)
	Non-blocking comms: free outstanding request. Corresponds to MPI_Request_free() More...

static void	freeRequests (UList< UPstream::Request > &requests)
	Non-blocking comms: free outstanding requests. Corresponds to MPI_Request_free() More...

static void	waitRequests (const label pos, label len=-1)
	Wait until all requests (from position onwards) have finished. Corresponds to MPI_Waitall() More...

static void	waitRequests (UList< UPstream::Request > &requests)
	Wait until all requests have finished. Corresponds to MPI_Waitall() More...

static bool	waitAnyRequest (const label pos, label len=-1)
	Wait until any request (from position onwards) has finished. Corresponds to MPI_Waitany() More...

static bool	waitSomeRequests (const label pos, label len=-1, DynamicList< int > *indices=nullptr)
	Wait until some requests (from position onwards) have finished. Corresponds to MPI_Waitsome() More...

static bool	waitSomeRequests (UList< UPstream::Request > &requests, DynamicList< int > *indices=nullptr)
	Wait until some requests have finished. Corresponds to MPI_Waitsome() More...

static label	waitAnyRequest (UList< UPstream::Request > &requests)
	Wait until any request has finished and return its index. Corresponds to MPI_Waitany() More...

static void	waitRequest (const label i)
	Wait until request i has finished. Corresponds to MPI_Wait() More...

static void	waitRequest (UPstream::Request &req)
	Wait until specified request has finished. Corresponds to MPI_Wait() More...

static bool	finishedRequest (const label i)
	Non-blocking comms: has request i finished? Corresponds to MPI_Test() More...

static bool	finishedRequest (UPstream::Request &req)
	Non-blocking comms: has request finished? Corresponds to MPI_Test() More...

static bool	finishedRequests (const label pos, label len=-1)
	Non-blocking comms: have all requests (from position onwards) finished? Corresponds to MPI_Testall() More...

static bool	finishedRequests (UList< UPstream::Request > &requests)
	Non-blocking comms: have all requests finished? Corresponds to MPI_Testall() More...

static bool	finishedRequestPair (label &req0, label &req1)
	Non-blocking comms: have both requests finished? Corresponds to pair of MPI_Test() More...

static void	waitRequestPair (label &req0, label &req1)
	Non-blocking comms: wait for both requests to finish. Corresponds to pair of MPI_Wait() More...

static bool	parRun (const bool on) noexcept
	Set as parallel run on/off. More...

static bool &	parRun () noexcept
	Test if this a parallel run. More...

static bool	haveThreads () noexcept
	Have support for threads. More...

static constexpr int	masterNo () noexcept
	Relative rank for the master process - is always 0. More...

static label	nProcs (const label communicator=worldComm)
	Number of ranks in parallel run (for given communicator). It is 1 for serial run. More...

static int	myProcNo (const label communicator=worldComm)
	Rank of this process in the communicator (starting from masterNo()). Negative if the process is not a rank in the communicator. More...

static bool	master (const label communicator=worldComm)
	True if process corresponds to the master rank in the communicator. More...

static bool	is_rank (const label communicator=worldComm)
	True if process corresponds to any rank (master or sub-rank) in the given communicator. More...

static bool	is_subrank (const label communicator=worldComm)
	True if process corresponds to a sub-rank in the given communicator. More...

static bool	is_parallel (const label communicator=worldComm)
	True if parallel algorithm or exchange is required. More...

static int	numNodes () noexcept
	The number of shared/host nodes in the (const) world communicator. More...

static label	parent (int communicator)
	The parent communicator. More...

static List< int > &	procID (int communicator)
	The list of ranks within a given communicator. More...

static const wordList &	allWorlds () noexcept
	All worlds. More...

static const labelList &	worldIDs () noexcept
	The indices into allWorlds for all processes. More...

static label	myWorldID ()
	My worldID. More...

static const word &	myWorld ()
	My world. More...

static rangeType	allProcs (const label communicator=worldComm)
	Range of process indices for all processes. More...

static rangeType	subProcs (const label communicator=worldComm)
	Range of process indices for sub-processes. More...

static const List< int > &	interNode_offsets ()
	Processor offsets corresponding to the inter-node communicator. More...

static const rangeType &	localNode_parentProcs ()
	The range (start/size) of the commLocalNode ranks in terms of the (const) world communicator processors. More...

static const commsStructList &	linearCommunication (int communicator)
	Linear communication schedule (special case) for given communicator. More...

static const commsStructList &	treeCommunication (int communicator)
	Tree communication schedule (standard case) for given communicator. More...

static const commsStructList &	whichCommunication (const int communicator, bool linear=false)
	Communication schedule for all-to-master (proc 0) as linear/tree/none with switching based on UPstream::nProcsSimpleSum, the is_parallel() state and the optional `linear` parameter. More...

static int &	msgType () noexcept
	Message tag of standard messages. More...

static int	msgType (int val) noexcept
	Set the message tag for standard messages. More...

static int	incrMsgType (int val=1) noexcept
	Increment the message tag for standard messages. More...

static void	shutdown (int errNo=0)
	Shutdown (finalize) MPI as required. More...

static void	abort (int errNo=1)
	Call MPI_Abort with no other checks or cleanup. More...

static void	exit (int errNo=1)
	Shutdown (finalize) MPI as required and exit program with errNo. More...

static void	allToAll (const UList< int32_t > &sendData, UList< int32_t > &recvData, const int communicator=UPstream::worldComm)
	Exchange `int32_t` data with all ranks in communicator. More...

static void	allToAllConsensus (const UList< int32_t > &sendData, UList< int32_t > &recvData, const int tag, const int communicator=UPstream::worldComm)
	Exchange non-zero `int32_t` data between ranks [NBX]. More...

static void	allToAllConsensus (const Map< int32_t > &sendData, Map< int32_t > &recvData, const int tag, const int communicator=UPstream::worldComm)
	Exchange `int32_t` data between ranks [NBX]. More...

static Map< int32_t >	allToAllConsensus (const Map< int32_t > &sendData, const int tag, const int communicator=UPstream::worldComm)
	Exchange `int32_t` data between ranks [NBX]. More...

static void	allToAll (const UList< int64_t > &sendData, UList< int64_t > &recvData, const int communicator=UPstream::worldComm)
	Exchange `int64_t` data with all ranks in communicator. More...

static void	allToAllConsensus (const UList< int64_t > &sendData, UList< int64_t > &recvData, const int tag, const int communicator=UPstream::worldComm)
	Exchange non-zero `int64_t` data between ranks [NBX]. More...

static void	allToAllConsensus (const Map< int64_t > &sendData, Map< int64_t > &recvData, const int tag, const int communicator=UPstream::worldComm)
	Exchange `int64_t` data between ranks [NBX]. More...

static Map< int64_t >	allToAllConsensus (const Map< int64_t > &sendData, const int tag, const int communicator=UPstream::worldComm)
	Exchange `int64_t` data between ranks [NBX]. More...

template<class Type >
static void	mpiGather (const Type sendData, Type recvData, int count, const int communicator=UPstream::worldComm)
	Receive identically-sized (contiguous) data from all ranks. More...

template<class Type >
static void	mpiScatter (const Type sendData, Type recvData, int count, const int communicator=UPstream::worldComm)
	Send identically-sized (contiguous) data to all ranks. More...

template<class Type >
static void	mpiAllGather (Type *allData, int count, const int communicator=UPstream::worldComm)
	Gather/scatter identically-sized data. More...

template<class Type >
static void	mpiGatherv (const Type sendData, int sendCount, Type recvData, const UList< int > &recvCounts, const UList< int > &recvOffsets, const int communicator=UPstream::worldComm)
	Receive variable length data from all ranks. More...

template<class Type >
static void	mpiScatterv (const Type sendData, const UList< int > &sendCounts, const UList< int > &sendOffsets, Type recvData, int recvCount, const int communicator=UPstream::worldComm)
	Send variable length data to all ranks. More...

template<class T >
static List< T >	allGatherValues (const T &localValue, const int communicator=UPstream::worldComm)
	Allgather individual values into list locations. More...

template<class T >
static List< T >	listGatherValues (const T &localValue, const int communicator=UPstream::worldComm)
	Gather individual values into list locations. More...

template<class T >
static T	listScatterValues (const UList< T > &allValues, const int communicator=UPstream::worldComm)
	Scatter individual values from list locations. More...

template<class Type >
static bool	broadcast (Type *buffer, std::streamsize count, const int communicator)
	Broadcast buffer contents (contiguous types), from rank=0 to all ranks. The sizes must match on all processes. More...

template<class T >
static void	mpiReduce (T values[], int count, const UPstream::opCodes opCodeId, const int communicator)
	MPI_Reduce (blocking) for known operators. More...

template<class T >
static void	mpiAllReduce (T values[], int count, const UPstream::opCodes opCodeId, const int communicator)
	MPI_Allreduce (blocking) for known operators. More...

template<class T >
static void	mpiAllReduce (T values[], int count, const UPstream::opCodes opCodeId, const int communicator, UPstream::Request &req)
	MPI_Iallreduce (non-blocking) for known operators. More...

static void	reduceAnd (bool &value, const int communicator=worldComm)
	Logical (and) reduction (MPI_AllReduce) More...

static void	reduceOr (bool &value, const int communicator=worldComm)
	Logical (or) reduction (MPI_AllReduce) More...

static label	allocateCommunicator (const label parent, const labelRange &subRanks, const bool withComponents=true)
	Create new communicator with sub-ranks on the parent communicator. More...

static label	allocateCommunicator (const label parent, const labelUList &subRanks, const bool withComponents=true)
	Create new communicator with sub-ranks on the parent communicator. More...

static label	commInterHost () noexcept
	Communicator between nodes (respects any local worlds) More...

static label	commIntraHost () noexcept
	Communicator within the node (respects any local worlds) More...

static void	waitRequests ()
	Wait for all requests to finish. More...

template<class Type >
static void	gather (const Type send, int count, Type recv, const UList< int > &counts, const UList< int > &offsets, const int comm=UPstream::worldComm)

template<class Type >
static void	scatter (const Type send, const UList< int > &counts, const UList< int > &offsets, Type recv, int count, const int comm=UPstream::worldComm)

Static Public Member Functions inherited from IOstream
static unsigned int	defaultPrecision () noexcept
	Return the default precision. More...

static unsigned int	defaultPrecision (unsigned int prec) noexcept
	Reset the default precision. More...

static unsigned int	minPrecision (unsigned int prec) noexcept
	Set the minimum default precision. More...

Static Public Member Functions inherited from IOstreamOption
static floatFormat	floatFormatEnum (const word &fmtName, const floatFormat deflt=floatFormat::general)
	Lookup floatFormat enum corresponding to the string (general \| fixed \| scientific). More...

static floatFormat	floatFormatEnum (const word &key, const dictionary &dict, const floatFormat deflt=floatFormat::general)
	getOrDefault floatFormat from dictionary, warn only on bad enumeration. More...

static streamFormat	formatEnum (const word &fmtName, const streamFormat deflt=streamFormat::ASCII)
	Lookup streamFormat enum corresponding to the string (ascii \| binary). More...

static streamFormat	formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)
	getOrDefault streamFormat from dictionary, warn only on bad enumeration. More...

static compressionType	compressionEnum (const word &compName, const compressionType deflt=compressionType::UNCOMPRESSED)
	The compression enum corresponding to the string. More...

static compressionType	compressionEnum (const word &key, const dictionary &dict, const compressionType deflt=compressionType::UNCOMPRESSED)
	getOrDefault compressionType from dictionary, warn only on bad enumeration. More...

Additional Inherited Members
Public Types inherited from UPstream
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 Types inherited from IOstream
enum	streamAccess : char { CLOSED = 0, OPENED }
	Enumeration for stream open/closed state. More...

Public Types inherited from IOstreamOption
enum	streamFormat : char { ASCII = 0, BINARY }
	Data format (ascii \| binary) More...

enum	compressionType : char { UNCOMPRESSED = 0, COMPRESSED }
	Compression treatment (UNCOMPRESSED \| COMPRESSED) More...

enum	appendType : char { NO_APPEND = 0, APPEND_APP, APPEND_ATE, NON_APPEND = NO_APPEND, APPEND = APPEND_APP }
	File appending (NO_APPEND \| APPEND_APP \| APPEND_ATE) More...

enum	atomicType : char { NON_ATOMIC = 0, ATOMIC }
	Atomic operations (output) More...

enum	floatFormat : unsigned { general = unsigned(0), fixed = unsigned(std::ios_base::fixed), scientific = unsigned(std::ios_base::scientific) }
	Float formats (eg, time directory name formats) More...

Static Public Attributes inherited from UPstream
static const Enum< commsTypes >	commsTypeNames
	Enumerated names for the communication types. More...

static int	nodeCommsControl_
	Use of host/node topology-aware routines. More...

static int	nodeCommsMin_
	Minimum number of nodes before topology-aware routines are enabled. More...

static int	topologyControl_
	Selection of topology-aware routines as a bitmask combination of the topoControls enumerations. More...

static bool	floatTransfer
	Should compact transfer be used in which floats replace doubles reducing the bandwidth requirement at the expense of some loss in accuracy. More...

static int	nProcsSimpleSum
	Number of processors to change from linear to tree communication. More...

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

static int	nPollProcInterfaces
	Number of polling cycles in processor updates. More...

static commsTypes	defaultCommsType
	Default commsType. More...

static int	maxCommsSize
	Optional maximum message size (bytes) More...

static int	tuning_NBX_
	Tuning parameters for non-blocking exchange (NBX) More...

static const int	mpiBufferSize
	MPI buffer-size (bytes) More...

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

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

Static Public Attributes inherited from IOstream
static unsigned int	precision_
	Default precision. More...

Static Public Attributes inherited from IOstreamOption
static const Enum< floatFormat >	floatFormatNames
	Names for float formats (general, fixed, scientific) More...

static const Enum< streamFormat >	formatNames
	Stream format names (ascii, binary) More...

static const versionNumber	currentVersion
	The current version number (2.0) More...

Protected Member Functions inherited from UOPstreamBase
	UOPstreamBase (const UPstream::commsTypes commsType, const int toProcNo, DynamicList< char > &sendBuf, const int tag=UPstream::msgType(), const int communicator=UPstream::worldComm, const bool sendAtDestruct=true, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
	Construct given process index to write to using the given attached send buffer, optional communication characteristics and IO format. More...

	UOPstreamBase (const int toProcNo, PstreamBuffers &buffers)
	Construct given buffers. More...

	UOPstreamBase (DynamicList< char > &sendBuf, IOstreamOption::streamFormat fmt)
	Construct for externally obtained buffers. More...

Protected Member Functions inherited from IOstream
void	setOpened () noexcept
	Set stream opened. More...

void	setClosed () noexcept
	Set stream closed. More...

void	setState (std::ios_base::iostate state) noexcept
	Set stream state. More...

void	setGood () noexcept
	Set stream state to be good. More...

Static Protected Member Functions inherited from UPstream
static bool	mpi_broadcast (void *buf, std::streamsize count, const UPstream::dataTypes dataTypeId, const int communicator)
	Broadcast buffer contents from rank=0 to all ranks. The sizes must match on all processes. More...

static void	mpi_reduce (void values, int count, const UPstream::dataTypes dataTypeId, const UPstream::opCodes opCodeId, const int communicator, UPstream::Request req=nullptr)
	In-place reduction of `values` with result on rank 0. More...

static void	mpi_allreduce (void values, int count, const UPstream::dataTypes dataTypeId, const UPstream::opCodes opCodeId, const int communicator, UPstream::Request req=nullptr)
	In-place reduction of `values` with same result on all ranks. More...

static bool	mpi_send (const UPstream::commsTypes commsType, const void buf, std::streamsize count, const UPstream::dataTypes dataTypeId, const int toProcNo, const int tag, const int communicator, UPstream::Request req=nullptr, const UPstream::sendModes sendMode=UPstream::sendModes::normal)
	Send buffer contents of specified data type to given processor. More...

static std::streamsize	mpi_receive (const UPstream::commsTypes commsType, void buf, std::streamsize count, const UPstream::dataTypes dataTypeId, const int fromProcNo, const int tag, const int communicator, UPstream::Request req=nullptr)
	Receive buffer contents of specified data type from given processor. More...

static void	mpi_gather (const void sendData, void recvData, int count, const UPstream::dataTypes dataTypeId, const int communicator, UPstream::Request *req=nullptr)
	Receive identically-sized (contiguous) data from all ranks, placing the result on rank 0. More...

static void	mpi_scatter (const void sendData, void recvData, int count, const UPstream::dataTypes dataTypeId, const int communicator, UPstream::Request *req=nullptr)
	Send identically-sized (contiguous) data from rank 0 to all other ranks. More...

static void	mpi_allgather (void allData, int count, const UPstream::dataTypes dataTypeId, const int communicator, UPstream::Request req=nullptr)
	Gather/scatter identically-sized data. More...

static void	mpi_gatherv (const void sendData, int sendCount, void recvData, const UList< int > &recvCounts, const UList< int > &recvOffsets, const UPstream::dataTypes dataTypeId, const int communicator)
	Receive variable length data from all ranks, placing the result on rank 0. (caution: known to scale poorly) More...

static void	mpi_scatterv (const void sendData, const UList< int > &sendCounts, const UList< int > &sendOffsets, void recvData, int recvCount, const UPstream::dataTypes dataTypeId, const int communicator)
	Send variable length data from rank 0 to all ranks. (caution: known to scale poorly) More...

Protected Attributes inherited from UOPstreamBase
const int	toProcNo_
	Destination rank for the data. More...

const int	tag_
	Message tag for communication. More...

const int	comm_
	The communicator index. More...

bool	sendAtDestruct_
	Call bufferIPCsend on termination (in the destructor) More...

DynamicList< char > &	sendBuf_
	Reference to the send buffer data. More...

Protected Attributes inherited from Ostream
unsigned short	indentSize_ = 4
	Number of spaces per indent level. More...

unsigned short	indentLevel_ = 0
	Current indent level. More...

Protected Attributes inherited from IOstream
std::ios_base::iostate	ioState_
	Mirror of internal stream io state. More...

streamAccess	openClosed_
	The stream open/closed state. More...

unsigned char	sizeofLabel_
	The sizeof (label), possibly read from the header. More...

unsigned char	sizeofScalar_
	The sizeof (scalar), possibly read from the header. More...

label	lineNumber_
	The file line. More...

Static Protected Attributes inherited from Ostream
static constexpr const unsigned short	entryIndentation_ = 16
	Indentation of the entry from the start of the keyword. More...

Static Protected Attributes inherited from IOstream
static fileName	staticName_
	Name for any generic stream - normally treat as readonly. More...

Detailed Description

Output inter-processor communications stream using MPI send/recv etc. - operating on external buffer.

Definition at line 395 of file UOPstream.H.

Constructor & Destructor Documentation

◆ UOPstream() [1/3]

UOPstream	(	const UPstream::commsTypes	commsType,
		const int	toProcNo,
		DynamicList< char > &	sendBuf,
		const int	tag = `UPstream::msgType()`,
		const int	communicator = `UPstream::worldComm`,
		const bool	sendAtDestruct = `true`,
		IOstreamOption::streamFormat	fmt = `IOstreamOption::BINARY`
	)

Construct given process index to write to using the given attached send buffer, optional communication characteristics and IO format.

Definition at line 28 of file OPstreams.C.

◆ UOPstream() [2/3]

UOPstream	(	const int	toProcNo,
		PstreamBuffers &	buffers
	)

Construct given buffers.

Definition at line 42 of file OPstreams.C.

◆ UOPstream() [3/3]

UOPstream	(	DynamicList< char > &	sendBuf,
		IOstreamOption::streamFormat	fmt = `IOstreamOption::BINARY`
	)

explicit

Construct for writing into a standalone buffer. Data transfer is handled externally by the caller.

Definition at line 49 of file OPstreams.C.

◆ ~UOPstream()

~UOPstream ( )

virtual

Destructor, usually sends buffer on destruct.

Definition at line 93 of file OPstreams.C.

References Foam::abort(), Foam::FatalError, and FatalErrorInFunction.

Here is the call graph for this function:

Member Function Documentation

◆ send()

bool send ( )

Send buffer contents now and not in destructor [advanced usage]. Returns true on success.

Definition at line 84 of file OPstreams.C.

Referenced by LUscalarMatrix::LUscalarMatrix(), argList::parse(), mapDistributeBase::schedule(), OPstream::send(), syncTools::syncEdgeMap(), and syncTools::syncPointMap().

Here is the caller graph for this function:

◆ write() [1/16]

static bool write	(	const UPstream::commsTypes	commsType,
		const int	toProcNo,
		const Type *	buffer,
		std::streamsize	count,
		const int	tag = `UPstream::msgType()`,
		const int	communicator = `UPstream::worldComm`,
		UPstream::Request *	req = `nullptr`,
		const UPstream::sendModes	sendMode = `UPstream::sendModes::normal`
	)

static

Write buffer contents (contiguous types only) to given processor.

Returns: True on success

Parameters

[out]	req	request information (for non-blocking)
	sendMode	optional send mode (normal \| sync)

Referenced by processorGAMGInterfaceField::initInterfaceMatrixUpdate(), syncTools::syncBoundaryFaceList(), syncTools::syncFaceList(), OFstreamCollator::write(), and decomposedBlockData::writeBlocks().

Here is the caller graph for this function:

◆ write() [2/16]

static bool write	(	UPstream::Request &	req,
		const int	toProcNo,
		const Type *	buffer,
		std::streamsize	count,
		const int	tag = `UPstream::msgType()`,
		const int	communicator = `UPstream::worldComm`,
		const UPstream::sendModes	sendMode = `UPstream::sendModes::normal`
	)

inlinestatic

Write buffer contents (contiguous types only) to given processor.

Returns: True on success

Parameters

[out] req request information

◆ write() [3/16]

static bool write	(	const UPstream::commsTypes	commsType,
		const int	toProcNo,
		const UList< Type > &	buffer,
		const int	tag = `UPstream::msgType()`,
		const int	communicator = `UPstream::worldComm`,
		UPstream::Request *	req = `nullptr`,
		const UPstream::sendModes	sendMode = `UPstream::sendModes::normal`
	)

inlinestatic

Send UList contiguous contents to given processor.

Parameters

[out] req request information (for non-blocking)

◆ write() [4/16]

static bool write	(	const UPstream::commsTypes	commsType,
		const int	toProcNo,
		const SubList< Type >	buffer,
		const int	tag = `UPstream::msgType()`,
		const int	communicator = `UPstream::worldComm`,
		UPstream::Request *	req = `nullptr`,
		const UPstream::sendModes	sendMode = `UPstream::sendModes::normal`
	)

inlinestatic

Send SubList contiguous contents to given processor.

Parameters

[out] req request information (for non-blocking)

◆ write() [5/16]

static bool write	(	UPstream::Request &	req,
		const int	toProcNo,
		const UList< Type > &	buffer,
		const int	tag = `UPstream::msgType()`,
		const int	communicator = `UPstream::worldComm`,
		const UPstream::sendModes	sendMode = `UPstream::sendModes::normal`
	)

inlinestatic

Send UList contiguous contents (non-blocking) to given processor.

Parameters

[out] req request information

◆ write() [6/16]

static bool write	(	UPstream::Request &	req,
		const int	toProcNo,
		const SubList< Type >	buffer,
		const int	tag = `UPstream::msgType()`,
		const int	communicator = `UPstream::worldComm`,
		const UPstream::sendModes	sendMode = `UPstream::sendModes::normal`
	)

Foam::Ostream & write

override

Use all write methods from base class.

Definition at line 348 of file UOPstreamBase.C.

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

src/OpenFOAM/db/IOstreams/Pstreams/UOPstream.H
src/OpenFOAM/db/IOstreams/Pstreams/OPstreams.C
src/Pstream/dummy/UOPstreamWrite.C

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UOPstream() [1/3]

◆ UOPstream() [2/3]

◆ UOPstream() [3/3]

◆ ~UOPstream()

Member Function Documentation

◆ send()

◆ write() [1/16]

◆ write() [2/16]

◆ write() [3/16]

◆ write() [4/16]

◆ write() [5/16]

◆ write() [6/16]

◆ write() [7/16]

◆ write() [8/16]

◆ write() [9/16]

◆ write() [10/16]

◆ write() [11/16]

◆ write() [12/16]

◆ write() [13/16]

◆ write() [14/16]

◆ write() [15/16]

◆ write() [16/16]