Particle grid data structure for n-D grids. More...

#include <particlegrid.h>

Collaboration diagram for oofem::ParticleGrid< Point >:

Classes
struct	RefinedParticlePoint
	Recursive data structure for. More...

Public Types
typedef ParticleGridIterator< Point >	iterator
	List iterator type. More...

Public Member Functions
	ParticleGrid (const IntArray &res, const FloatArray &bb0, const FloatArray &bb1)
	Creates a new empty particle grid. More...

	ParticleGrid (const ParticleGrid *old)
	Copies structure of old particle grid, but no content. More...

	~ParticleGrid ()
	Destructor. More...

int	giveDimensions ()
	Returns Number of dimensions of grid. More...

int	getTotal () const
	Total number potential points. More...

int	getNumberOfPoints () const
	Number of active points. More...

bool	isEmpty () const
	Returns true if the entire grid is empty. More...

iterator	begin ()
	Returns an iterator over the entire grid (with subgrids) More...

iterator	beginAt (const FloatArray &x0, const FloatArray &x1)
	Returns an iterator over specified region. More...

int	getResolution (int i)
	Returns the resolution in given dimension. More...

double	getGridStep (int i) const
	Returns the grid increment. More...

void	getGridCoord (FloatArray &answer, const IntArray &pos) const
	Gives the real coordinates for the given identifier. More...

void	getGridCoord (FloatArray &answer, int ind) const
	Gives the real coordinates for the given identifier. More...

bool	getPoint (Point *&answer, const IntArray &pos) const
	Gives the point at the position. More...

bool	getPoint (Point *&answer, int ind) const

bool	getSubGrid (ParticleGrid< Point > *&subgrid, const IntArray &pos) const
	Gives the sub-grid at the position. More...

bool	getSubGrid (ParticleGrid< Point > *&subgrid, int ind) const

void	createSubGrid (ParticleGrid< Point > *&subgrid, const IntArray &res, const IntArray &pos)
	Creates a 2 by 2 sub-grid at the given position. More...

void	setPoint (Point *point, const IntArray &pos)
	Sets a point in the grid. More...

void	setPoint (Point *point, int ind)

void	clearPosition (const IntArray &pos)
	Deletes any preexisting data at position. More...

void	clearPosition (int ind)

void	getPointsWithin (std::list< Point * > &answer, const FloatArray &x0, const FloatArray &x1)

void	appendAllPoints (std::list< Point * > &answer)

void	getBoundingBox (const FloatArray &x0, const FloatArray &x1, IntArray &ind0, IntArray &ind1) const
	Finds the indices [ind0, ind1) of the bounding box [x0,x1). More...

void	getPosition (const FloatArray &x, IntArray &pos) const
	Finds the position closest to coordinate x. More...

std::string	errorInfo (const char *func) const

Protected Member Functions
int	giveIndex (const IntArray &pos) const
	Translates from n-D position to total position. More...

void	givePosition (IntArray &pos, int index) const
	Translates from total position to n-D position. More...

void	init (const IntArray &res, const FloatArray &bb0, const FloatArray &bb1)
	Initiation of structure, used by constructors. More...

Protected Attributes
int	n
	Number of dimensions of the grid. More...

IntArray	res
	Resolution in each dimension. More...

int	total
	Total grid points. More...

FloatArray	bb0
	Bounding boxes. More...

FloatArray	bb1

FloatArray	dx
	Grid increments. More...

RefinedParticlePoint **	data
	Particle data structure. More...

IntArray	res_prod
	Helper for index <-> position, the cumulative product of res. More...

Friends
class	ParticleGridIterator< Point >

Detailed Description

template<class Point>
class oofem::ParticleGrid< Point >

Particle grid data structure for n-D grids.

Supports local refinements through recursively implementing sub grids into points.

Author: Mikael Öhman

Definition at line 57 of file particlegrid.h.

Member Typedef Documentation

template<class Point>

typedef ParticleGridIterator<Point> oofem::ParticleGrid< Point >::iterator

List iterator type.

Definition at line 61 of file particlegrid.h.

