A file reader. More...

#include <FileReader.h>

Collaboration diagram for toolbox::particles::FileReader:

[legend]

Public Member Functions
void	readDatFile (const std::string &filename, const double scale)
	Read DAT file.

std::list< tarch::la::Vector< Dimensions, double > >	getParticlesWithinVoxel (const tarch::la::Vector< Dimensions, double > &x, const tarch::la::Vector< Dimensions, double > &h, bool remove)
	Take particles from database which fall into given voxel.

void	clear ()

bool	empty () const

bool	getNumberOfCoordinates () const

Private Attributes
std::list< tarch::la::Vector< Dimensions, double > >	_data

Static Private Attributes
static tarch::logging::Log	_log

Detailed Description

A file reader.

The file reader realises one big table

Definition at line 25 of file FileReader.h.

Member Function Documentation

◆ clear()

void toolbox::particles::FileReader::clear ( )

Referenced by peano4.api.output.Makefile.Makefile::__init__().

Here is the caller graph for this function:

◆ empty()

bool toolbox::particles::FileReader::empty ( ) const

◆ getNumberOfCoordinates()

bool toolbox::particles::FileReader::getNumberOfCoordinates ( ) const

◆ getParticlesWithinVoxel()

std::list< tarch::la::Vector< Dimensions, double > > toolbox::particles::FileReader::getParticlesWithinVoxel	(	const tarch::la::Vector< Dimensions, double > &	x,
		const tarch::la::Vector< Dimensions, double > &	h,
		bool	remove
	)

Take particles from database which fall into given voxel.

Overlapping vs. non-overlapping domain decomposition

In an SPMD environment, it is convenient to make each rank maintain its own input database. As a consequence, ranks have redundant particles and we will have to clean up eventually. To mirror this behaviour in the multithreaded context, we can remove particles whenever we assign them to an inner vertex, but we should also hand them out redundantly for boundary vertices.

Parameters

x	Center of voxel. If you use this within touchVertexFirstTime(), you can use the vertex position, i.e. the x() operation of the marker. If you use this function within a cell event, you can use x() as well, as it returns the centre.
h	Size of voxel. If you use this function within a cell event, just pass in h(). If you use it within a vertex event, you should scale h with 0.5.
remove	Remove a particle form the internal database if it is a match. In most cases, removing the particles immediately speeds up things, even though we then have a lot of (uneccessary) locks.

See also: peano4::datamanagement::CellMarker::x(); peano4::datamanagement::VertexMarker::x()

◆ readDatFile()

void toolbox::particles::FileReader::readDatFile	(	const std::string &	filename,
		const double	scale
	)

Read DAT file.

A dat file is a simple text file where we have one particle description per line. Each line holds exactly Dimensions double values.

Field Documentation

◆ _data

std::list< tarch::la::Vector<Dimensions,double> > toolbox::particles::FileReader::_data

private

Definition at line 29 of file FileReader.h.

Referenced by peano4.api.datamodel.DaStGen2.DaStGen2Generator::construct_output(), peano4.api.datamodel.DaStGen2.DaStGen2GeneratorForObjectsWithSmartPointers::construct_output(), peano4.api.toolbox.particles.ParticleSet.ParticleSetGenerator_ScatteredOnHeap_IndexByList::construct_output(), peano4.api.toolbox.particles.ParticleSet.ParticleSetGenerator_ScatteredOnHeap_IndexByVector::construct_output(), peano4.api.toolbox.particles.ParticleSet.ParticleSetGenerator_ContinuousPerVertex::construct_output(), peano4.api.toolbox.particles.ParticleSet.ParticleSetGenerator_GlobalContinuous::construct_output(), peano4.api.datamodel.DaStGen2.DaStGen2Generator::get_header_file_include(), peano4.api.datamodel.DaStGen2.DaStGen2GeneratorForObjectsWithSmartPointers::get_header_file_include(), peano4.api.toolbox.particles.ParticleSet.AbstractParticleSetGenerator::get_header_file_include(), peano4.api.datamodel.DaStGen2.DaStGen2Generator::get_stack_container(), peano4.api.datamodel.DaStGen2.DaStGen2GeneratorForObjectsWithSmartPointers::get_stack_container(), peano4.api.datamodel.DynamicArrayOverPrimitivesToStdVector.DynamicArrayOverPrimitivesToStdVector::get_stack_container(), and peano4.api.toolbox.particles.ParticleSet.AbstractParticleSetGenerator::get_stack_container().

◆ _log

tarch::logging::Log toolbox::particles::FileReader::_log

staticprivate

Definition at line 27 of file FileReader.h.

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

src/toolbox/particles/FileReader.h

Public Member Functions

Private Attributes

Static Private Attributes