walberla::geometry::BasicVoxelFileReader< T > Class Template Reference

Detailed Description

template<typename T>
class walberla::geometry::BasicVoxelFileReader< T >

Provides a low level reader for waLBerla geometry files.

Template Parameters

T	The underlying datatype that is stored in binary form in the geometry file

#include <BasicVoxelFileReader.h>

Public Member Functions
	BasicVoxelFileReader ()
	Constructs on empty geometry file.
	BasicVoxelFileReader (const std::string &_filename)
	Opens an existing geometry file.
	BasicVoxelFileReader (const std::string &_filename, std::size_t _xSize, std::size_t _ySize, std::size_t _zSize, T value=T())
	Creates a new geometry file with extends xSize x ySize x zSize.
	BasicVoxelFileReader (const std::string &_filename, std::size_t _xSize, std::size_t _ySize, std::size_t _zSize, const T *values)
	Creates a new geometry file with extends xSize x ySize x zSize.
	~BasicVoxelFileReader ()
	Destructor that closes the file if necessary.
void	open (const std::string &_filename)
	Opens an existing geometry file.
void	create (const std::string &_filename, std::size_t _xSize, std::size_t _ySize, std::size_t _zSize, T value=T())
	Creates a new geometry file with extends xSize x ySize x zSize.
void	create (const std::string &_filename, std::size_t _xSize, std::size_t _ySize, std::size_t _zSize, const T *values)
	Creates a new geometry file with extends xSize x ySize x zSize.
void	close ()
	Closes an opened geometry file.
bool	isOpen () const
	Query if a geometry file is open.
const std::string &	filename () const
	Gets the filename of the opened geometry file.
std::size_t	numCells () const
	Gets the number of cells of the currently loaded geometry file.
std::size_t	xSize () const
	Gets the extend of the geometry file in x direction.
std::size_t	ySize () const
	Gets the extend of the geometry file in y direction.
std::size_t	zSize () const
	Gets the extend of the geometry file in z direction.
void	read (const CellAABB &cellAABB, std::vector< T > &data) const
	Reads a block of data from the opened geometry file.
void	write (const CellAABB &cellAABB, const std::vector< T > &data)
	Writes a block of data to the geometry file.

Private Attributes
std::fstream	filestream_
	fstream object managing the opened file
std::string	filename_
	Filename of the geometry file currently opened.
std::streampos	dataBegin_
	Position in the stream where to raw data starts.
std::size_t	xSize_
	Extend of the currently open geometry file in x direction.
std::size_t	ySize_
	Extend of the currently open geometry file in y direction.
std::size_t	zSize_
	Extend of the currently open geometry file in z direction.

Constructor & Destructor Documentation

BasicVoxelFileReader() [1/4]

template<typename T >

walberla::geometry::BasicVoxelFileReader< T >::BasicVoxelFileReader

(

)

Constructs on empty geometry file.

Postcondition

isOpen() == false

BasicVoxelFileReader() [2/4]

template<typename T >

walberla::geometry::BasicVoxelFileReader< T >::BasicVoxelFileReader

(

const std::string &

_filename

)

Opens an existing geometry file.

Parameters

_filename

Name (path) of the file.

Exceptions

std::runtime_error

on I/O errors.

Postcondition

isOpen() == true

BasicVoxelFileReader() [3/4]

template<typename T >

walberla::geometry::BasicVoxelFileReader< T >::BasicVoxelFileReader	(	const std::string &	_filename,
		std::size_t	_xSize,
		std::size_t	_ySize,
		std::size_t	_zSize,
		T	value = T() )

Creates a new geometry file with extends xSize x ySize x zSize.

Parameters

_filename	Name (path) of the file.
_xSize	Extend of the geometry file in x direction.
_ySize	Extend of the geometry file in y direction.
_zSize	Extend of the geometry file in z direction.
value	The value the cells are initialized with. Defaults to T().

Exceptions

std::runtime_error

on I/O errors.

Postcondition

isOpen() == true

BasicVoxelFileReader() [4/4]

template<typename T >

walberla::geometry::BasicVoxelFileReader< T >::BasicVoxelFileReader	(	const std::string &	_filename,
		std::size_t	_xSize,
		std::size_t	_ySize,
		std::size_t	_zSize,
		const T *	values )

Creates a new geometry file with extends xSize x ySize x zSize.

Parameters

_filename	Name (path) of the file.
_xSize	Extend of the geometry file in x direction.
_ySize	Extend of the geometry file in y direction.
_zSize	Extend of the geometry file in z direction.
values	An array of size xSize * ySize * zSize with the values to initialize the geometry file with.

Exceptions

std::runtime_error

on I/O errors.

Precondition

values != nullptr

Postcondition

isOpen() == true

~BasicVoxelFileReader()

template<typename T >

walberla::geometry::BasicVoxelFileReader< T >::~BasicVoxelFileReader

(

)

Destructor that closes the file if necessary.

Member Function Documentation

close()

template<typename T >

void walberla::geometry::BasicVoxelFileReader< T >::close

(

)

Closes an opened geometry file.

If no geometry file is open, this does nothing.

Postcondition

isOpen() == false

create() [1/2]

template<typename T >

void walberla::geometry::BasicVoxelFileReader< T >::create	(	const std::string &	_filename,
		std::size_t	_xSize,
		std::size_t	_ySize,
		std::size_t	_zSize,
		const T *	values )

Creates a new geometry file with extends xSize x ySize x zSize.

An already opened file gets closed beforehand.