Constructor & Destructor Documentation

template<class Point >

oofem::ParticleGrid< Point >::ParticleGrid	(	const IntArray &	res,
		const FloatArray &	bb0,
		const FloatArray &	bb1
	)

Creates a new empty particle grid.

Parameters

res	Resolution in respective direction.
bb0	Lower corner of bounding box.
bb1	Upper corner of bounding box.

Definition at line 236 of file particlegrid.h.

template<class Point >

oofem::ParticleGrid< Point >::ParticleGrid ( const ParticleGrid< Point > * old )

Copies structure of old particle grid, but no content.

Parameters

old	ParticleGrid to copy.

Definition at line 242 of file particlegrid.h.

References oofem::ParticleGrid< Point >::bb0, oofem::ParticleGrid< Point >::bb1, and oofem::ParticleGrid< Point >::res.

template<class Point >

oofem::ParticleGrid< Point >::~ParticleGrid ( )

Destructor.

Definition at line 278 of file particlegrid.h.

Member Function Documentation

template<class Point >

void oofem::ParticleGrid< Point >::appendAllPoints ( std::list< Point * > & answer )

Definition at line 430 of file particlegrid.h.

References OOFEM_ERROR, oofem::ParticleGrid< Point >::RefinedParticlePoint::point, and oofem::ParticleGrid< Point >::RefinedParticlePoint::subgrid.

template<class Point >

ParticleGrid< Point >::iterator oofem::ParticleGrid< Point >::begin ( )

Returns an iterator over the entire grid (with subgrids)

Definition at line 383 of file particlegrid.h.

template<class Point >

ParticleGrid< Point >::iterator oofem::ParticleGrid< Point >::beginAt	(	const FloatArray &	x0,
		const FloatArray &	x1
	)

Returns an iterator over specified region.

Definition at line 390 of file particlegrid.h.

Referenced by oofem::ParticleTopologyDescription::addCorner().

template<class Point >

void oofem::ParticleGrid< Point >::clearPosition ( const IntArray & pos )

Deletes any preexisting data at position.

Parameters

[in] pos Position to clear.

Definition at line 486 of file particlegrid.h.

Referenced by oofem::ParticleTopologyDescription::removePoints().

template<class Point >

void oofem::ParticleGrid< Point >::clearPosition ( int ind )

Definition at line 492 of file particlegrid.h.

References oofem::ParticleGrid< Point >::RefinedParticlePoint::point, and oofem::ParticleGrid< Point >::RefinedParticlePoint::subgrid.

template<class Point >

void oofem::ParticleGrid< Point >::createSubGrid	(	ParticleGrid< Point > *&	subgrid,
		const IntArray &	res,
		const IntArray &	pos
	)

Creates a 2 by 2 sub-grid at the given position.

Any existing point or sub-grid is deleted.

Parameters

[out]	subgrid	Newly created sub-grid.
[in]	res	Resolution of new sub-grid.
[in]	pos	Position of sub-grid.

Definition at line 532 of file particlegrid.h.

References oofem::FloatArray::add(), and oofem::ParticleGrid< Point >::RefinedParticlePoint::point.

template<class Point>

std :: string oofem::ParticleGrid< Point >::errorInfo ( const char * func ) const

inline

Definition at line 230 of file particlegrid.h.

template<class Point >

void oofem::ParticleGrid< Point >::getBoundingBox	(	const FloatArray &	x0,
		const FloatArray &	x1,
		IntArray &	ind0,
		IntArray &	ind1
	)		const

Finds the indices [ind0, ind1) of the bounding box [x0,x1).

Parameters

[in]	x0	Lower limit of box.
[in]	x1	Upper limit of box.
[out]	ind0	Lower index corresponding to x0.
[out]	ind1	Upper index

Definition at line 361 of file particlegrid.h.

References oofem::max(), oofem::min(), and oofem::IntArray::resize().

template<class Point >

void oofem::ParticleGrid< Point >::getGridCoord	(	FloatArray &	answer,
		const IntArray &	pos
	)		const

Gives the real coordinates for the given identifier.

Parameters

