Base class for input inter-processor communications stream (ie, parallel streams). Not to be used directly, thus contructors are protected. More...

Inheritance diagram for UIPstreamBase:

[legend]

Collaboration diagram for UIPstreamBase:

[legend]

Public Member Functions
virtual	~UIPstreamBase ()
	Destructor. Optionally clears external receive buffer. More...

virtual ios_base::fmtflags	flags () const
	Return flags of output stream. More...

Istream &	read (token &t)
	Return next token from stream. More...

Istream &	read (char &c)
	Read a character. More...

Istream &	read (word &str)
	Read a word. More...

Istream &	read (string &str)
	Read a string (including enclosing double-quotes) More...

Istream &	read (label &val)
	Read a label. More...

Istream &	read (float &val)
	Read a float. More...

Istream &	read (double &val)
	Read a double. More...

Istream &	read (char *data, std::streamsize count)
	Read binary block with 8-byte alignment. More...

Istream &	readRaw (char *data, std::streamsize count)
	Low-level raw binary read. More...

bool	beginRawRead ()
	Start of low-level raw binary read. More...

bool	endRawRead ()
	End of low-level raw binary read. More...

virtual void	rewind ()
	Rewind the receive stream position so that it may be read again. 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 UPstream
	ClassName ("UPstream")
	Declare name of the class and its debug switch. More...

	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)

Public Member Functions inherited from Istream
	Istream (const Istream &)=default
	Copy construct. More...

virtual	~Istream ()=default
	Destructor. More...

	Istream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option. More...

	Istream (IOstreamOption::streamFormat fmt, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format (uncompressed) More...

const token &	peekBack () const noexcept
	Examine putback token without removing it. More...

bool	peekBack (token &tok)
	Fetch putback token without removing it. More...

void	putBack (const token &tok)
	Put back a token. Only a single put back is permitted. More...

bool	getBack (token &tok)
	Get the put-back token if there is one. More...

bool	readBegin (const char *funcName)
	Begin read of data chunk, starts with '('. More...

bool	readEnd (const char *funcName)
	End read of data chunk, ends with ')'. More...

char	readBeginList (const char *funcName)
	Begin read of list data, starts with '(' or '{'. More...

char	readEndList (const char *funcName)
	End read of list data, ends with ')' or '}'. More...

Istream &	operator() () const
	Return a non-const reference to const Istream. More...

Public Member Functions inherited from IOstream
	IOstream (const IOstream &)=default
	Copy construct. More...

virtual	~IOstream ()=default
	Destructor. More...

	IOstream (IOstreamOption streamOpt=IOstreamOption())
	Default construct (ASCII, uncompressed), construct with specified stream option. More...

	IOstream (IOstreamOption::streamFormat fmt, IOstreamOption::versionNumber ver, IOstreamOption::compressionType cmp=IOstreamOption::UNCOMPRESSED)
	Construct with format, version (compression) More...

virtual const fileName &	name () const
	The name of the stream. 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
	Check if the label byte-size associated with the stream is the same as the given type. More...

template<class T = scalar>
std::enable_if< std::is_floating_point< T >::value, bool >::type	checkScalarSize () const noexcept
	Check if the scalar byte-size associated with the stream is the same as the given type. More...

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

Public Member Functions inherited from IOstreamOption
constexpr	IOstreamOption (streamFormat fmt=streamFormat::ASCII, compressionType comp=compressionType::UNCOMPRESSED) noexcept
	Default construct (ASCII, UNCOMPRESSED, currentVersion) or construct with format, compression. More...

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

Protected Member Functions
	UIPstreamBase (const commsTypes commsType, const int fromProcNo, DynamicList< char > &receiveBuf, label &receiveBufPosition, const int tag=UPstream::msgType(), const label comm=UPstream::worldComm, const bool clearAtEnd=false, IOstreamOption::streamFormat fmt=IOstreamOption::BINARY)
	Construct given process index to read from using the given attached receive buffer, optional communication characteristics and IO format. More...

	UIPstreamBase (const int fromProcNo, PstreamBuffers &buffers)
	Construct given buffers. More...

Protected Member Functions inherited from Istream
bool	hasPutback () const noexcept
	True if putback token is in use. 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
int	fromProcNo_

DynamicList< char > &	recvBuf_

label &	recvBufPos_

const int	tag_

const label	comm_

const bool	clearAtEnd_

int	messageSize_

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

Additional Inherited Members
Public Types inherited from UPstream
enum	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...

enum	appendType : char { NON_APPEND = 0, APPEND }
	File appending (NON_APPEND \| APPEND) More...

enum	atomicType : char { NON_ATOMIC = 0, ATOMIC }
	Atomic operations (output) More...

Static Public Member Functions inherited from UPstream
static label	nComms () noexcept
	Number of currently defined communicators. More...

static bool	isUserComm (label communicator) noexcept
	True if communicator appears to be user-allocated. More...

static label	allocateCommunicator (const label parent, const labelUList &subRanks, const bool doPstream=true)
	Allocate a new communicator with subRanks of parent 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 (label comm, int procID)
	Return physical processor number (i.e. processor number in worldComm) given communicator and processor. More...

static label	procNo (const label comm, const int baseProcID)
	Return processor number in communicator (given physical processor number) (= reverse of baseProcNo) More...

static label	procNo (const label comm, const label currentComm, const int currentProcID)
	Return processor number in communicator (given processor number and communicator) More...

static void	addValidParOptions (HashTable< string > &validParOptions)
	Add the valid option this type of communications library adds/requires on the command line. More...

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 () noexcept
	Number of outstanding requests. More...

static void	resetRequests (const label n)
	Truncate outstanding requests to given length. 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 *const msg=nullptr)

