UIPstream Class Reference

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

Inheritance diagram for UIPstream:
Collaboration diagram for UIPstream:

Public Member Functions

 UIPstream (const commsTypes commsType, const int fromProcNo, DynamicList< char > &externalBuf, label &externalBufPosition, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm, const bool clearAtEnd=false, streamFormat format=BINARY, versionNumber version=currentVersion)
 Construct given process index to read from and optional buffer size,. More...
 
 UIPstream (const int fromProcNo, PstreamBuffers &)
 Construct given buffers. More...
 
 ~UIPstream ()
 Destructor. More...
 
ios_base::fmtflags flags () const
 Return flags of output stream. More...
 
Istreamread (token &)
 Return next token from stream. More...
 
Istreamread (char &)
 Read a character. More...
 
Istreamread (word &)
 Read a word. More...
 
Istreamread (string &)
 
Istreamread (label &)
 Read a label. More...
 
Istreamread (floatScalar &)
 Read a floatScalar. More...
 
Istreamread (doubleScalar &)
 Read a doubleScalar. More...
 
Istreamread (longDoubleScalar &)
 Read a longDoubleScalar. More...
 
Istreamread (char *, std::streamsize)
 Read binary block. More...
 
Istreamrewind ()
 Rewind and return the stream so that it may be read again. 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 Istream
 Istream (streamFormat format=ASCII, versionNumber version=currentVersion, compressionType compression=UNCOMPRESSED)
 Set stream status. More...
 
virtual ~Istream ()
 Destructor. More...
 
void putBack (const token &)
 Put back token. More...
 
bool getBack (token &)
 Get the put back token if there is one and return true. More...
 
bool peekBack (token &)
 Peek at the put back token without removing it. More...
 
IstreamreadBegin (const char *funcName)
 
IstreamreadEnd (const char *funcName)
 
IstreamreadEndBegin (const char *funcName)
 
char readBeginList (const char *funcName)
 
char readEndList (const char *funcName)
 
Istreamoperator() () const
 Return a non-const reference to const Istream. 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 label read (const commsTypes commsType, const int fromProcNo, char *buf, const std::streamsize bufSize, const int tag=UPstream::msgType(), const label communicator=0)
 Read into given buffer from given processor and return the. 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, const bool needsThread)
 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 bool haveThreads ()
 Have support for threads. 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 void allToAll (const labelUList &sendData, labelUList &recvData, const label communicator=0)
 Exchange label with all processors (in the communicator). More...
 
static void allToAll (const char *sendData, const UList< int > &sendSizes, const UList< int > &sendOffsets, char *recvData, const UList< int > &recvSizes, const UList< int > &recvOffsets, const label communicator=0)
 Exchange data with all processors (in the communicator) More...
 
static void gather (const char *sendData, int sendSize, char *recvData, const UList< int > &recvSizes, const UList< int > &recvOffsets, const label communicator=0)
 Receive data from all processors on the master. More...
 
static void scatter (const char *sendData, const UList< int > &sendSizes, const UList< int > &sendOffsets, char *recvData, int recvSize, const label communicator=0)
 Send data to all processors from the root of the communicator. 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 IOstream
label lineNumber_
 

Detailed Description

Input inter-processor communications stream operating on external buffer.

Source files

Definition at line 53 of file UIPstream.H.

Constructor & Destructor Documentation

◆ UIPstream() [1/2]

UIPstream ( const commsTypes  commsType,
const int  fromProcNo,
DynamicList< char > &  externalBuf,
label externalBufPosition,
const int  tag = UPstream::msgType(),
const label  comm = UPstream::worldComm,
const bool  clearAtEnd = false,
streamFormat  format = BINARY,
versionNumber  version = currentVersion 
)

Construct given process index to read from and optional buffer size,.

read format and IO version

Definition at line 34 of file UIPread.C.

References NotImplemented.

◆ UIPstream() [2/2]

UIPstream ( const int  fromProcNo,
PstreamBuffers buffers 
)

Construct given buffers.

Definition at line 60 of file UIPread.C.

References NotImplemented, and UIPstream::read().

Here is the call graph for this function:

◆ ~UIPstream()

~UIPstream ( )

Destructor.

Definition at line 82 of file UIPstream.C.

References DynamicList< T, SizeInc, SizeMult, SizeDiv >::clearStorage(), Foam::endl(), IOstream::eof(), Foam::Pout, and List< T >::size().

Here is the call graph for this function:

Member Function Documentation

◆ flags() [1/2]

ios_base::fmtflags flags ( ) const
inlinevirtual

Return flags of output stream.

Implements IOstream.

Definition at line 120 of file UIPstream.H.

References UPstream::msgType(), UIPstream::read(), and UIPstream::rewind().

Here is the call graph for this function:

◆ read() [1/10]

Foam::label read ( const commsTypes  commsType,
const int  fromProcNo,
char *  buf,
const std::streamsize  bufSize,
const int  tag = UPstream::msgType(),
const label  communicator = 0 
)
static

◆ read() [2/10]

◆ read() [3/10]

Foam::Istream & read ( char &  c)
virtual

Read a character.

Implements Istream.

Definition at line 280 of file UIPstream.C.

◆ read() [4/10]

Foam::Istream & read ( word str)
virtual

Read a word.

Implements Istream.

Definition at line 289 of file UIPstream.C.

◆ read() [5/10]

Foam::Istream & read ( string str)
virtual

Implements Istream.

Definition at line 300 of file UIPstream.C.

◆ read() [6/10]

Foam::Istream & read ( label val)
virtual

Read a label.

Implements Istream.

Definition at line 311 of file UIPstream.C.

◆ read() [7/10]

Foam::Istream & read ( floatScalar val)
virtual

Read a floatScalar.

Implements Istream.

Definition at line 318 of file UIPstream.C.

◆ read() [8/10]

Foam::Istream & read ( doubleScalar val)
virtual

Read a doubleScalar.

Implements Istream.

Definition at line 325 of file UIPstream.C.

◆ read() [9/10]

Foam::Istream & read ( longDoubleScalar val)
virtual

Read a longDoubleScalar.

Implements Istream.

Definition at line 332 of file UIPstream.C.

◆ read() [10/10]

Foam::Istream & read ( char *  data,
std::streamsize  count 
)
virtual

Read binary block.

Implements Istream.

Definition at line 339 of file UIPstream.C.

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

Here is the call graph for this function:

◆ rewind()

Foam::Istream & rewind ( )
virtual

Rewind and return the stream so that it may be read again.

Implements Istream.

Definition at line 353 of file UIPstream.C.

Referenced by UIPstream::flags().

Here is the caller graph for this function:

◆ flags() [2/2]

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

Set flags of stream.

Implements IOstream.

Definition at line 174 of file UIPstream.H.

References UIPstream::print().

Here is the call graph for this function:

◆ print()

void print ( Ostream os) const
virtual

Print description of IOstream to Ostream.

Reimplemented from IOstream.

Definition at line 360 of file UIPstream.C.

References Foam::endl().

Referenced by UIPstream::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: