input stream reading from a file in binary form More...

#include <dune/fem/io/streams/sionlibstreams.hh>

Inheritance diagram for Dune::Fem::SIONlibInStream:

Public Types
typedef StandardInStreamTraits	Traits
	type of the traits More...

typedef Traits::InStreamType	InStreamType
	type of the implementation (Barton-Nackman) More...

typedef ThisType	InStreamInterfaceType
	type of the interface More...

Public Member Functions
	SIONlibInStream (const std::string &filename, const int rank=MPIManager ::rank(), MPICommunicatorType mpiComm=MPIHelper ::getCommunicator())
	constructor More...

	~SIONlibInStream ()
	destructor deleting interal data buffer More...

std::istream &	stream ()

void	readDouble (double &value)
	read a double from the stream More...

double	readDouble ()
	read a double from the stream More...

void	readFloat (float &value)
	read a float from the stream More...

float	readFloat ()
	read a double from the stream More...

void	readInt (int &value)
	read an int from the stream More...

int	readInt ()
	read an int from the stream More...

void	readChar (char &value)
	read a char from the stream More...

int	readChar ()
	read a char from the stream More...

void	readBool (bool &value)
	read a bool from the stream More...

bool	readBool ()
	read a bool from the stream More...

void	readString (std::string &s)
	read a string from the stream More...

void	readUnsignedInt (unsigned int &value)
	read an unsigned int from the stream More...

unsigned int	readUnsignedInt ()
	read an unsigned int from the stream More...

void	readUnsignedInt64 (uint64_t &value)
	read an uint64_t from the stream More...

uint64_t	readUnsignedInt64 ()
	read an uint64_t from the stream More...

Protected Member Functions
std::istream &	readFile (const std::string &filename, int rank, MPICommunicatorType mpiComm)

bool	valid () const

template<class T >
void	readPrimitive (T &value)

void	readError () const

const Implementation &	asImp () const

Implementation &	asImp ()

const Implementation &	asImp () const

Static Protected Member Functions
static const Implementation &	asImp (const ThisType &other)

static Implementation &	asImp (ThisType &other)

static const Implementation &	asImp (const ThisType &other)

static Implementation &	asImp (ThisType &other)

Protected Attributes
std::stringstream *	data_
	standard file stream More...

std::istream &	stream_

Related Functions
(Note that these are not member functions.)
InStreamInterface< StreamTraits > &	operator>> (InStreamInterface< StreamTraits > &in, DiscreteFunctionInterface< Impl > &df)
	read a discrete function from an input stream More...

Detailed Description

input stream reading from a file in binary form

Note: This stream directly stores the binary representation of the data. The binary representation might differ between different machines (e.g., little endian vs. big endian).

Newly added:

Member Typedef Documentation

◆ InStreamInterfaceType

typedef ThisType Dune::Fem::InStreamInterface< StandardInStreamTraits >::InStreamInterfaceType

inherited

type of the interface

◆ InStreamType

typedef Traits::InStreamType Dune::Fem::InStreamInterface< StandardInStreamTraits >::InStreamType

inherited

type of the implementation (Barton-Nackman)

◆ Traits

typedef StandardInStreamTraits Dune::Fem::StandardInStream::Traits

inherited

type of the traits

Constructor & Destructor Documentation

◆ SIONlibInStream()

Dune::Fem::SIONlibInStream::SIONlibInStream	(	const std::string &	filename,
		const int	rank = `MPIManager :: rank()`,
		MPICommunicatorType	mpiComm = `MPIHelper :: getCommunicator()`
	)

inline

constructor

Parameters

[in]	filename	name of a file to read from
[in]	rank	process rank data is read for
[in]	mpiComm	MPI communicator (defaults to MPIHelper :: getCommunicator() )

Note: The filename must be the same on all ranks.

◆ ~SIONlibInStream()

Dune::Fem::SIONlibInStream::~SIONlibInStream ( )

inline

destructor deleting interal data buffer

Member Function Documentation

◆ asImp() [1/7]

Implementation& Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp

inlineprotectedinherited

◆ asImp() [2/7]

const Implementation& Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp

inlineprotectedinherited

◆ asImp() [3/7]

template<class Interface , class Implementation >

const Implementation& Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp ( ) const

inlineprotectedinherited

◆ asImp() [4/7]

static const Implementation& Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp

inlinestaticprotectedinherited

◆ asImp() [5/7]

template<class Interface , class Implementation >

static const Implementation& Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp ( const ThisType & other )

inlinestaticprotectedinherited

◆ asImp() [6/7]

static Implementation& Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp

inlinestaticprotectedinherited

◆ asImp() [7/7]

template<class Interface , class Implementation >

static Implementation& Dune::Fem::BartonNackmanInterface< Interface, Implementation >::asImp ( ThisType & other )

inlinestaticprotectedinherited

◆ readBool() [1/2]

bool Dune::Fem::InStreamInterface< StandardInStreamTraits >::readBool ( )

inlineinherited

read a bool from the stream

Returns: a bool read from the stream

◆ readBool() [2/2]