static void	freeTag (const int tag, const char *const msg=nullptr)

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 ranks in parallel run (for given communicator) is 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 rank. More...

static bool	is_subrank (const label communicator=worldComm)
	Is this process a sub-rank on the communicator. More...

static int	myProcNo (const label communicator=worldComm)
	Number of this process (starting from masterNo() = 0) More...

static label	parent (const label communicator)
	The parent communicator. More...

static List< int > &	procID (const label communicator)
	Process IDs within a given communicator. More...

static const wordList &	allWorlds () noexcept
	All worlds. More...

static const labelList &	worldIDs () noexcept
	The indices into allWorlds for 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 const List< commsStruct > &	whichCommunication (const label communicator=worldComm)
	Communication schedule for linear/tree all-to-master (proc 0). Chooses based on the value of UPstream::nProcsSimpleSum. 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 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< T >	listGatherValues (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())
	Broadcast buffer contents to all processes in communicator. The sizes must match on all processes. More...

static void	reduceAnd (bool &value, const label communicator=worldComm)
	Logical (and) reduction (cf. MPI AllReduce) More...

static void	reduceOr (bool &value, const label communicator=worldComm)
	Logical (or) reduction (cf. MPI AllReduce) 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 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)
	The stream format enum corresponding to the string (ascii \| binary). More...

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< commsTypes >	commsTypeNames
	Enumerated names for the communication types. More...

static bool	floatTransfer
	Should compact transfer be used in which floats replace doubles reducing the bandwidth requirement at the expense of some loss in accuracy. More...

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 world communicator (all processors). May differ from globalComm if local worlds are in use. More...

static label	warnComm
	Debugging: warn for use of any communicator differing from warnComm. More...

static constexpr label	globalComm = 0
	Communicator for all processors, irrespective of any local worlds. More...

static constexpr label	selfComm = 1
	A communicator within the current rank only. More...

Static Public Attributes inherited from IOstream
static unsigned int	precision_
	Default precision. More...

Static Public Attributes inherited from IOstreamOption
static const Enum< streamFormat >	formatNames
	Stream format names (ascii, binary) More...

static const versionNumber	currentVersion
	The current version number (2.0) More...

Static Protected Attributes inherited from IOstream
static fileName	staticName_
	Name for any generic stream - normally treat as readonly. More...

Detailed Description

Base class for input inter-processor communications stream (ie, parallel streams). Not to be used directly, thus contructors are protected.

Source files

Definition at line 54 of file UIPstream.H.

Constructor & Destructor Documentation

◆ UIPstreamBase() [1/2]

UIPstreamBase	(	const commsTypes	commsType,
		const int	fromProcNo,
		DynamicList< char > &	receiveBuf,
		label &	receiveBufPosition,
		const int	tag = `UPstream::msgType()`,
		const label	comm = `UPstream::worldComm`,
		const bool	clearAtEnd = `false`,
		IOstreamOption::streamFormat	fmt = `IOstreamOption::BINARY`
	)

protected

Construct given process index to read from using the given attached receive buffer, optional communication characteristics and IO format.

Definition at line 141 of file UIPstreamBase.C.

◆ UIPstreamBase() [2/2]

UIPstreamBase	(	const int	fromProcNo,
		PstreamBuffers &	buffers
	)

protected

Construct given buffers.

Definition at line 168 of file UIPstreamBase.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, PstreamBuffers::finished(), and UPstream::scheduled.

Here is the call graph for this function:

◆ ~UIPstreamBase()

~UIPstreamBase ( )

virtual

Destructor. Optionally clears external receive buffer.

Definition at line 203 of file UIPstreamBase.C.

References Foam::ensightOutput::debug, Foam::endl(), and Foam::Pout.

Here is the call graph for this function:

Member Function Documentation

◆ flags() [1/2]

virtual ios_base::fmtflags flags ( ) const

inlinevirtual

Return flags of output stream.

Implements IOstream.

Definition at line 150 of file UIPstream.H.

◆ read() [1/8]

Foam::Istream & read ( token & t )

virtual

Return next token from stream.

Implements Istream.

Definition at line 222 of file UIPstreamBase.C.

