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

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 (floatScalar &val)
	Read a floatScalar. More...

Istream &	read (doubleScalar &val)
	Read a doubleScalar. 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...

void	rewind ()
	Rewind 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)
	Construct and set stream status. More...

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

void	putBack (const token &tok)
	Put back token. More...

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

bool	peekBack (token &tok)
	Peek at the put back token without removing it. 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 IOstreamOption option)
	Construct with specified stream option. More...

	IOstream (streamFormat format, versionNumber version, compressionType compression=UNCOMPRESSED)
	Construct with format, version. More...

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

virtual const fileName &	name () const
	Return the name of the stream. More...

virtual fileName &	name ()
	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 bool () const
	Return true if the stream has not failed. More...

bool	operator! () const
	Return true if the stream has failed. More...

unsigned	labelByteSize () const
	The label byte-size associated with the stream. More...

unsigned	scalarByteSize () const
	The scalar byte-size associated with the stream. More...

void	setLabelByteSize (unsigned nbytes)
	Set the label byte-size associated with the stream. More...

void	setScalarByteSize (unsigned nbytes)
	Set the scalar byte-size associated with the stream. More...

template<class T = label>
std::enable_if< std::is_integral< T >::value, bool >::type	checkLabelSize () const

template<class T = scalar>
std::enable_if< std::is_floating_point< T >::value, bool >::type	checkScalarSize () const

label	lineNumber () const
	Const access to the current stream line number. More...

label &	lineNumber ()
	Non-const access to the current stream line number. More...

label	lineNumber (const label num)
	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 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
	IOstreamOption () noexcept
	Construct null. (default: ASCII, uncompressed, currentVersion) More...

	IOstreamOption (streamFormat format) noexcept
	Construct with format. (default: uncompressed, currentVersion) More...

	IOstreamOption (streamFormat format, compressionType compression, versionNumber version=currentVersion) noexcept
	Construct with format and compression, optionally with version. More...

	IOstreamOption (streamFormat format, versionNumber version, compressionType compression) noexcept
	Construct with format, version, compression. More...

streamFormat	format () const noexcept
	Get the current stream format. More...

streamFormat	format (const streamFormat format) 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 &compressionName)
	Set the stream compression, from string value. More...

versionNumber	version () const noexcept
	Get the stream version. More...

versionNumber	version (const versionNumber verNum) noexcept
	Set the stream version. 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)

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 ()
	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 constexpr int	masterNo () noexcept
	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 constexpr int	firstSlave () noexcept
	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 unsigned int	defaultPrecision ()
	Return the default precision. More...

static unsigned int	defaultPrecision (unsigned int prec)
	Reset the default precision. More...

Static Public Member Functions inherited from IOstreamOption
static streamFormat	formatEnum (const word &formatName)
	The stream format enum corresponding to the string. More...

static compressionType	compressionEnum (const word &compName)
	The compression enum corresponding to the string. 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 : char { CLOSED = 0, OPENED }
	Enumeration for stream open/closed state. More...

Public Types inherited from IOstreamOption
enum	streamFormat : char { ASCII, BINARY }
	Data format (ascii \| binary) More...

enum	compressionType : char { UNCOMPRESSED = 0, COMPRESSED }
	Compression treatment (UNCOMPRESSED \| COMPRESSED) More...

Static Public Attributes inherited from UPstream
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 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	originalVersion
	The original version number. More...

static const versionNumber	currentVersion
	The current version number. 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
streamAccess	openClosed_

ios_base::iostate	ioState_

unsigned short	labelByteSize_
	The label byte-size (could also be stored as byte) More...

unsigned short	scalarByteSize_
	The scalar byte-size (could also be stored as byte) More...

label	lineNumber_
	The file line. More...

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

Detailed Description

Input inter-processor communications stream operating on external buffer.

Source files

Definition at line 56 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 36 of file UIPread.C.

References NotImplemented.

◆ UIPstream() [2/2]

