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

Inheritance diagram for UOPstream:

Collaboration diagram for UOPstream:

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, streamFormat format=BINARY, versionNumber version=currentVersion)
	Construct given process index to send to and optional buffer size,. More...

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

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 Ostream
	Ostream (const Ostream &)=default
	Copy construct. More...

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

	Ostream (IOstreamOption streamOpt=IOstreamOption())

	Ostream (streamFormat fmt, versionNumber ver=currentVersion, compressionType comp=compressionType::UNCOMPRESSED)
	Construct with format, version (compression) More...

virtual Ostream &	write (const keyType &kw)
	Write keyType. More...

unsigned short	indentSize () const
	Return indent level. More...

unsigned short &	indentSize ()
	Access to indent size. More...

unsigned short	indentLevel () const
	Return indent level. More...

unsigned short &	indentLevel ()
	Access to indent level. More...

void	incrIndent ()
	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...

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

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

	IOstream (IOstreamOption streamOpt=IOstreamOption())

	IOstream (streamFormat fmt, versionNumber ver, compressionType comp=compressionType::UNCOMPRESSED)
	Construct with format, version (compression) 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...

bool	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
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=0)
	Write given buffer to given processor. 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	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=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, 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
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 = 0, 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	currentVersion
	The current version number (2.0) 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 Ostream
unsigned short	indentSize_ = 4
	Number of spaces per indent level. More...

unsigned short	indentLevel_ = 0
	Current indent level. 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 Ostream
static constexpr const unsigned short	entryIndentation_ = 16
	Indentation of the entry from the start of the keyword. More...

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

Detailed Description

Output inter-processor communications stream operating on external buffer.

Source files

Definition at line 57 of file UOPstream.H.

Constructor & Destructor Documentation

◆ UOPstream() [1/2]

UOPstream	(	const commsTypes	commsType,
		const int	toProcNo,
		DynamicList< char > &	sendBuf,
		const int	tag = `UPstream::msgType()`,
		const label	comm = `UPstream::worldComm`,
		const bool	sendAtDestruct = `true`,
		streamFormat	format = `BINARY`,
		versionNumber	version = `currentVersion`
	)

Construct given process index to send to and optional buffer size,.

write format and IO version

Definition at line 122 of file UOPstream.C.

◆ UOPstream() [2/2]

UOPstream	(	const int	toProcNo,
		PstreamBuffers &	buffers
	)

Construct given buffers.

Definition at line 146 of file UOPstream.C.

References IOstream::setGood(), and IOstream::setOpened().

Here is the call graph for this function:

◆ ~UOPstream()

~UOPstream ( )

Destructor.

Definition at line 163 of file UOPstream.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and UOPstream::write().

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 132 of file UOPstream.H.

◆ write() [1/11]

bool write	(	const commsTypes	commsType,
		const int	toProcNo,
		const char *	buf,
		const std::streamsize	bufSize,
		const int	tag = `UPstream::msgType()`,
		const label	communicator = `0`
	)

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(), masterUncollatedFileOperation::readAndSend(), Pstream::scatter(), Pstream::scatterList(), OFstreamCollator::write(), decomposedBlockData::writeBlocks(), and UOPstream::~UOPstream().

Here is the caller graph for this function:

◆ write() [2/11]

bool write ( const token & tok )

virtual

Write token to stream or otherwise handle it.

Returns: false if the token type was not handled by this method

Implements Ostream.

Definition at line 191 of file UOPstream.C.

References token::flagToken(), token::stringToken(), token::type(), and token::wordToken().

Here is the call graph for this function:

◆ write() [3/11]

Foam::Ostream & write ( const char c )

virtual

Write single character. Whitespace is suppressed.

Implements Ostream.

Definition at line 230 of file UOPstream.C.

References Foam::constant::universal::c, and Foam::isspace().

Here is the call graph for this function:

◆ write() [4/11]

Foam::Ostream & write ( const char * str )

virtual

Write the word-characters of a character string.

Sends as a single char, or as word.

Implements Ostream.

Definition at line 241 of file UOPstream.C.

References Foam::vtk::write().

Here is the call graph for this function:

◆ write() [5/11]

Foam::Ostream & write ( const word & str )

virtual

Write word.

Implements Ostream.

Definition at line 258 of file UOPstream.C.

◆ write() [6/11]

Foam::Ostream & write ( const string & str )

virtual

Write string.

Implements Ostream.

Definition at line 267 of file UOPstream.C.

◆ writeQuoted()

Foam::Ostream & writeQuoted	(	const std::string &	str,
		const bool	quoted = `true`
	)

virtual

Write std::string surrounded by quotes.