Parameters

_filename	Name (path) of the file.
_xSize	Extend of the geometry file in x direction.
_ySize	Extend of the geometry file in y direction.
_zSize	Extend of the geometry file in z direction.
values	An array of size xSize * ySize * zSize with the values to initialize the geometry file with.

Exceptions

std::runtime_error

on I/O errors.

Precondition

values != nullptr

Postcondition

isOpen() == true

create() [2/2]

template<typename T >

void walberla::geometry::BasicVoxelFileReader< T >::create	(	const std::string &	_filename,
		std::size_t	_xSize,
		std::size_t	_ySize,
		std::size_t	_zSize,
		T	value = T() )

Creates a new geometry file with extends xSize x ySize x zSize.

An already opened file gets closed beforehand.

Parameters

_filename	Name (path) of the file.
_xSize	Extend of the geometry file in x direction.
_ySize	Extend of the geometry file in y direction.
_zSize	Extend of the geometry file in z direction.
value	The value the cells are initialized with. Defaults to T().

Exceptions

std::runtime_error

on I/O errors.

Postcondition

isOpen() == true

filename()

template<typename T >

const std::string & walberla::geometry::BasicVoxelFileReader< T >::filename

(

)

const

Gets the filename of the opened geometry file.

Precondition

isOpen() == true

Returns

The filename of the opened geometry file.

isOpen()

template<typename T >

bool walberla::geometry::BasicVoxelFileReader< T >::isOpen

(

)

const

Query if a geometry file is open.

Returns

true if a file is opened, false if not.

numCells()

template<typename T >

std::size_t walberla::geometry::BasicVoxelFileReader< T >::numCells

(

)

const

Gets the number of cells of the currently loaded geometry file.

Precondition

isOpen() == true

Returns

xSize() * ySize() * zSize().

open()

template<typename T >

void walberla::geometry::BasicVoxelFileReader< T >::open

(

const std::string &

_filename

)

Opens an existing geometry file.

An already opened file gets closed beforehand.

Parameters

_filename

Name (path) of the file.

Exceptions

std::runtime_error	on I/O errors.
std::runtime_error	if the loaded geometry file's format is corrupt

Postcondition

isOpen() == true

read()

template<typename T >

void walberla::geometry::BasicVoxelFileReader< T >::read	(	const CellAABB &	cellAABB,
		std::vector< T > &	data ) const

Reads a block of data from the opened geometry file.

Parameters

	cellAABB	The axis-aligned bounding box of the block of data to be read.
[out]	data	The vector the read data is stored to. The Storage order is zyx. (Meaning your innermost loop should iterate over x)

Exceptions

std::runtime_error

on I/O errors.

Precondition

isOpen() == true

cellAABB.xEnd < xSize()

cellAABB.yEnd < ySize()

cellAABB.zEnd < zSize()

Postcondition

data.size() == cellAABB.numCells()

write()

template<typename T >

void walberla::geometry::BasicVoxelFileReader< T >::write	(	const CellAABB &	cellAABB,
		const std::vector< T > &	data )

Writes a block of data to the geometry file.

Parameters

cellAABB	The axis-aligned bounding box of the block of data to be written.
data	The vector holding the data to bw written to the geometry file. The Storage order is zyx. (Meaning your innermost loop should iterate over x)

Exceptions

std::runtime_error

on I/O errors.

Precondition

isOpen() == true

cellAABB.xEnd < xSize()

cellAABB.yEnd < ySize()

cellAABB.zEnd < zSize()

data.size() >= cellAABB.numCells()

xSize()

template<typename T >

std::size_t walberla::geometry::BasicVoxelFileReader< T >::xSize

(

)

const

Gets the extend of the geometry file in x direction.

Precondition

isOpen() == true

Returns

The extend of the geometry file in x direction.

ySize()

template<typename T >

std::size_t walberla::geometry::BasicVoxelFileReader< T >::ySize

(

)

const

Gets the extend of the geometry file in y direction.

Precondition

isOpen() == true

Returns

The extend of the geometry file in y direction.

zSize()

template<typename T >

std::size_t walberla::geometry::BasicVoxelFileReader< T >::zSize

(

)

const

Gets the extend of the geometry file in z direction.

Precondition

isOpen() == true

Returns

The extend of the geometry file in z direction.

Member Data Documentation

dataBegin_

template<typename T >

std::streampos walberla::geometry::BasicVoxelFileReader< T >::dataBegin_

private

Position in the stream where to raw data starts.

filename_

template<typename T >

std::string walberla::geometry::BasicVoxelFileReader< T >::filename_

private

Filename of the geometry file currently opened.

filestream_

template<typename T >

std::fstream walberla::geometry::BasicVoxelFileReader< T >::filestream_

mutableprivate

fstream object managing the opened file

xSize_

template<typename T >

std::size_t walberla::geometry::BasicVoxelFileReader< T >::xSize_

private

Extend of the currently open geometry file in x direction.

ySize_

template<typename T >

std::size_t walberla::geometry::BasicVoxelFileReader< T >::ySize_

private

Extend of the currently open geometry file in y direction.

zSize_

template<typename T >

std::size_t walberla::geometry::BasicVoxelFileReader< T >::zSize_

private

Extend of the currently open geometry file in z direction.

---

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

• /builds/administration/walberla-website/walberla/src/geometry/structured/BasicVoxelFileReader.h
• /builds/administration/walberla-website/walberla/src/geometry/structured/BasicVoxelFileReader.impl.h