UIPstream	(	const int	fromProcNo,
		PstreamBuffers &	buffers
	)

Construct given buffers.

Definition at line 62 of file UIPread.C.

References NotImplemented.

◆ ~UIPstream()

~UIPstream ( )

Destructor.

Definition at line 139 of file UIPstream.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), and Foam::Pout.

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 130 of file UIPstream.H.

◆ read() [1/9]

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 into given buffer from given processor and return the.

message size

Definition at line 81 of file UIPread.C.

References NotImplemented.

Referenced by mapDistributeBase::compact(), Pstream::gather(), Pstream::gatherList(), masterUncollatedFileOperation::NewIFstream(), masterUncollatedFileOperation::read(), Pstream::scatter(), Pstream::scatterList(), OFstreamCollator::write(), decomposedBlockData::writeBlocks(), and masterOFstream::~masterOFstream().

Here is the caller graph for this function:

◆ read() [2/9]

Foam::Istream & read ( token & t )

virtual

Return next token from stream.

Implements Istream.

Definition at line 158 of file UIPstream.C.

References token::ADD, 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::MULTIPLY, token::compound::New(), Foam::processFlags(), Foam::read(), token::setBad(), token::setType(), token::SUBTRACT, and Foam::val.

Here is the call graph for this function:

◆ read() [3/9]

Foam::Istream & read ( char & c )

virtual

Read a character.

Implements Istream.

Definition at line 344 of file UIPstream.C.

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

◆ read() [4/9]

Foam::Istream & read ( word & str )

virtual

Read a word.

Implements Istream.

Definition at line 353 of file UIPstream.C.

◆ read() [5/9]

Foam::Istream & read ( string & )

virtual

Read a string (including enclosing double-quotes)

Implements Istream.

Definition at line 359 of file UIPstream.C.

◆ read() [6/9]

Foam::Istream & read ( label & val )

virtual

Read a label.

Implements Istream.

Definition at line 365 of file UIPstream.C.

References Foam::val.

◆ read() [7/9]

Foam::Istream & read ( floatScalar & val )

virtual

Read a floatScalar.

Implements Istream.

Definition at line 372 of file UIPstream.C.

References Foam::val.

◆ read() [8/9]

Foam::Istream & read ( doubleScalar & val )

virtual

Read a doubleScalar.

Implements Istream.

Definition at line 379 of file UIPstream.C.

References Foam::val.

◆ read() [9/9]

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

virtual

Read binary block with 8-byte alignment.

Implements Istream.

Definition at line 386 of file UIPstream.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 396 of file UIPstream.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 407 of file UIPstream.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 181 of file UIPstream.H.

◆ rewind()

void rewind ( )

virtual

Rewind the stream so that it may be read again.

Implements Istream.

Definition at line 423 of file UIPstream.C.

◆ flags() [2/2]

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

inlinevirtual

Set flags of stream.

Implements IOstream.

Definition at line 193 of file UIPstream.H.

◆ print()

void print ( Ostream & os ) const

virtual

Print description of IOstream to Ostream.

Reimplemented from IOstream.

Definition at line 429 of file UIPstream.C.

References Foam::endl().

Here is the call graph for this function:

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

src/OpenFOAM/db/IOstreams/Pstreams/UIPstream.H
src/OpenFOAM/db/IOstreams/Pstreams/UIPstream.C
src/Pstream/dummy/UIPread.C

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UIPstream() [1/2]

◆ UIPstream() [2/2]

◆ ~UIPstream()

Member Function Documentation

◆ flags() [1/2]

◆ read() [1/9]

◆ read() [2/9]

◆ read() [3/9]

◆ read() [4/9]

◆ read() [5/9]

◆ read() [6/9]

◆ read() [7/9]

◆ read() [8/9]

◆ read() [9/9]

◆ readRaw()

◆ beginRawRead()

◆ endRawRead()

◆ rewind()

◆ flags() [2/2]

◆ print()