OPstream Class Reference

Output inter-processor communications stream. More...

Inheritance diagram for OPstream:
[legend]
Collaboration diagram for OPstream:
[legend]

Public Member Functions

 OPstream (const commsTypes commsType, const int toProcNo, const label bufSize=0, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
 
- Public Member Functions inherited from Pstream
 ClassName ("Pstream")
 
 Pstream (const UPstream::commsTypes commsType, const label bufSize=0)
 Construct for given commsTypes, with optional buffer size. More...
 
- Public Member Functions inherited from UPstream
 ClassName ("UPstream")
 
 UPstream (const commsTypes commsType)
 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...
 
template<class T >
Foam::List< TlistGatherValues (const T &localValue, const label comm)
 
- Public Member Functions inherited from UOPstream
 UOPstream (const commsTypes commsType, const int toProcNo, DynamicList< char > &sendBuf, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm, const bool sendAtDestruct=true, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
 
 UOPstream (const int toProcNo, PstreamBuffers &buffers)
 Construct given buffers. More...
 
virtual ~UOPstream ()
 Destructor, usually sends buffer on destruct. More...
 
virtual bool write (const token &tok)
 Use all write methods from base class. More...
 
virtual Ostreamwrite (const char c)
 Use all write methods from base class. More...
 
virtual Ostreamwrite (const char *str)
 Use all write methods from base class. More...
 
virtual Ostreamwrite (const word &str)
 Use all write methods from base class. More...
 
virtual Ostreamwrite (const string &str)
 Use all write methods from base class. More...
 
virtual Ostreamwrite (const int32_t val)
 Use all write methods from base class. More...
 
virtual Ostreamwrite (const int64_t val)
 Use all write methods from base class. More...
 
virtual Ostreamwrite (const floatScalar val)
 Use all write methods from base class. More...
 
virtual Ostreamwrite (const doubleScalar val)
 Use all write methods from base class. More...
 
virtual Ostreamwrite (const char *data, std::streamsize count)
 Use all write methods from base class. More...
 
- Public Member Functions inherited from UOPstreamBase
virtual ~UOPstreamBase ()
 Destructor. More...
 
virtual ios_base::fmtflags flags () const
 Return flags of output stream. More...
 
virtual bool write (const token &tok)
 Write token to stream or otherwise handle it. More...
 
virtual Ostreamwrite (const char c)
 Write single character. Whitespace is suppressed. More...
 
virtual Ostreamwrite (const char *str)
 Write the word-characters of a character string. More...
 
virtual Ostreamwrite (const word &str)
 Write word. More...
 
virtual Ostreamwrite (const string &str)
 Write string. More...
 
virtual OstreamwriteQuoted (const std::string &str, const bool quoted=true)
 Write std::string surrounded by quotes. More...
 
virtual Ostreamwrite (const int32_t val)
 Write int32_t as a label. More...
 
virtual Ostreamwrite (const int64_t val)
 Write int64_t as a label. More...
 
virtual Ostreamwrite (const floatScalar val)
 Write floatScalar. More...
 
virtual Ostreamwrite (const doubleScalar val)
 Write doubleScalar. More...
 
virtual Ostreamwrite (const char *data, std::streamsize count)
 Write binary block with 8-byte alignment. More...
 
virtual OstreamwriteRaw (const char *data, std::streamsize count)
 Low-level raw binary output. More...
 
virtual bool beginRawWrite (std::streamsize count)
 Begin marker for low-level raw binary output. More...
 
virtual bool endRawWrite ()
 End marker for low-level raw binary output. More...
 
virtual void indent ()
 Add indentation characters. More...
 
virtual void flush ()
 Flush stream. More...
 
virtual void endl ()
 Add newline and flush stream. More...
 
virtual char fill () const
 Get the current padding character. More...
 
virtual char fill (const char)
 Set padding character for formatted field up to field width. More...
 
virtual int width () const
 Get width of output field. More...
 
virtual int width (const int)
 Set width of output field. More...
 
virtual int precision () const
 Get precision of output field. More...
 
virtual int precision (const int)
 Set precision of output field. More...
 
virtual void rewind ()
 Rewind the send buffer for overwriting. More...
 
virtual ios_base::fmtflags flags (const ios_base::fmtflags)
 Set flags of stream. More...
 
void print (Ostream &os) const
 Print stream description to Ostream. More...
 
- Public Member Functions inherited from Ostream
 Ostream (const Ostream &)=default
 Copy construct. More...
 
virtual ~Ostream ()=default
 Destructor. More...
 
 Ostream (IOstreamOption streamOpt=IOstreamOption())
 
 Ostream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver=IOstreamOption::currentVersion, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct with format, version (compression) More...
 
virtual bool write (const token &tok)=0
 Write token to stream or otherwise handle it. More...
 
virtual Ostreamwrite (const char c)=0
 Write character. More...
 
virtual Ostreamwrite (const char *str)=0
 Write character string. More...
 
virtual Ostreamwrite (const word &str)=0
 Write word. More...
 
virtual Ostreamwrite (const keyType &kw)
 Write keyType. More...
 
virtual Ostreamwrite (const string &str)=0
 Write string. More...
 
virtual OstreamwriteQuoted (const std::string &str, const bool quoted=true)=0
 Write std::string surrounded by quotes. More...
 
virtual Ostreamwrite (const int32_t val)=0
 Write int32_t. More...
 
virtual Ostreamwrite (const int64_t val)=0
 Write int64_t. More...
 
virtual Ostreamwrite (const floatScalar val)=0
 Write floatScalar. More...
 
virtual Ostreamwrite (const doubleScalar val)=0
 Write doubleScalar. More...
 
virtual Ostreamwrite (const char *data, std::streamsize count)=0
 Write binary block. More...
 
virtual OstreamwriteRaw (const char *data, std::streamsize count)=0
 Low-level raw binary output. More...
 
virtual bool beginRawWrite (std::streamsize count)=0
 Emit begin marker for low-level raw binary output. More...
 
virtual bool endRawWrite ()=0
 Emit end marker for low-level raw binary output. More...
 
virtual void indent ()=0
 Add indentation characters. 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 OstreamwriteKeyword (const keyType &kw)
 Write the keyword followed by an appropriate indentation. More...
 
virtual OstreambeginBlock (const keyType &kw)
 Write begin block group with the given name. More...
 
virtual OstreambeginBlock ()
 Write begin block group without a name. More...
 
virtual OstreamendBlock ()
 Write end block group. More...
 
virtual OstreamendEntry ()
 Write end entry (';') followed by newline. More...
 
template<class T >
OstreamwriteEntry (const keyType &key, const T &value)
 Write a keyword/value entry. More...
 
template<class T >
OstreamwriteEntryIfDifferent (const word &key, const T &value1, const T &value2)
 Write a keyword/value entry only when the two values differ. More...
 
virtual void flush ()=0
 Flush stream. More...
 
virtual void endl ()=0
 Add newline and flush stream. More...
 
virtual char fill () const =0
 Get padding character. More...
 
virtual char fill (const char fillch)=0
 Set padding character for formatted field up to field width. More...
 
virtual int width () const =0
 Get width of output field. More...
 
virtual int width (const int w)=0
 Set width of output field (and return old width) More...
 
virtual int precision () const =0
 Get precision of output field. More...
 
virtual int precision (const int p)=0
 Set precision of output field (and return old precision) More...
 
Ostreamoperator() () 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())
 
 IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
 Construct with format, version (compression) More...
 
virtual const fileNamename () const
 Return the name of the stream. More...
 
virtual fileNamename ()
 Return stream name for modification. 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
 Return true if the stream has not failed. More...
 
bool operator! () const noexcept
 Return 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< std::is_integral< T >::value, bool >::type checkLabelSize () const noexcept
 
template<class T = scalar>
std::enable_if< std::is_floating_point< T >::value, bool >::type checkScalarSize () const noexcept
 
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...
 
virtual ios_base::fmtflags flags () const =0
 Return flags of stream. More...
 
void setEof () noexcept
 Set stream state as reached 'eof'. More...
 
void setFail () noexcept
 Set stream state as 'failed'. More...
 
void setBad ()
 Set stream state to be 'bad'. More...
 
virtual ios_base::fmtflags flags (const ios_base::fmtflags f)=0
 Set flags of stream. More...
 
ios_base::fmtflags setf (const ios_base::fmtflags f)
 Set flags of stream. More...
 
ios_base::fmtflags setf (const ios_base::fmtflags f, const ios_base::fmtflags mask)
 Set flags of given field of stream. More...
 
void unsetf (const ios_base::fmtflags f)
 Unset flags of stream. More...
 
virtual void print (Ostream &os) const
 Print stream description to Ostream. More...
 
void print (Ostream &os, const int streamState) const
 Print information about the stream state bits. More...
 
InfoProxy< IOstreaminfo () const
 Return info proxy. More...
 
- Public Member Functions inherited from IOstreamOption
constexpr IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept
 
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...
 

Additional Inherited Members

- Public Types inherited from UPstream
enum class  commsTypes : char { blocking , scheduled , nonBlocking }
 Types of communications. 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...
 
- Static Public Member Functions inherited from Pstream
template<class Type >
static void broadcast (Type &value, const label comm=UPstream::worldComm)
 
template<class Type , class... Args>
static void broadcasts (const label comm, Type &arg1, Args &&... args)
 Broadcast multiple items to all processes in communicator. More...
 
template<class T , class BinaryOp >
static void gather (const List< commsStruct > &comms, T &value, const BinaryOp &bop, const int tag, const label comm)
 
template<class T , class BinaryOp >
static void gather (T &value, const BinaryOp &bop, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 
template<class T , class CombineOp >
static void combineGather (const List< commsStruct > &comms, T &value, const CombineOp &cop, const int tag, const label comm)
 
template<class T , class CombineOp >
static void combineGather (T &value, const CombineOp &cop, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 
template<class T , class CombineOp >
static void combineAllGather (const List< commsStruct > &comms, T &value, const CombineOp &cop, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 
template<class T , class CombineOp >
static void combineAllGather (T &value, const CombineOp &cop, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 
template<class T , class CombineOp >
static void listCombineGather (const List< commsStruct > &comms, List< T > &values, const CombineOp &cop, const int tag, const label comm)
 
template<class T , class CombineOp >
static void listCombineGather (List< T > &values, const CombineOp &cop, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 Like above but switches between linear/tree communication. More...
 
template<class T , class CombineOp >
static void listCombineAllGather (const List< commsStruct > &comms, List< T > &values, const CombineOp &cop, const int tag, const label comm)
 After completion all processors have the same data. More...
 
template<class T , class CombineOp >
static void listCombineAllGather (List< T > &values, const CombineOp &cop, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 After completion all processors have the same data. More...
 
template<class Container , class CombineOp >
static void mapCombineGather (const List< commsStruct > &comms, Container &values, const CombineOp &cop, const int tag, const label comm)
 
template<class Container , class CombineOp >
static void mapCombineGather (Container &values, const CombineOp &cop, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 Like above but switches between linear/tree communication. More...
 
template<class Container , class CombineOp >
static void mapCombineAllGather (const List< commsStruct > &comms, Container &values, const CombineOp &cop, const int tag, const label comm)
 After completion all processors have the same data. More...
 
template<class Container , class CombineOp >
static void mapCombineAllGather (Container &values, const CombineOp &cop, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 After completion all processors have the same data. More...
 
template<class T >
static void gatherList (const List< commsStruct > &comms, List< T > &values, const int tag, const label comm)
 
template<class T >
static void gatherList (List< T > &values, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 
template<class T >
static void allGatherList (const List< commsStruct > &comms, List< T > &values, const int tag, const label comm)
 
template<class T >
static void allGatherList (List< T > &values, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 
template<class T >
static void scatter (const List< commsStruct > &comms, T &value, const int tag, const label comm)
 Broadcast data: Distribute without modification. More...
 
template<class T >
static void scatter (T &value, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 Broadcast data: Distribute without modification. More...
 
template<class T >
static void combineScatter (const List< commsStruct > &comms, T &value, const int tag, const label comm)
 Broadcast data: Distribute without modification. More...
 
template<class T >
static void combineScatter (T &value, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 Broadcast data: Distribute without modification. More...
 
template<class T >
static void listCombineScatter (const List< commsStruct > &comms, List< T > &value, const int tag, const label comm)
 Broadcast data: Distribute without modification. More...
 
template<class T >
static void listCombineScatter (List< T > &value, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 Broadcast data: Distribute without modification. More...
 
template<class Container >
static void mapCombineScatter (const List< commsStruct > &comms, Container &values, const int tag, const label comm)
 Broadcast data: Distribute without modification. More...
 
template<class Container >
static void mapCombineScatter (Container &values, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 Like above but switches between linear/tree communication. More...
 
template<class T >
static void scatterList (const List< commsStruct > &comms, List< T > &values, const int tag, const label comm)
 Scatter data. Reverse of gatherList. More...
 
template<class T >
static void scatterList (List< T > &values, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 Like above but switches between linear/tree communication. More...
 
template<class Container >
static void exchangeSizes (const labelUList &sendProcs, const labelUList &recvProcs, const Container &sendData, labelList &sizes, const label tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 
template<class Container >
static void exchangeSizes (const Container &sendData, labelList &sizes, const label comm=UPstream::worldComm)
 
template<class Container , class T >
static void exchange (const UList< Container > &sendData, const labelUList &recvSizes, List< Container > &recvData, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm, const bool wait=true)
 
template<class Container , class T >
static void exchange (const UList< Container > &sendData, List< Container > &recvData, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm, const bool wait=true)
 
static bool broadcast (char *buf, const std::streamsize bufSize, const label communicator=worldComm, const int rootProcNo=masterNo())
 Broadcast buffer content to all processes in communicator. More...
 
- Static Public Member Functions inherited from UPstream
static label allocateCommunicator (const label parent, const labelList &subRanks, const bool doPstream=true)
 Allocate a new communicator. More...
 
static void freeCommunicator (const label communicator, const bool doPstream=true)
 Free a previously allocated communicator. More...
 
static void freeCommunicators (const bool doPstream)
 Free all communicators. More...
 
static int baseProcNo (const label myComm, const int procID)
 
static label procNo (const label comm, const int baseProcID)
 
static label procNo (const label myComm, const label currentComm, const int currentProcID)
 
static void addValidParOptions (HashTable< string > &validParOptions)
 
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 label nRequests ()
 Get number of outstanding requests. More...
 
static void resetRequests (const label sz)
 Truncate number of outstanding requests. More...
 
static void waitRequests (const label start=0)
 Wait until all requests (from start onwards) have finished. More...
 
static void waitRequest (const label i)
 Wait until request i has finished. More...
 
static bool finishedRequest (const label i)
 Non-blocking comms: has request i finished? More...
 
static int allocateTag (const char *)
 
static int allocateTag (const std::string &)
 
static void freeTag (const char *, const int tag)
 
static void freeTag (const std::string &, const int tag)
 
static bool parRun (const bool on) noexcept
 Set as parallel run on/off. More...
 
static boolparRun () noexcept
 Test if this a parallel run. More...
 
static bool haveThreads () noexcept
 Have support for threads. More...
 
static label nProcs (const label communicator=worldComm)
 Number of processes in parallel run, and 1 for serial run. More...
 
static constexpr int masterNo () noexcept
 Process index of the master (always 0) More...
 
static bool master (const label communicator=worldComm)
 Am I the master process. More...
 
static int myProcNo (const label communicator=worldComm)
 Number of this process (starting from masterNo() = 0) More...
 
static label parent (const label communicator)
 
static List< int > & procID (label communicator)
 Process ID of given process index. More...
 
static const wordListallWorlds () noexcept
 All worlds. More...
 
static const labelListworldIDs () noexcept
 worldID (index in allWorlds) of all processes More...
 
static label myWorldID ()
 My worldID. More...
 
static const wordmyWorld ()
 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< commsStruct > & linearCommunication (const label communicator=worldComm)
 Communication schedule for linear all-to-master (proc 0) More...
 
static const List< commsStruct > & treeCommunication (const label communicator=worldComm)
 Communication schedule for tree all-to-master (proc 0) More...
 
static const List< commsStruct > & whichCommunication (const label communicator=worldComm)
 
static int & msgType () noexcept
 Message tag of standard messages. More...
 
static void shutdown (int errNo=0)
 Shutdown (finalize) MPI as required. More...
 
static void abort ()
 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 label communicator=worldComm)
 Exchange integer data with all processors (in the communicator). More...
 
static void allToAll (const UList< int64_t > &sendData, UList< int64_t > &recvData, const label communicator=worldComm)
 Exchange integer data with all processors (in the communicator). More...
 
static void mpiGather (const char *sendData, int sendCount, char *recvData, int recvCount, const label communicator=worldComm)
 Receive identically-sized char data from all ranks. More...
 
static void mpiScatter (const char *sendData, int sendCount, char *recvData, int recvCount, const label communicator=worldComm)
 Send identically-sized char data to all ranks. More...
 
static void gather (const char *sendData, int sendCount, char *recvData, const UList< int > &recvCounts, const UList< int > &recvOffsets, const label communicator=worldComm)
 Receive variable length char data from all ranks. More...
 
static void scatter (const char *sendData, const UList< int > &sendCounts, const UList< int > &sendOffsets, char *recvData, int recvCount, const label communicator=worldComm)
 Send variable length char data to all ranks. More...
 
static void gather (const int32_t *sendData, int sendCount, int32_t *recvData, const UList< int > &recvCounts, const UList< int > &recvOffsets, const label communicator=worldComm)
 Receive variable length int32_t data from all ranks. More...
 
static void scatter (const int32_t *sendData, const UList< int > &sendCounts, const UList< int > &sendOffsets, int32_t *recvData, int recvCount, const label communicator=worldComm)
 Send variable length int32_t data to all ranks. More...
 
static void gather (const int64_t *sendData, int sendCount, int64_t *recvData, const UList< int > &recvCounts, const UList< int > &recvOffsets, const label communicator=worldComm)
 Receive variable length int64_t data from all ranks. More...
 
static void scatter (const int64_t *sendData, const UList< int > &sendCounts, const UList< int > &sendOffsets, int64_t *recvData, int recvCount, const label communicator=worldComm)
 Send variable length int64_t data to all ranks. More...
 
static void gather (const uint32_t *sendData, int sendCount, uint32_t *recvData, const UList< int > &recvCounts, const UList< int > &recvOffsets, const label communicator=worldComm)
 Receive variable length uint32_t data from all ranks. More...
 
static void scatter (const uint32_t *sendData, const UList< int > &sendCounts, const UList< int > &sendOffsets, uint32_t *recvData, int recvCount, const label communicator=worldComm)
 Send variable length uint32_t data to all ranks. More...
 
static void gather (const uint64_t *sendData, int sendCount, uint64_t *recvData, const UList< int > &recvCounts, const UList< int > &recvOffsets, const label communicator=worldComm)
 Receive variable length uint64_t data from all ranks. More...
 
static void scatter (const uint64_t *sendData, const UList< int > &sendCounts, const UList< int > &sendOffsets, uint64_t *recvData, int recvCount, const label communicator=worldComm)
 Send variable length uint64_t data to all ranks. More...
 
static void gather (const float *sendData, int sendCount, float *recvData, const UList< int > &recvCounts, const UList< int > &recvOffsets, const label communicator=worldComm)
 Receive variable length float data from all ranks. More...
 
static void scatter (const float *sendData, const UList< int > &sendCounts, const UList< int > &sendOffsets, float *recvData, int recvCount, const label communicator=worldComm)
 Send variable length float data to all ranks. More...
 
static void gather (const double *sendData, int sendCount, double *recvData, const UList< int > &recvCounts, const UList< int > &recvOffsets, const label communicator=worldComm)
 Receive variable length double data from all ranks. More...
 
static void scatter (const double *sendData, const UList< int > &sendCounts, const UList< int > &sendOffsets, double *recvData, int recvCount, const label communicator=worldComm)
 Send variable length double data to all ranks. More...
 
template<class T >
static List< TlistGatherValues (const T &localValue, const label communicator=worldComm)
 Gather individual values into list locations. More...
 
template<class T >
static T listScatterValues (const UList< T > &allValues, const label communicator=worldComm)
 Scatter individual values from list locations. More...
 
static bool broadcast (char *buf, const std::streamsize bufSize, const label communicator=worldComm, const int rootProcNo=masterNo())
 
static constexpr int firstSlave () noexcept
 Process index of first sub-process. More...
 
static int lastSlave (const label communicator=worldComm)
 Process index of last sub-process. More...
 
- Static Public Member Functions inherited from UOPstream
static bool write (const commsTypes commsType, const int toProcNo, const char *buf, const std::streamsize bufSize, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm)
 Write buffer contents to given processor. More...
 
- 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 Public Member Functions inherited from IOstreamOption
static streamFormat formatEnum (const word &formatName, const streamFormat deflt=streamFormat::ASCII)
 
static streamFormat formatEnum (const word &key, const dictionary &dict, const streamFormat deflt=streamFormat::ASCII)
 Failsafe construct streamFormat from optional dictionary lookup. 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)
 Failsafe construct compressionType from optional dictionary lookup. More...
 
- Static Public Attributes inherited from UPstream
static const Enum< commsTypescommsTypeNames
 Names of the communication types. More...
 
static bool floatTransfer
 
static int nProcsSimpleSum
 Number of processors to change from linear to tree communication. More...
 
static commsTypes defaultCommsType
 Default commsType. More...
 
static int nPollProcInterfaces
 Number of polling cycles in processor updates. More...
 
static int maxCommsSize
 Optional maximum message size (bytes) More...
 
static const int mpiBufferSize
 MPI buffer-size (bytes) More...
 
static label worldComm
 Default communicator (all processors) 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< streamFormatformatNames
 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 commsTypes commsType, const int toProcNo, DynamicList< char > &sendBuf, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm, const bool sendAtDestruct=true, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
 
 UOPstreamBase (const int toProcNo, PstreamBuffers &buffers)
 Construct given 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...
 
- Protected Attributes inherited from Pstream
DynamicList< char > transferBuf_
 Allocated transfer buffer (can be used for send or receive) More...
 
- Protected Attributes inherited from UOPstreamBase
int toProcNo_
 
DynamicList< char > & sendBuf_
 
const int tag_
 
const label comm_
 
const bool sendAtDestruct_
 
- 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.

Source files

Definition at line 53 of file OPstream.H.

Constructor & Destructor Documentation

◆ OPstream()

OPstream ( const commsTypes  commsType,
const int  toProcNo,
const label  bufSize = 0,
const int  tag = UPstream::msgType(),
const label  comm = UPstream::worldComm,
IOstreamOption::streamFormat  fmt = IOstreamOption::BINARY 
)

Construct for given process index to send to and optional buffer size, write format

Definition at line 55 of file OPstreams.C.


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