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

Inheritance diagram for UIPstream:

[legend]

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 &)
	Return next token from stream. More...

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

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

Istream &	read (string &)

Istream &	read (int32_t &)
	Read an int32_t. More...

Istream &	read (int64_t &)
	Read an int64_t. More...

Istream &	read (uint32_t &)
	Read a uint32_t. More...

Istream &	read (uint64_t &)
	Read a uint64_t. More...

Istream &	read (floatScalar &)
	Read a floatScalar. More...

Istream &	read (doubleScalar &)
	Read a doubleScalar. More...

Istream &	read (longDoubleScalar &)
	Read a longDoubleScalar. More...

Istream &	read (char *, std::streamsize)
	Read binary block. More...

Istream &	rewind ()
	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...

Istream &	readBegin (const char *funcName)

Istream &	readEnd (const char *funcName)

Istream &	readEndBegin (const char *funcName)

char	readBeginList (const char *funcName)

char	readEndList (const char *funcName)

Istream &	operator() () 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 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 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...

label &	lineNumber ()
	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< IOstream >	info () 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 class	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	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 33 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.

◆ ~UIPstream()

~UIPstream ( )

Destructor.

Definition at line 82 of file UIPstream.C.

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

◆ read() [1/13]

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 78 of file UIPread.C.

References NotImplemented.

Referenced by Pstream::combineGather(), Pstream::combineScatter(), distributionMapBase::compact(), processorLduInterface::compressedReceive(), processorLduInterface::compressedSend(), distributionMapBase::distribute(), Pstream::exchange(), globalIndex::gather(), Pstream::gather(), Pstream::gatherList(), processorFvPatchField< Type >::initEvaluate(), processorFvPatchField< Type >::initInterfaceMatrixUpdate(), processorGAMGInterfaceField::initInterfaceMatrixUpdate(), processorFvsPatchField< Type >::initPatchNeighbourField(), Pstream::listCombineGather(), Pstream::listCombineScatter(), masterUncollatedFileOperation::NewIFstream(), processorFvsPatchField< Type >::patchNeighbourField(), masterUncollatedFileOperation::read(), processorLduInterface::receive(), globalIndex::scatter(), Pstream::scatter(), Pstream::scatterList(), processorLduInterface::send(), LUscalarMatrix::solve(), OFstreamCollator::write(), decomposedBlockData::writeBlocks(), and masterOFstream::~masterOFstream().

Here is the caller graph for this function:

◆ read() [2/13]

Foam::Istream & read ( token & t )

virtual

Return next token from stream.

Implements Istream.

Definition at line 101 of file UIPstream.C.

References Foam::abort(), token::ADD, token::ASSIGN, token::BEGIN_BLOCK, token::BEGIN_LIST, token::BEGIN_SQR, Foam::constant::universal::c, token::COLON, token::COMMA, token::DIVIDE, token::DOUBLE_SCALAR, token::END_BLOCK, token::END_LIST, token::END_SQR, token::END_STATEMENT, Foam::FatalError, FatalErrorInFunction, token::FLOAT_SCALAR, token::FUNCTIONNAME, Istream::getBack(), token::INTEGER_32, token::INTEGER_64, token::compound::isCompound(), token::lineNumber(), token::LONG_DOUBLE_SCALAR, token::MULTIPLY, token::compound::New(), Foam::read(), token::setBad(), token::STRING, token::SUBTRACT, token::UNSIGNED_INTEGER_32, token::UNSIGNED_INTEGER_64, token::VARIABLE, token::VERBATIMSTRING, and token::WORD.

Here is the call graph for this function:

◆ read() [3/13]

Foam::Istream & read ( char & c )

virtual

Read a character.

Implements Istream.

Definition at line 349 of file UIPstream.C.

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

◆ read() [4/13]

Foam::Istream & read ( word & str )

virtual

Read a word.

Implements Istream.

Definition at line 358 of file UIPstream.C.

◆ read() [5/13]

Foam::Istream & read ( string & str )

virtual

Implements Istream.

Definition at line 369 of file UIPstream.C.

◆ read() [6/13]

Foam::Istream & read ( int32_t & val )

virtual

Read an int32_t.

Implements Istream.

Definition at line 380 of file UIPstream.C.

◆ read() [7/13]

Foam::Istream & read ( int64_t & val )

virtual

Read an int64_t.

Implements Istream.

Definition at line 387 of file UIPstream.C.

◆ read() [8/13]

Foam::Istream & read ( uint32_t & val )

virtual

Read a uint32_t.

Implements Istream.

Definition at line 394 of file UIPstream.C.

◆ read() [9/13]

Foam::Istream & read ( uint64_t & val )

virtual

Read a uint64_t.

Implements Istream.

Definition at line 401 of file UIPstream.C.

◆ read() [10/13]

Foam::Istream & read ( floatScalar & val )

virtual

Read a floatScalar.

Implements Istream.

Definition at line 408 of file UIPstream.C.

◆ read() [11/13]

Foam::Istream & read ( doubleScalar & val )

virtual

Read a doubleScalar.

Implements Istream.

Definition at line 415 of file UIPstream.C.

◆ read() [12/13]

Foam::Istream & read ( longDoubleScalar & val )

virtual

Read a longDoubleScalar.

Implements Istream.

Definition at line 422 of file UIPstream.C.

◆ read() [13/13]

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

virtual

Read binary block.

Implements Istream.

Definition at line 429 of file UIPstream.C.

References Foam::abort(), Foam::count(), Foam::FatalError, FatalErrorInFunction, and 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 443 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 183 of file UIPstream.H.

◆ print()

void print ( Ostream & os ) const

virtual

Print description of IOstream to Ostream.

Reimplemented from IOstream.

Definition at line 450 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/13]

◆ read() [2/13]

◆ read() [3/13]

◆ read() [4/13]

◆ read() [5/13]

◆ read() [6/13]

◆ read() [7/13]

◆ read() [8/13]

◆ read() [9/13]

◆ read() [10/13]

◆ read() [11/13]

◆ read() [12/13]

◆ read() [13/13]

◆ rewind()

◆ flags() [2/2]

◆ print()