References token::ASSIGN, token::BEGIN_BLOCK, token::BEGIN_LIST, token::BEGIN_SQR, Foam::constant::universal::c, Foam::charToWord(), token::COLON, token::COMMA, token::DIVIDE, token::END_BLOCK, token::END_LIST, token::END_SQR, token::END_STATEMENT, token::FLAG, token::flagToken(), Istream::getBack(), token::compound::isCompound(), token::isFlag(), token::lineNumber(), token::MINUS, token::MULTIPLY, token::compound::New(), token::PLUS, Foam::processFlags(), Foam::read(), token::setBad(), and token::setType().

Here is the call graph for this function:

◆ read() [2/8]

Foam::Istream & read ( char & c )

virtual

Read a character.

Implements Istream.

Definition at line 400 of file UIPstreamBase.C.

References Foam::constant::universal::c.

◆ read() [3/8]

Foam::Istream & read ( word & str )

virtual

Read a word.

Implements Istream.

Definition at line 409 of file UIPstreamBase.C.

◆ read() [4/8]

Foam::Istream & read ( string & )

virtual

Read a string (including enclosing double-quotes)

Implements Istream.

Definition at line 415 of file UIPstreamBase.C.

◆ read() [5/8]

Foam::Istream & read ( label & val )

virtual

Read a label.

Implements Istream.

Definition at line 421 of file UIPstreamBase.C.

◆ read() [6/8]

Foam::Istream & read ( float & val )

virtual

Read a float.

Implements Istream.

Definition at line 428 of file UIPstreamBase.C.

◆ read() [7/8]

Foam::Istream & read ( double & val )

virtual

Read a double.

Implements Istream.

Definition at line 435 of file UIPstreamBase.C.

◆ read() [8/8]

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

virtual

Read binary block with 8-byte alignment.

Implements Istream.

Definition at line 442 of file UIPstreamBase.C.

References Foam::BitOps::count().

Here is the call graph for this function:

◆ readRaw()

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

virtual

Low-level raw binary read.

Implements Istream.

Definition at line 457 of file UIPstreamBase.C.

References Foam::BitOps::count().

Here is the call graph for this function:

◆ beginRawRead()

bool beginRawRead ( )

virtual

Start of low-level raw binary read.

Implements Istream.

Definition at line 468 of file UIPstreamBase.C.

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

Here is the call graph for this function:

◆ endRawRead()

bool endRawRead ( )

inlinevirtual

End of low-level raw binary read.

Implements Istream.

Definition at line 209 of file UIPstream.H.

◆ rewind()

void rewind ( )

virtual

Rewind the receive stream position so that it may be read again.

//- The current get position (tellg) in the buffer label pos() const;

Foam::label Foam::UIPstreamBase::pos() const { return recvBufPos_; }

Implements Istream.

Definition at line 497 of file UIPstreamBase.C.

◆ flags() [2/2]

virtual ios_base::fmtflags flags ( const ios_base::fmtflags )

inlinevirtual

Set flags of stream.

Implements IOstream.

Definition at line 228 of file UIPstream.H.

◆ print()

void print ( Ostream & os ) const

virtual

Print stream description to Ostream.

Reimplemented from IOstream.

Definition at line 509 of file UIPstreamBase.C.

References Foam::endl(), and os().

Here is the call graph for this function:

Member Data Documentation

◆ fromProcNo_

int fromProcNo_

protected

Definition at line 94 of file UIPstream.H.

Referenced by UIPstream::UIPstream().

◆ recvBuf_

DynamicList<char>& recvBuf_

protected

Definition at line 96 of file UIPstream.H.

Referenced by UIPstream::UIPstream().

◆ recvBufPos_

label& recvBufPos_

protected

Definition at line 98 of file UIPstream.H.

◆ tag_

const int tag_

protected

Definition at line 100 of file UIPstream.H.

Referenced by UIPstream::UIPstream().

◆ comm_

const label comm_

protected

Definition at line 102 of file UIPstream.H.

Referenced by UIPstream::UIPstream().

◆ clearAtEnd_

const bool clearAtEnd_

protected

Definition at line 104 of file UIPstream.H.

◆ messageSize_

int messageSize_

protected

Definition at line 106 of file UIPstream.H.

Referenced by UIPstream::UIPstream().

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

src/OpenFOAM/db/IOstreams/Pstreams/UIPstream.H
src/OpenFOAM/db/IOstreams/Pstreams/UIPstreamBase.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UIPstreamBase() [1/2]

◆ UIPstreamBase() [2/2]

◆ ~UIPstreamBase()

Member Function Documentation

◆ flags() [1/2]

◆ read() [1/8]

◆ read() [2/8]

◆ read() [3/8]

◆ read() [4/8]

◆ read() [5/8]

◆ read() [6/8]

◆ read() [7/8]

◆ read() [8/8]

◆ readRaw()

◆ beginRawRead()

◆ endRawRead()

◆ rewind()

◆ flags() [2/2]

◆ print()

Member Data Documentation

◆ fromProcNo_

◆ recvBuf_

◆ recvBufPos_

◆ tag_

◆ comm_

◆ clearAtEnd_

◆ messageSize_