Optional write without quotes.

Implements Ostream.

Definition at line 277 of file UOPstream.C.

◆ write() [7/11]

Foam::Ostream & write ( const int32_t val )

virtual

Write int32_t as a label.

Implements Ostream.

Definition at line 296 of file UOPstream.C.

◆ write() [8/11]

Foam::Ostream & write ( const int64_t val )

virtual

Write int64_t as a label.

Implements Ostream.

Definition at line 304 of file UOPstream.C.

◆ write() [9/11]

Foam::Ostream & write ( const floatScalar val )

virtual

Write floatScalar.

Implements Ostream.

Definition at line 312 of file UOPstream.C.

◆ write() [10/11]

Foam::Ostream & write ( const doubleScalar val )

virtual

Write doubleScalar.

Implements Ostream.

Definition at line 320 of file UOPstream.C.

◆ write() [11/11]

Foam::Ostream & write	(	const char *	data,
		std::streamsize	count
	)

virtual

Write binary block with 8-byte alignment.

Implements Ostream.

Definition at line 328 of file UOPstream.C.

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

Here is the call graph for this function:

◆ writeRaw()

Foam::Ostream & writeRaw	(	const char *	data,
		std::streamsize	count
	)

virtual

Low-level raw binary output.

Implements Ostream.

Definition at line 344 of file UOPstream.C.

References Foam::BitOps::count().

Here is the call graph for this function:

◆ beginRawWrite()

bool beginRawWrite ( std::streamsize 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 359 of file UOPstream.C.

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

Here is the call graph for this function:

◆ endRawWrite()

virtual bool endRawWrite ( )

inlinevirtual

End marker for low-level raw binary output.

Implements Ostream.

Definition at line 200 of file UOPstream.H.

◆ indent()

virtual void indent ( )

inlinevirtual

Add indentation characters.

Implements Ostream.

Definition at line 206 of file UOPstream.H.

◆ flush()

virtual void flush ( )

inlinevirtual

Flush stream.

Implements Ostream.

Definition at line 213 of file UOPstream.H.

◆ endl()

virtual void endl ( )

inlinevirtual

Add newline and flush stream.

Implements Ostream.

Definition at line 217 of file UOPstream.H.

◆ fill() [1/2]

virtual char fill ( ) const

inlinevirtual

Get the current padding character.

Returns: previous padding character

Implements Ostream.

Definition at line 222 of file UOPstream.H.

◆ fill() [2/2]

virtual char fill ( const char )

inlinevirtual

Set padding character for formatted field up to field width.

Implements Ostream.

Definition at line 228 of file UOPstream.H.

◆ width() [1/2]

virtual int width ( ) const

inlinevirtual

Get width of output field.

Implements Ostream.

Definition at line 234 of file UOPstream.H.

◆ width() [2/2]

virtual int width ( const int )

inlinevirtual

Set width of output field.

Returns: previous width

Implements Ostream.

Definition at line 241 of file UOPstream.H.

◆ precision() [1/2]

virtual int precision ( ) const

inlinevirtual

Get precision of output field.

Implements Ostream.

Definition at line 247 of file UOPstream.H.

◆ precision() [2/2]

virtual int precision ( const int )

inlinevirtual

Set precision of output field.

Returns: old precision

Implements Ostream.

Definition at line 254 of file UOPstream.H.

◆ flags() [2/2]

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

inlinevirtual

Set flags of stream.

Implements IOstream.

Definition at line 263 of file UOPstream.H.

◆ print()

void print ( Ostream & os ) const

virtual

Print stream description to Ostream.

Reimplemented from IOstream.

Definition at line 375 of file UOPstream.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/UOPstream.H
src/OpenFOAM/db/IOstreams/Pstreams/UOPstream.C
src/Pstream/dummy/UOPwrite.C

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UOPstream() [1/2]

◆ UOPstream() [2/2]

◆ ~UOPstream()

Member Function Documentation

◆ flags() [1/2]

◆ write() [1/11]

◆ write() [2/11]

◆ write() [3/11]

◆ write() [4/11]

◆ write() [5/11]

◆ write() [6/11]

◆ writeQuoted()

◆ write() [7/11]

◆ write() [8/11]

◆ write() [9/11]

◆ write() [10/11]

◆ write() [11/11]

◆ writeRaw()

◆ beginRawWrite()

◆ endRawWrite()

◆ indent()

◆ flush()

◆ endl()

◆ fill() [1/2]

◆ fill() [2/2]

◆ width() [1/2]

◆ width() [2/2]

◆ precision() [1/2]

◆ precision() [2/2]

◆ flags() [2/2]

◆ print()