[out]	answer	The coordinate vector.
[in]	pos	Position for the grid point.

Definition at line 344 of file particlegrid.h.

References oofem::FloatArray::resize().

Referenced by oofem::ParticleGridIterator< Point >::getGridPoint().

template<class Point >

void oofem::ParticleGrid< Point >::getGridCoord	(	FloatArray &	answer,
		int	ind
	)		const

Gives the real coordinates for the given identifier.

Parameters

[out]	answer	The coordinate vector.
[in]	ind	Identifier for the grid point.

Definition at line 353 of file particlegrid.h.

template<class Point>

double oofem::ParticleGrid< Point >::getGridStep ( int i ) const

inline

Returns the grid increment.

Parameters

i	Index of dimension.

Returns: Grid step in dimension i.

Definition at line 152 of file particlegrid.h.

template<class Point >

int oofem::ParticleGrid< Point >::getNumberOfPoints ( ) const

Number of active points.

Definition at line 288 of file particlegrid.h.

References oofem::ParticleGrid< Point >::RefinedParticlePoint::point, and oofem::ParticleGrid< Point >::RefinedParticlePoint::subgrid.

template<class Point >

bool oofem::ParticleGrid< Point >::getPoint	(	Point *&	answer,
		const IntArray &	pos
	)		const

Gives the point at the position.

Parameters

[out]	answer	The point as requested position
[in]	pos	The requested position

Returns: true if point is active, otherwise false

Definition at line 447 of file particlegrid.h.

Referenced by oofem::ParticleTopologyDescription::removePoints().

template<class Point >

bool oofem::ParticleGrid< Point >::getPoint	(	Point *&	answer,
		int	ind
	)		const

Definition at line 459 of file particlegrid.h.

References oofem::ParticleGrid< Point >::RefinedParticlePoint::point.

template<class Point >

void oofem::ParticleGrid< Point >::getPointsWithin	(	std::list< Point * > &	answer,
		const FloatArray &	x0,
		const FloatArray &	x1
	)

Definition at line 399 of file particlegrid.h.

References OOFEM_ERROR, oofem::ParticleGrid< Point >::RefinedParticlePoint::point, and oofem::ParticleGrid< Point >::RefinedParticlePoint::subgrid.

template<class Point >

void oofem::ParticleGrid< Point >::getPosition	(	const FloatArray &	x,
		IntArray &	pos
	)		const

Finds the position closest to coordinate x.

Parameters

[in]	x	Coordinate.
[out]	pos	Position of closest grid point.

Definition at line 372 of file particlegrid.h.

References oofem::max(), oofem::min(), and oofem::IntArray::resize().

template<class Point>

int oofem::ParticleGrid< Point >::getResolution ( int i )

inline

Returns the resolution in given dimension.

Parameters

i	Index of dimension.

Returns: Resolution in dimension i.

Definition at line 144 of file particlegrid.h.

template<class Point >

bool oofem::ParticleGrid< Point >::getSubGrid	(	ParticleGrid< Point > *&	subgrid,
		const IntArray &	pos
	)		const

Gives the sub-grid at the position.

Parameters

[out]	subgrid	Requested sub-grid.
[in]	pos	Position.

Returns: true if sub-grid is active, otherwise false.

Definition at line 526 of file particlegrid.h.

template<class Point >

bool oofem::ParticleGrid< Point >::getSubGrid	(	ParticleGrid< Point > *&	subgrid,
		int	ind
	)		const

Definition at line 508 of file particlegrid.h.

References oofem::ParticleGrid< Point >::RefinedParticlePoint::subgrid.

template<class Point>

int oofem::ParticleGrid< Point >::getTotal ( ) const

inline

Total number potential points.

Definition at line 127 of file particlegrid.h.

Referenced by oofem::ParticleTopologyDescription::removePoints().

template<class Point>

int oofem::ParticleGrid< Point >::giveDimensions ( )

inline

Returns Number of dimensions of grid.

Definition at line 123 of file particlegrid.h.

template<class Point >

int oofem::ParticleGrid< Point >::giveIndex ( const IntArray & pos ) const

