Public Member Functions | Static Public Member Functions | List of all members
UOPstream Class Reference

Output inter-processor communications stream operating on external buffer. More...

Inheritance diagram for UOPstream:
Inheritance graph
[legend]
Collaboration diagram for UOPstream:
Collaboration graph
[legend]

Public Member Functions

 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...
 
virtual Ostreamwrite (const int32_t)
 Write int32_t. More...
 
Ostreamwrite (const int64_t)
 Write int64_t. 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 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 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...
 
labellineNumber ()
 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...
 
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 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...
 

Static Public Member Functions

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 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)
 Return physical processor number (i.e. processor number in. More...
 
static label procNo (const label comm, const int baseProcID)
 Return processor number in communicator (given physical processor. More...
 
static label procNo (const label myComm, const label currentComm, const int currentProcID)
 Return processor number in communicator (given processor number. More...
 
static void addValidParOptions (HashTable< string > &validParOptions)
 Add the valid option this type of communications library. More...
 
static bool init (int &argc, char **&argv)
 Initialisation function called from main. 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 word &)
 
static void freeTag (const char *, const int tag)
 
static void freeTag (const word &, const int tag)
 
static bool & parRun ()
 Is this a parallel run? More...
 
static label nProcs (const label communicator=0)
 Number of processes in parallel run. More...
 
static int masterNo ()
 Process index of the master. More...
 
static bool master (const label communicator=0)
 Am I the master process. More...
 
static int myProcNo (const label communicator=0)
 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 int firstSlave ()
 Process index of first slave. More...
 
static int lastSlave (const label communicator=0)
 Process index of last slave. More...
 
static const List< commsStruct > & linearCommunication (const label communicator=0)
 Communication schedule for linear all-to-master (proc 0) More...
 
static const List< commsStruct > & treeCommunication (const label communicator=0)
 Communication schedule for tree all-to-master (proc 0) More...
 
static int & msgType ()
 Message tag of standard messages. More...
 
static void exit (int errnum=1)
 Exit program. More...
 
static void abort ()
 Abort program. More...
 
- Static Public Member Functions inherited from IOstream
static streamFormat formatEnum (const word &)
 Return stream format of given format name. More...
 
static compressionType compressionEnum (const word &)
 Return compression of given compression name. More...
 
static unsigned int defaultPrecision ()
 Return the default precision. More...
 
static unsigned int defaultPrecision (unsigned int p)
 Reset the default precision (and return old precision) 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 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_base::iostate state)
 Set stream state. More...
 
void setGood ()
 Set stream to be good. 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...
 
- Protected Attributes inherited from IOstream
label lineNumber_
 
- 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 operating on external buffer.

Source files

Definition at line 54 of file UOPstream.H.

Constructor & Destructor Documentation

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,.

write format and IO version

Definition at line 89 of file UOPstream.C.

References IOstream::setGood(), and IOstream::setOpened().

Here is the call graph for this function:

UOPstream ( const int  toProcNo,
PstreamBuffers buffers 
)

Construct given buffers.

Definition at line 113 of file UOPstream.C.

References IOstream::setGood(), and IOstream::setOpened().

Here is the call graph for this function:

~UOPstream ( )

Destructor.

Definition at line 130 of file UOPstream.C.

References Foam::abort(), UList< T >::begin(), UPstream::commsType_, Foam::FatalError, FatalErrorIn, List< T >::size(), and UOPstream::write().

Here is the call graph for this function:

Member Function Documentation

ios_base::fmtflags flags ( ) const
inlinevirtual

Return flags of output stream.

Implements IOstream.

Definition at line 116 of file UOPstream.H.

References UPstream::msgType(), UOPstream::write(), and UOPstream::writeQuoted().

Here is the call graph for this function:

bool write ( const commsTypes  commsType,
const int  toProcNo,
const char *  buf,
const std::streamsize  bufSize,
const int  tag = UPstream::msgType(),
const label  communicator = 0 
)
static
Foam::Ostream & write ( const token t)
virtual

Write next token to stream.

Implements Ostream.

Definition at line 158 of file UOPstream.C.

References notImplemented, IOstream::setBad(), token::stringToken(), token::type(), token::VARIABLE, token::VERBATIMSTRING, and UOPstream::write().

Here is the call graph for this function:

Foam::Ostream & write ( const char  c)
virtual

Write character.

Implements Ostream.

Definition at line 180 of file UOPstream.C.

References Foam::isspace().

Here is the call graph for this function:

Foam::Ostream & write ( const char *  str)
virtual

Write character string.

Implements Ostream.

Definition at line 191 of file UOPstream.C.

References UOPstream::write().

Here is the call graph for this function:

Foam::Ostream & write ( const word str)
virtual

Write word.

Implements Ostream.

Definition at line 210 of file UOPstream.C.

References token::WORD, and UOPstream::write().

Here is the call graph for this function:

Foam::Ostream & write ( const string str)
virtual

Write string.

Implements Ostream.

Definition at line 222 of file UOPstream.C.

References token::STRING, UOPstream::write(), and UOPstream::writeQuoted().

Here is the call graph for this function:

Foam::Ostream & writeQuoted ( const std::string &  str,
const bool  quoted = true 
)
virtual

Write std::string surrounded by quotes.

Optional write without quotes.

Implements Ostream.

Definition at line 235 of file UOPstream.C.

References token::STRING, token::WORD, and UOPstream::write().

Referenced by UOPstream::flags(), and UOPstream::write().

Here is the call graph for this function:

Here is the caller graph for this function:

Foam::Ostream & write ( const int32_t  val)
virtual

Write int32_t.

Implements Ostream.

Definition at line 257 of file UOPstream.C.

References token::LABEL, and UOPstream::write().

Here is the call graph for this function:

Foam::Ostream & write ( const int64_t  val)
virtual

Write int64_t.

Implements Ostream.

Definition at line 265 of file UOPstream.C.

References token::LABEL, and UOPstream::write().

Here is the call graph for this function:

Foam::Ostream & write ( const floatScalar  val)
virtual

Write floatScalar.

Implements Ostream.

Definition at line 273 of file UOPstream.C.

References token::FLOAT_SCALAR, and UOPstream::write().

Here is the call graph for this function:

Foam::Ostream & write ( const doubleScalar  val)
virtual

Write doubleScalar.

Implements Ostream.

Definition at line 281 of file UOPstream.C.

References token::DOUBLE_SCALAR, and UOPstream::write().

Here is the call graph for this function:

Foam::Ostream & write ( const char *  data,
std::streamsize  count 
)
virtual

Write binary block.

Implements Ostream.

Definition at line 289 of file UOPstream.C.

References Foam::abort(), IOstream::BINARY, Foam::FatalError, FatalErrorIn, and IOstream::format().

Here is the call graph for this function:

void indent ( )
inlinevirtual

Add indentation characters.

Implements Ostream.

Definition at line 174 of file UOPstream.H.

void flush ( )
inlinevirtual

Flush stream.

Implements Ostream.

Definition at line 181 of file UOPstream.H.

void endl ( )
inlinevirtual

Add newline and flush stream.

Implements Ostream.

Definition at line 185 of file UOPstream.H.

int width ( ) const
inlinevirtual

Get width of output field.

Implements Ostream.

Definition at line 189 of file UOPstream.H.

int width ( const int  )
inlinevirtual

Set width of output field (and return old width)

Implements Ostream.

Definition at line 195 of file UOPstream.H.

int precision ( ) const
inlinevirtual

Get precision of output field.

Implements Ostream.

Definition at line 201 of file UOPstream.H.

int precision ( const int  )
inlinevirtual

Set precision of output field (and return old precision)

Implements Ostream.

Definition at line 207 of file UOPstream.H.

ios_base::fmtflags flags ( const ios_base::fmtflags  )
inlinevirtual

Set flags of stream.

Implements IOstream.

Definition at line 216 of file UOPstream.H.

References UOPstream::print().

Here is the call graph for this function:

void print ( Ostream os) const
virtual

Print description of IOstream to Ostream.

Reimplemented from IOstream.

Definition at line 304 of file UOPstream.C.

References Foam::endl(), and UPstream::myProcNo().

Referenced by UOPstream::flags().

Here is the call graph for this function:

Here is the caller graph for this function:


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