OPstream Class Reference

Output inter-processor communications stream. More...

Inheritance diagram for OPstream:
Collaboration diagram for OPstream:

Public Member Functions

 OPstream (const commsTypes commsType, const int toProcNo, const label bufSize=0, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm, streamFormat format=BINARY, versionNumber version=currentVersion)
 Construct given process index to send to and optional buffer size,. More...
 
- Public Member Functions inherited from Pstream
 ClassName ("Pstream")
 
 Pstream (const commsTypes commsType, const label bufSize=0)
 Construct given optional buffer size. More...
 
template<class T , class CombineOp >
void combineGather (const List< UPstream::commsStruct > &comms, T &Value, const CombineOp &cop, const int tag, const label comm)
 
template<class T , class CombineOp >
void combineGather (T &Value, const CombineOp &cop, const int tag, const label comm)
 
template<class T >
void combineScatter (const List< UPstream::commsStruct > &comms, T &Value, const int tag, const label comm)
 
template<class T >
void combineScatter (T &Value, const int tag, const label comm)
 
template<class T , class CombineOp >
void listCombineGather (const List< UPstream::commsStruct > &comms, List< T > &Values, const CombineOp &cop, const int tag, const label comm)
 
template<class T , class CombineOp >
void listCombineGather (List< T > &Values, const CombineOp &cop, const int tag, const label comm)
 
template<class T >
void listCombineScatter (const List< UPstream::commsStruct > &comms, List< T > &Values, const int tag, const label comm)
 
template<class T >
void listCombineScatter (List< T > &Values, const int tag, const label comm)
 
template<class Container , class CombineOp >
void mapCombineGather (const List< UPstream::commsStruct > &comms, Container &Values, const CombineOp &cop, const int tag, const label comm)
 
template<class Container , class CombineOp >
void mapCombineGather (Container &Values, const CombineOp &cop, const int tag, const label comm)
 
template<class Container >
void mapCombineScatter (const List< UPstream::commsStruct > &comms, Container &Values, const int tag, const label comm)
 
template<class Container >
void mapCombineScatter (Container &Values, const int tag, const label comm)
 
template<class Container , class T >
void exchange (const List< Container > &sendBufs, List< Container > &recvBufs, labelListList &sizes, const int tag, const label comm, const bool block)
 
template<class T , class BinaryOp >
void gather (const List< UPstream::commsStruct > &comms, T &Value, const BinaryOp &bop, const int tag, const label comm)
 
template<class T , class BinaryOp >
void gather (T &Value, const BinaryOp &bop, const int tag, const label comm)
 
template<class T >
void scatter (const List< UPstream::commsStruct > &comms, T &Value, const int tag, const label comm)
 
template<class T >
void scatter (T &Value, const int tag, const label comm)
 
template<class T >
void gatherList (const List< UPstream::commsStruct > &comms, List< T > &Values, const int tag, const label comm)
 
template<class T >
void gatherList (List< T > &Values, const int tag, const label comm)
 
template<class T >
void scatterList (const List< UPstream::commsStruct > &comms, List< T > &Values, const int tag, const label comm)
 
template<class T >
void scatterList (List< T > &Values, const int tag, const label comm)
 
- Public Member Functions inherited from UPstream
 ClassName ("UPstream")
 
 UPstream (const commsTypes commsType)
 Construct given optional buffer size. More...
 
commsTypes commsType () const
 Get the communications type of the stream. More...
 
commsTypes commsType (const commsTypes ct)
 Set the communications type of the stream. More...
 
- 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, streamFormat format=BINARY, versionNumber version=currentVersion)
 Construct given process index to send to and optional buffer size,. More...
 
 UOPstream (const int toProcNo, PstreamBuffers &)
 Construct given buffers. More...
 
 ~UOPstream ()
 Destructor. More...
 
ios_base::fmtflags flags () const
 Return flags of output stream. More...
 
Ostreamwrite (const token &)
 Write next token to stream. More...
 
Ostreamwrite (const char)
 Write character. More...
 
Ostreamwrite (const char *)
 Write character string. More...
 
Ostreamwrite (const word &)
 Write word. More...
 
Ostreamwrite (const string &)
 Write string. More...
 
OstreamwriteQuoted (const std::string &, const bool quoted=true)
 Write std::string surrounded by quotes. More...
 
Ostreamwrite (const label)
 Write label. More...
 
Ostreamwrite (const floatScalar)
 Write floatScalar. More...
 
Ostreamwrite (const doubleScalar)
 Write doubleScalar. More...
 
Ostreamwrite (const char *, std::streamsize)
 Write binary block. More...
 
void indent ()
 Add indentation characters. More...
 