protected

Translates from n-D position to total position.

Parameters

pos	n-D position.

Returns: Total position.

Definition at line 325 of file particlegrid.h.

Referenced by oofem::ParticleGridIterator< Point >::operator++(), and oofem::ParticleGridIterator< Point >::ParticleGridIterator().

template<class Point >

void oofem::ParticleGrid< Point >::givePosition	(	IntArray &	pos,
		int	index
	)		const

protected

Translates from total position to n-D position.

Parameters

pos	n-D position.
index	Total position.

Definition at line 335 of file particlegrid.h.

References oofem::IntArray::resize().

template<class Point >

void oofem::ParticleGrid< Point >::init	(	const IntArray &	res,
		const FloatArray &	bb0,
		const FloatArray &	bb1
	)

protected

Initiation of structure, used by constructors.

Parameters

res	Resolution array.
bb0	Lower bounding box.
bb1	Upper bounding box.

Definition at line 248 of file particlegrid.h.

References oofem::IntArray::giveSize().

template<class Point >

bool oofem::ParticleGrid< Point >::isEmpty ( ) const

Returns true if the entire grid is empty.

Definition at line 306 of file particlegrid.h.

References oofem::ParticleGrid< Point >::RefinedParticlePoint::point, and oofem::ParticleGrid< Point >::RefinedParticlePoint::subgrid.

Referenced by oofem::ParticleTopologyDescription::removePoints().

template<class Point >

void oofem::ParticleGrid< Point >::setPoint	(	Point *	point,
		const IntArray &	pos
	)

Sets a point in the grid.

Deletes any preexisting data.

Parameters

[in]	point	Point to set at position pos.
[in]	pos	Position.

Definition at line 453 of file particlegrid.h.

Referenced by oofem::ParticleGridIterator< Point >::setPoint().

template<class Point >

void oofem::ParticleGrid< Point >::setPoint	(	Point *	point,
		int	ind
	)

Definition at line 477 of file particlegrid.h.

References oofem::ParticleGrid< Point >::RefinedParticlePoint::point.

Friends And Related Function Documentation

template<class Point>

friend class ParticleGridIterator< Point >

friend

Definition at line 232 of file particlegrid.h.

Member Data Documentation

template<class Point>

FloatArray oofem::ParticleGrid< Point >::bb0

protected

Bounding boxes.

Definition at line 77 of file particlegrid.h.

Referenced by oofem::ParticleGrid< Point >::ParticleGrid().

template<class Point>

FloatArray oofem::ParticleGrid< Point >::bb1

protected

Definition at line 77 of file particlegrid.h.

Referenced by oofem::ParticleGrid< Point >::ParticleGrid().

template<class Point>

RefinedParticlePoint** oofem::ParticleGrid< Point >::data

protected

Particle data structure.

Definition at line 81 of file particlegrid.h.

Referenced by oofem::ParticleGridIterator< Point >::getPoint(), oofem::ParticleGridIterator< Point >::operator++(), and oofem::ParticleGridIterator< Point >::ParticleGridIterator().

template<class Point>

FloatArray oofem::ParticleGrid< Point >::dx

protected

Grid increments.

Definition at line 79 of file particlegrid.h.

template<class Point>

int oofem::ParticleGrid< Point >::n

protected

Number of dimensions of the grid.

Definition at line 71 of file particlegrid.h.

template<class Point>

IntArray oofem::ParticleGrid< Point >::res

protected

Resolution in each dimension.

Definition at line 73 of file particlegrid.h.

Referenced by oofem::ParticleGrid< Point >::ParticleGrid().

template<class Point>

IntArray oofem::ParticleGrid< Point >::res_prod

protected

Helper for index <-> position, the cumulative product of res.

Definition at line 83 of file particlegrid.h.

template<class Point>

int oofem::ParticleGrid< Point >::total

protected

Total grid points.

Definition at line 75 of file particlegrid.h.

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

particlegrid.h

Classes

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

template<class Point> class oofem::ParticleGrid< Point >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation

template<class Point>
class oofem::ParticleGrid< Point >