void Dune::Fem::StandardInStream::readBool ( bool & value )

inlineinherited

read a bool from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ readChar() [1/2]

int Dune::Fem::InStreamInterface< StandardInStreamTraits >::readChar ( )

inlineinherited

read a char from the stream

Returns: a char read from the stream

◆ readChar() [2/2]

void Dune::Fem::StandardInStream::readChar ( char & value )

inlineinherited

read a char from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ readDouble() [1/2]

double Dune::Fem::InStreamInterface< StandardInStreamTraits >::readDouble ( )

inlineinherited

read a double from the stream

Returns: a double read from the stream

◆ readDouble() [2/2]

void Dune::Fem::StandardInStream::readDouble ( double & value )

inlineinherited

read a double from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ readError()

void Dune::Fem::InStreamInterface< StandardInStreamTraits >::readError ( ) const

inlineprotectedinherited

◆ readFile()

std::istream& Dune::Fem::SIONlibInStream::readFile	(	const std::string &	filename,
		int	rank,
		MPICommunicatorType	mpiComm
	)

inlineprotected

◆ readFloat() [1/2]

float Dune::Fem::InStreamInterface< StandardInStreamTraits >::readFloat ( )

inlineinherited

read a double from the stream

Returns: a double read from the stream

◆ readFloat() [2/2]

void Dune::Fem::StandardInStream::readFloat ( float & value )

inlineinherited

read a float from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ readInt() [1/2]

int Dune::Fem::InStreamInterface< StandardInStreamTraits >::readInt ( )

inlineinherited

read an int from the stream

Returns: an int read from the stream

◆ readInt() [2/2]

void Dune::Fem::StandardInStream::readInt ( int & value )

inlineinherited

read an int from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ readPrimitive()

template<class T >

void Dune::Fem::StandardInStream::readPrimitive ( T & value )

inlineprotectedinherited

◆ readString()

void Dune::Fem::StandardInStream::readString ( std::string & s )

inlineinherited

read a string from the stream

Parameters

[out] s reference to the string to read from the stream

◆ readUnsignedInt() [1/2]

unsigned int Dune::Fem::InStreamInterface< StandardInStreamTraits >::readUnsignedInt ( )

inlineinherited

read an unsigned int from the stream

Returns: an unsigned int read from the stream

◆ readUnsignedInt() [2/2]

void Dune::Fem::StandardInStream::readUnsignedInt ( unsigned int & value )

inlineinherited

read an unsigned int from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ readUnsignedInt64() [1/2]

uint64_t Dune::Fem::InStreamInterface< StandardInStreamTraits >::readUnsignedInt64 ( )

inlineinherited

read an uint64_t from the stream

Returns: an uint64_t read from the stream

◆ readUnsignedInt64() [2/2]

void Dune::Fem::StandardInStream::readUnsignedInt64 ( uint64_t & value )

inlineinherited

read an uint64_t from the stream

Parameters

[out] value reference to the variable to read from the stream

◆ stream()

std::istream& Dune::Fem::StandardInStream::stream ( )

inlineinherited

return reference to internal istream

◆ valid()

bool Dune::Fem::StandardInStream::valid ( ) const

inlineprotectedinherited

Friends And Related Function Documentation

◆ operator>>()

InStreamInterface< StreamTraits > & operator>>	(	InStreamInterface< StreamTraits > &	in,
		DiscreteFunctionInterface< Impl > &	df
	)

Parameters

[in]	in	stream to read from
[out]	df	discrete function to read

Returns: the input stream (for concatenation)

Member Data Documentation

◆ data_

std::stringstream* Dune::Fem::SIONlibInStream::data_

protected

standard file stream

◆ stream_

std::istream& Dune::Fem::StandardInStream::stream_

protectedinherited

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

sionlibstreams.hh

Public Types

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Related Functions

Detailed Description

Member Typedef Documentation

◆ InStreamInterfaceType

◆ InStreamType

◆ Traits

Constructor & Destructor Documentation

◆ SIONlibInStream()

◆ ~SIONlibInStream()

Member Function Documentation

◆ asImp() [1/7]

◆ asImp() [2/7]

◆ asImp() [3/7]

◆ asImp() [4/7]

◆ asImp() [5/7]

◆ asImp() [6/7]

◆ asImp() [7/7]

◆ readBool() [1/2]

◆ readBool() [2/2]

◆ readChar() [1/2]

◆ readChar() [2/2]

◆ readDouble() [1/2]

◆ readDouble() [2/2]

◆ readError()

◆ readFile()

◆ readFloat() [1/2]

◆ readFloat() [2/2]

◆ readInt() [1/2]

◆ readInt() [2/2]

◆ readPrimitive()

◆ readString()

◆ readUnsignedInt() [1/2]

◆ readUnsignedInt() [2/2]

◆ readUnsignedInt64() [1/2]

◆ readUnsignedInt64() [2/2]

◆ stream()

◆ valid()

Friends And Related Function Documentation

◆ operator>>()

Member Data Documentation

◆ data_

◆ stream_