void flush ()
 Flush stream. More...
 
void endl ()
 Add newline and flush stream. More...
 
int width () const
 Get width of output field. More...
 
int width (const int)
 Set width of output field (and return old width) More...
 
int precision () const
 Get precision of output field. More...
 
int precision (const int)
 Set precision of output field (and return old precision) More...
 
ios_base::fmtflags flags (const ios_base::fmtflags)
 Set flags of stream. More...
 
void print (Ostream &) const
 Print description of IOstream to Ostream. More...
 
- Public Member Functions inherited from Ostream
 Ostream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Set stream status. More...
 
virtual ~Ostream ()
 Destructor. More...
 
virtual Ostreamwrite (const keyType &)
 Write keyType. More...
 
unsigned short indentLevel () const
 Return indent level. More...
 
unsigned short & indentLevel ()
 Access to indent level. More...
 
void incrIndent ()
 Incrememt the indent level. More...
 
void decrIndent ()
 Decrememt the indent level. More...
 
OstreamwriteKeyword (const keyType &)
 Write the keyword followed by an appropriate indentation. More...
 
Ostreamoperator() () const
 Return a non-const reference to const Ostream. More...
 
- Public Member Functions inherited from IOstream
 IOstream (streamFormat format, versionNumber version, compressionType compression=UNCOMPRESSED)
 Construct setting format and version. More...
 
virtual ~IOstream ()
 Destructor. More...
 
virtual const fileNamename () const
 Return the name of the stream. More...
 
virtual fileNamename ()
 Return non-const access to the name of the stream. More...
 
virtual bool check (const char *operation) const
 Check IOstream status for given operation. More...
 
void fatalCheck (const char *operation) const
 Check IOstream status for given operation. More...
 
bool opened () const
 Return true if stream has been opened. More...
 
bool closed () const
 Return true if stream is closed. More...
 
bool good () const
 Return true if next operation might succeed. More...
 
bool eof () const
 Return true if end of input seen. More...
 
bool fail () const
 Return true if next operation will fail. More...
 
bool bad () const
 Return true if stream is corrupted. More...
 
 operator void * () const
 Return non-zero if the stream has not failed. More...
 
bool operator! () const
 Return true if the stream has failed. More...
 
streamFormat format () const
 Return current stream format. More...
 
streamFormat format (const streamFormat fmt)
 Set the stream format. More...
 
streamFormat format (const word &fmt)
 Set the stream format from word. More...
 
versionNumber version () const
 Return the stream version. More...
 
versionNumber version (const versionNumber ver)
 Set the stream version. More...
 
compressionType compression () const
 Return the stream compression. More...
 
compressionType compression (const compressionType cmp)
 Set the stream compression. More...
 
compressionType compression (const word &cmp)
 Set the stream compression from word. More...
 
label lineNumber () const
 Return current stream line number. More...
 
label & lineNumber ()
 Return current stream line number. More...
 
label lineNumber (const label ln)
 Set the stream line number. More...
 
void setEof ()
 Set stream to have reached eof. More...
 
void setFail ()
 Set stream to have failed. More...
 
void setBad ()
 Set stream to be bad. More...
 
virtual ios::fmtflags flags (const ios::fmtflags f)=0
 Set flags of stream. More...
 
ios::fmtflags setf (const ios::fmtflags f)
 Set flags of stream. More...
 
ios::fmtflags setf (const ios::fmtflags f, const ios::fmtflags mask)
 Set flags of given field of stream. More...
 
void unsetf (const ios::fmtflags uf)
 Unset flags of stream. More...
 
void print (Ostream &, const int streamState) const
 Check given stream state bits. More...
 
InfoProxy< IOstreaminfo () const
 Return info proxy. More...
 

Additional Inherited Members

- Public Types inherited from UPstream
enum  commsTypes { blocking, scheduled, nonBlocking }
 Types of communications. More...
 
- Public Types inherited from IOstream
enum  streamAccess { OPENED, CLOSED }
 Enumeration for whether the stream open or closed. More...
 
enum  streamFormat { ASCII, BINARY }
 Enumeration for the format of data in the stream. More...
 
enum  compressionType { UNCOMPRESSED, COMPRESSED }
 Enumeration for the format of data in the stream. More...
 
- Static Public Member Functions inherited from Pstream
template<class T , class BinaryOp >
static void gather (const List< commsStruct > &comms, T &Value, const BinaryOp &bop, const int tag, const label comm)
 Gather data. Apply bop to combine Value. More...
 
template<class T , class BinaryOp >
static void gather (T &Value, const BinaryOp &bop, const int tag=Pstream::msgType(), const label comm=Pstream::worldComm)
 Like above but switches between linear/tree communication. More...
 
template<class T >
static void scatter (const List< commsStruct > &comms, T &Value, const int tag, const label comm)
 Scatter data. Distribute without modification. Reverse of gather. More...
 
template<class T >
static void scatter (T &Value, const int tag=Pstream::msgType(), const label comm=Pstream::worldComm)
 Like above but switches between linear/tree communication. More...
 
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=Pstream::msgType(), const label comm=Pstream::worldComm)
 Like above but switches between linear/tree communication. More...
 
template<class T >
static void combineScatter (const List< commsStruct > &comms, T &Value, const int tag, const label comm)
 Scatter data. Reverse of combineGather. More...
 
template<class T >
static void combineScatter (T &Value, const int tag=Pstream::msgType(), const label comm=Pstream::worldComm)
 Like above but switches between linear/tree communication. More...
 
template<class T , class CombineOp >
static void listCombineGather (const List< commsStruct > &comms, List< T > &Value, const CombineOp &cop, const int tag, const label comm)
 
template<class T , class CombineOp >
static void listCombineGather (List< T > &Value, const CombineOp &cop, const int tag=Pstream::msgType(), const label comm=Pstream::worldComm)
 Like above but switches between linear/tree communication. More...
 
template<class T >
static void listCombineScatter (const List< commsStruct > &comms, List< T > &Value, const int tag, const label comm)
 Scatter data. Reverse of combineGather. More...
 
template<class T >
static void listCombineScatter (List< T > &Value, const int tag=Pstream::msgType(), const label comm=Pstream::worldComm)
 Like above but switches between linear/tree communication. 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=Pstream::msgType(), const label comm=UPstream::worldComm)
 Like above but switches between linear/tree communication. More...
 
template<class Container >
static void mapCombineScatter (const List< commsStruct > &comms, Container &Values, const int tag, const label comm)
 Scatter data. Reverse of combineGather. More...
 
template<class Container >
static void mapCombineScatter (Container &Values, const int tag=Pstream::msgType(), const label comm=UPstream::worldComm)
 Like above but switches between linear/tree communication. More...
 
template<class T >
static void gatherList (const List< commsStruct > &comms, List< T > &Values, const int tag, const label comm)
 Gather data but keep individual values separate. More...
 
template<class T >
static void gatherList (List< T > &Values, const int tag=Pstream::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=Pstream::msgType(), const label comm=UPstream::worldComm)
 Like above but switches between linear/tree communication. More...
 
template<class Container , class T >
static void exchange (const List< Container > &, List< Container > &, labelListList &sizes, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm, const bool block=true)
 Exchange data. Sends sendData, receives into recvData, sets. 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 communicator=0)
 Write given buffer to given processor. More...
 
- Static Public Attributes inherited from UPstream
static const NamedEnum
< commsTypes, 3 > 
commsTypeNames
 
static bool floatTransfer
 Should compact transfer be used in which floats replace doubles. More...
 
static int nProcsSimpleSum
 Number of processors at which the sum algorithm changes from linear. More...
 
static commsTypes defaultCommsType
 Default commsType. More...
 
static int nPollProcInterfaces
 Number of polling cycles in processor updates. 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 const versionNumber originalVersion
 Original version number. More...
 
static const versionNumber currentVersion
 Current version number. More...
 
static unsigned int precision_
 Default precision. More...
 
- Protected Member Functions inherited from IOstream
void setOpened ()
 Set stream opened. More...
 
void setClosed ()
 Set stream closed. More...
 
void setState (ios::iostate state)
 Set stream state. More...
 
void setGood ()
 Set stream to be good. More...
 
- Protected Attributes inherited from Pstream
DynamicList< char > buf_
 Transfer buffer. More...
 
- Protected Attributes inherited from UPstream
commsTypes commsType_
 Communications type of this stream. More...
 
- Protected Attributes inherited from Ostream
unsigned short indentLevel_
 Current indent level. More...
 
- Static Protected Attributes inherited from Ostream
static const unsigned short indentSize_ = 4
 Number of spaces per indent level. More...
 
static const unsigned short entryIndentation_ = 16
 Indentation of the entry from the start of the keyword. More...
 

Detailed Description

Output inter-processor communications stream.

Source files

Definition at line 51 of file OPstream.H.

Constructor & Destructor Documentation

OPstream ( const commsTypes  commsType,
const int  toProcNo,
const label  bufSize = 0,
const int  tag = UPstream::msgType(),
const label  comm = UPstream::worldComm,
streamFormat  format = BINARY,
versionNumber  version = currentVersion 
)

Construct given process index to send to and optional buffer size,.

write format and IO version

Definition at line 31 of file OPstream.C.


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