IPstream Class Reference

Input inter-processor communications stream. More...

Inheritance diagram for IPstream:

[legend]

Collaboration diagram for IPstream:

[legend]

List of all members.

Public Member Functions
	IPstream (const commsTypes commsType, const int fromProcNo, const label bufSize=0, streamFormat format=BINARY, versionNumber version=currentVersion)
	Construct given process index to read from and optional buffer size,.
	~IPstream ()
ios_base::fmtflags	flags () const
	Return flags of output stream.
Istream &	read (token &)
	Return next token from stream.
Istream &	read (char &)
	Read a character.
Istream &	read (word &)
	Read a word.
Istream &	read (string &)
Istream &	read (label &)
	Read a label.
Istream &	read (floatScalar &)
	Read a floatScalar.
Istream &	read (doubleScalar &)
	Read a doubleScalar.
Istream &	read (char *, std::streamsize)
	Read binary block.
Istream &	rewind ()
	Rewind and return the stream so that it may be read again.
ios_base::fmtflags	flags (const ios_base::fmtflags)
	Set flags of stream.
void	print (Ostream &) const
	Print description of IOstream to Ostream.
Static Public Member Functions
static label	read (const commsTypes commsType, const int fromProcNo, char *buf, const std::streamsize bufSize)
	Read into given buffer from given processor and return the.
static void	waitRequests ()
	Non-blocking receives: wait until all have finished.
static bool	finishedRequest (const label i)
	Non-blocking receives: has request i finished?

---

Detailed Description

Input inter-processor communications stream.

Source files

• IPstream.H
• IPstream.C

Definition at line 46 of file IPstream.H.

---

Constructor & Destructor Documentation

fileScope IPstream	(	const commsTypes	commsType,
		const int	fromProcNo,
		const label	bufSize = 0,
		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 30 of file IPread.C.

References notImplemented.

~IPstream

(

)

Definition at line 71 of file IPstream.C.

---

Member Function Documentation

ios_base::fmtflags flags

(

)

const [inline, virtual]

Return flags of output stream.

Implements IOstream.

Definition at line 98 of file IPstream.H.

Foam::label read	(	const commsTypes	commsType,
		const int	fromProcNo,
		char *	buf,
		const std::streamsize	bufSize
	)			[static]

Read into given buffer from given processor and return the.

message size

Definition at line 59 of file IPread.C.

Referenced by Pstream::combineGather(), mapDistribute::distribute(), Pstream::gather(), Pstream::gatherList(), Foam::handler(), Pstream::listCombineGather(), processorLduInterface::send(), LUscalarMatrix::solve(), and syncTools::syncBoundaryFaceList().

Here is the caller graph for this function:

void waitRequests

(

)

[static]

Non-blocking receives: wait until all have finished.

Definition at line 81 of file IPread.C.

Referenced by mapDistribute::distribute().

Here is the caller graph for this function:

bool finishedRequest

(

const label

i

)

[static]

Non-blocking receives: has request i finished?

Definition at line 85 of file IPread.C.

Foam::Istream & read

(

token &

t

)

[virtual]

Return next token from stream.

Implements Istream.

Definition at line 78 of file IPstream.C.

Foam::Istream & read

(

char &

c

)

[virtual]

Read a character.

Implements Istream.

Definition at line 224 of file IPstream.C.

Foam::Istream & read

(

word &

str

)

[virtual]

Read a word.

Implements Istream.

Definition at line 233 of file IPstream.C.

References Pstream::buf_, and Pstream::bufPosition_.

Foam::Istream & read

(

string &

str

)

[virtual]

Implements Istream.

Definition at line 244 of file IPstream.C.

Foam::Istream & read

(

label &

val

)

[virtual]

Read a label.

Implements Istream.

Definition at line 255 of file IPstream.C.

Foam::Istream & read

(

floatScalar &

val

)

[virtual]

Read a floatScalar.

Implements Istream.

Definition at line 262 of file IPstream.C.

Foam::Istream & read

(

doubleScalar &

val

)

[virtual]

Read a doubleScalar.

Implements Istream.

Definition at line 269 of file IPstream.C.

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

Read binary block.

Implements Istream.

Definition at line 276 of file IPstream.C.

Foam::Istream & rewind

(

)

[virtual]

Rewind and return the stream so that it may be read again.

Implements Istream.

Definition at line 290 of file IPstream.C.

ios_base::fmtflags flags

(

const ios_base::fmtflags

)

[inline]

Set flags of stream.

Definition at line 155 of file IPstream.H.

void print

(

Ostream &

os

)

const [virtual]

Print description of IOstream to Ostream.

Reimplemented from IOstream.

Definition at line 27 of file PstreamsPrint.C.

---

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

• src/OpenFOAM/db/IOstreams/Pstreams/IPstream.H
• src/OpenFOAM/db/IOstreams/Pstreams/IPstream.C
• src/OpenFOAM/db/IOstreams/Pstreams/PstreamsPrint.C
• src/Pstream/dummy/IPread.C
• src/Pstream/gamma/IPread.C
• src/Pstream/mpi/IPread.C