Output inter-processor communications stream operating on external buffer. More...
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, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY) | |
UOPstream (const int toProcNo, PstreamBuffers &buffers) | |
Construct given buffers. More... | |
~UOPstream () | |
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 Ostream & | write (const char c) |
Write single character. Whitespace is suppressed. More... | |
virtual Ostream & | write (const char *str) |
Write the word-characters of a character string. More... | |
virtual Ostream & | write (const word &str) |
Write word. More... | |
virtual Ostream & | write (const string &str) |
Write string. More... | |
virtual Ostream & | writeQuoted (const std::string &str, const bool quoted=true) |
Write std::string surrounded by quotes. More... | |
virtual Ostream & | write (const int32_t val) |
Write int32_t as a label. More... | |
virtual Ostream & | write (const int64_t val) |
Write int64_t as a label. More... | |
virtual Ostream & | write (const floatScalar val) |
Write floatScalar. More... | |
virtual Ostream & | write (const doubleScalar val) |
Write doubleScalar. More... | |
virtual Ostream & | write (const char *data, std::streamsize count) |
Write binary block with 8-byte alignment. More... | |
virtual Ostream & | writeRaw (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... | |
ios_base::fmtflags | flags (const ios_base::fmtflags) |
Set flags of stream. More... | |
void | print (Ostream &os) const |
Print stream description to Ostream. More... | |
![]() | |
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< T > | listGatherValues (const T &localValue, const label comm) |
![]() | |
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 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... | |
![]() | |
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 fileName & | name () const |
Return the name of the stream. More... | |
virtual fileName & | name () |
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... | |
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... | |
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... | |
void | print (Ostream &os, const int streamState) const |
Print information about the stream state bits. More... | |
InfoProxy< IOstream > | info () const |
Return info proxy. More... | |
![]() | |
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... | |
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=UPstream::worldComm) |
Write given buffer to given processor. More... | |
![]() | |
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 word &) |
static void | freeTag (const char *, const int tag) |
static void | freeTag (const word &, const int tag) |
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 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 wordList & | allWorlds () noexcept |
All worlds. More... | |
static const labelList & | worldIDs () noexcept |
worldID (index in allWorlds) of 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< 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 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 labelUList &sendData, labelUList &recvData, const label communicator=worldComm) |
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=worldComm) |
Exchange data with all processors (in the communicator) More... | |
static void | mpiGather (const char *sendData, int sendSize, char *recvData, int recvSize, const label communicator=worldComm) |
Receive data from all processors on the master (low-level) More... | |
static void | mpiScatter (const char *sendData, int sendSize, char *recvData, int recvSize, const label communicator=worldComm) |
Send data to all processors from master (low-level) More... | |
static void | gather (const char *sendData, int sendSize, char *recvData, const UList< int > &recvSizes, const UList< int > &recvOffsets, const label communicator=worldComm) |
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=worldComm) |
Send data to all processors from the root of the communicator. More... | |
template<class T > | |
static List< T > | listGatherValues (const T &localValue, const label communicator=worldComm) |
Individual values into list locations. More... | |
template<class T > | |
static T | listScatterValues (const UList< T > &allValues, const label communicator=worldComm) |
Individual values into list locations. More... | |
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 unsigned int | defaultPrecision () noexcept |
Return the default precision. More... | |
static unsigned int | defaultPrecision (unsigned int prec) noexcept |
Reset the default precision. More... | |
![]() | |
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... | |
Additional Inherited Members | |
![]() | |
enum | commsTypes : char { blocking, scheduled, nonBlocking } |
Types of communications. More... | |
typedef IntRange< int > | rangeType |
Int ranges are used for MPI ranks (processes) More... | |
![]() | |
enum | streamAccess : char { CLOSED = 0, OPENED } |
Enumeration for stream open/closed state. More... | |
![]() | |
enum | streamFormat : char { ASCII = 0, BINARY } |
Data format (ascii | binary) More... | |
enum | compressionType : char { UNCOMPRESSED = 0, COMPRESSED } |
Compression treatment (UNCOMPRESSED | COMPRESSED) More... | |
![]() | |
static const Enum< commsTypes > | commsTypeNames |
Names of the communication types. More... | |
static bool | floatTransfer |
static int | nProcsSimpleSum |
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 unsigned int | precision_ |
Default precision. More... | |
![]() | |
static const Enum< streamFormat > | formatNames |
Stream format names (ascii, binary) More... | |
static const versionNumber | currentVersion |
The current version number (2.0) More... | |
![]() | |
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... | |
![]() | |
commsTypes | commsType_ |
Communications type of this stream. More... | |
![]() | |
unsigned short | indentSize_ = 4 |
Number of spaces per indent level. More... | |
unsigned short | indentLevel_ = 0 |
Current indent level. More... | |
![]() | |
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 constexpr const unsigned short | entryIndentation_ = 16 |
Indentation of the entry from the start of the keyword. More... | |
![]() | |
static fileName | staticName_ |
Name for any generic stream - normally treat as readonly. More... | |
Output inter-processor communications stream operating on external buffer.
Definition at line 57 of file UOPstream.H.
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 |
||
) |
Construct given process index to write to using the given attached send buffer, optional communication characteristics and IO format
Definition at line 135 of file UOPstream.C.
UOPstream | ( | const int | toProcNo, |
PstreamBuffers & | buffers | ||
) |
Construct given buffers.
Definition at line 158 of file UOPstream.C.
References IOstream::setGood(), and IOstream::setOpened().
~UOPstream | ( | ) |
Destructor.
Definition at line 175 of file UOPstream.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and UOPstream::write().
|
inlinevirtual |
|
static |
Write given buffer to given processor.
Definition at line 36 of file UOPwrite.C.
References NotImplemented.
Referenced by mapDistributeBase::compact(), Pstream::gather(), Pstream::gatherList(), Pstream::scatter(), Pstream::scatterList(), syncTools::syncBoundaryFaceList(), syncTools::syncFaceList(), OFstreamCollator::write(), and UOPstream::~UOPstream().
Write token to stream or otherwise handle it.
Implements Ostream.
Definition at line 203 of file UOPstream.C.
References token::flagToken(), token::stringToken(), token::type(), and token::wordToken().
|
virtual |
Write single character. Whitespace is suppressed.
Implements Ostream.
Definition at line 247 of file UOPstream.C.
References Foam::constant::universal::c, and Foam::isspace().
|
virtual |
Write the word-characters of a character string.
Sends as a single char, or as word.
Implements Ostream.
Definition at line 258 of file UOPstream.C.
References Foam::vtk::write().
|
virtual |
|
virtual |
|
virtual |
Write std::string surrounded by quotes.
Optional write without quotes.
Implements Ostream.
Definition at line 294 of file UOPstream.C.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Write binary block with 8-byte alignment.
Implements Ostream.
Definition at line 345 of file UOPstream.C.
References Foam::abort(), Foam::BitOps::count(), Foam::FatalError, FatalErrorInFunction, and format().
|
virtual |
Low-level raw binary output.
Implements Ostream.
Definition at line 362 of file UOPstream.C.
References Foam::BitOps::count().
|
virtual |
Begin marker for low-level raw binary output.
The count indicates the number of bytes for subsequent writeRaw calls.
Implements Ostream.
Definition at line 377 of file UOPstream.C.
References Foam::abort(), Foam::BitOps::count(), Foam::FatalError, FatalErrorInFunction, and format().
|
inlinevirtual |
End marker for low-level raw binary output.
Implements Ostream.
Definition at line 201 of file UOPstream.H.
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
|
inlinevirtual |
Get the current padding character.
Implements Ostream.
Definition at line 223 of file UOPstream.H.
|
inlinevirtual |
Set padding character for formatted field up to field width.
Implements Ostream.
Definition at line 229 of file UOPstream.H.
|
inlinevirtual |
|
inlinevirtual |
Set width of output field.
Implements Ostream.
Definition at line 242 of file UOPstream.H.
|
inlinevirtual |
|
inlinevirtual |
Set precision of output field.
Implements Ostream.
Definition at line 255 of file UOPstream.H.
|
inlinevirtual |
|
virtual |
Print stream description to Ostream.
Reimplemented from IOstream.
Definition at line 394 of file UOPstream.C.
References Foam::endl(), and os().