#include <BoxSpatialGrid.hpp>

Inheritance diagram for BoxSpatialGrid:

[legend]

Public Member Functions
Box	boundingBox () const override

int	dimension () const override

double	maxX () const

double	maxY () const

double	maxZ () const

double	minX () const

double	minY () const

double	minZ () const

Public Member Functions inherited from SpatialGrid
virtual Box	boundingBox () const =0

virtual int	cellIndex (Position bfr) const =0

virtual Position	centralPositionInCell (int m) const =0

virtual std::unique_ptr< PathSegmentGenerator >	createPathSegmentGenerator () const =0

virtual double	diagonal (int m) const =0

virtual int	dimension () const =0

virtual int	numCells () const =0

virtual Position	randomPositionInCell (int m) const =0

virtual double	volume (int m) const =0

virtual void	writeGridPlotFiles (const SimulationItem *probe) const

Public Member Functions inherited from SimulationItem
template<class T >
T *	find (bool setup=true) const

template<class T >
T *	interface (int levels=-999999, bool setup=true) const

virtual string	itemName () const

void	setup ()

string	typeAndName () const

Public Member Functions inherited from Item
	Item (const Item &)=delete

virtual	~Item ()

void	addChild (Item *child)

const vector< Item * > &	children () const

virtual void	clearItemListProperty (const PropertyDef *property)

void	destroyChild (Item *child)

virtual bool	getBoolProperty (const PropertyDef *property) const

virtual vector< double >	getDoubleListProperty (const PropertyDef *property) const

virtual double	getDoubleProperty (const PropertyDef *property) const

virtual string	getEnumProperty (const PropertyDef *property) const

virtual int	getIntProperty (const PropertyDef *property) const

virtual vector< Item * >	getItemListProperty (const PropertyDef *property) const

virtual Item *	getItemProperty (const PropertyDef *property) const

virtual string	getStringProperty (const PropertyDef *property) const

int	getUtilityProperty (string name) const

virtual void	insertIntoItemListProperty (const PropertyDef property, int index, Item item)

Item &	operator= (const Item &)=delete

Item *	parent () const

virtual void	removeFromItemListProperty (const PropertyDef *property, int index)

virtual void	setBoolProperty (const PropertyDef *property, bool value)

virtual void	setDoubleListProperty (const PropertyDef *property, vector< double > value)

virtual void	setDoubleProperty (const PropertyDef *property, double value)

virtual void	setEnumProperty (const PropertyDef *property, string value)

virtual void	setIntProperty (const PropertyDef *property, int value)

virtual void	setItemProperty (const PropertyDef property, Item item)

virtual void	setStringProperty (const PropertyDef *property, string value)

void	setUtilityProperty (string name, int value)

virtual string	type () const

Public Member Functions inherited from Box
	Box ()

	Box (double xmin, double ymin, double zmin, double xmax, double ymax, double zmax)

	Box (Vec rmin, Vec rmax)

void	cellIndices (int &i, int &j, int &k, Vec r, int nx, int ny, int nz) const

Vec	center () const

bool	contains (const Box &box) const

bool	contains (double x, double y, double z) const

bool	contains (Vec r) const

double	diagonal () const

const Box &	extent () const

void	extent (double &xmin, double &ymin, double &zmin, double &xmax, double &ymax, double &zmax) const

Vec	fracPos (double xfrac, double yfrac, double zfrac) const

Vec	fracPos (int xd, int yd, int zd, int xn, int yn, int zn) const

bool	intersects (const Box &box) const

bool	intersects (Vec r, const Vec k, double &smin, double &smax) const

bool	intersects (Vec rc, double r) const

Vec	rmax () const

Vec	rmin () const

double	volume () const

Vec	widths () const

double	xmax () const

double	xmin () const

double	xwidth () const

double	ymax () const

double	ymin () const

double	ywidth () const

double	zmax () const

double	zmin () const

double	zwidth () const

Protected Member Functions
	BoxSpatialGrid ()

void	setupSelfBefore () override

Protected Member Functions inherited from SpatialGrid
	SpatialGrid ()

Random *	random () const

void	setupSelfBefore () override

virtual void	write_xy (SpatialGridPlotFile *outfile) const

virtual void	write_xyz (SpatialGridPlotFile *outfile) const

virtual void	write_xz (SpatialGridPlotFile *outfile) const

virtual void	write_yz (SpatialGridPlotFile *outfile) const

Protected Member Functions inherited from SimulationItem
	SimulationItem ()

virtual bool	offersInterface (const std::type_info &interfaceTypeInfo) const

virtual void	setupSelfAfter ()

virtual void	setupSelfBefore ()

Protected Member Functions inherited from Item
	Item ()

Protected Member Functions inherited from Box
void	setExtent (const Box &extent)

void	setExtent (double xmin, double ymin, double zmin, double xmax, double ymax, double zmax)

Private Types
using	BaseType = SpatialGrid

using	ItemType = BoxSpatialGrid

Private Attributes
double	_maxX

double	_maxY

double	_maxZ

double	_minX

double	_minY

double	_minZ

Friends
class	ItemRegistry

Detailed Description

The BoxSpatialGrid class is an abstract subclass of the general SpatialGrid class, and represents any spatial grid defined within cuboidal configuration space in which the faces are aligned with the planes of the coordinate system (a box). The class also inherits from the Box class.

Constructor & Destructor Documentation

◆ BoxSpatialGrid()

BoxSpatialGrid::BoxSpatialGrid ( )

inlineprotected

Default constructor for abstract Item subclass BoxSpatialGrid : "a spatial grid bounded by a box" .

Member Function Documentation

◆ boundingBox()

Box BoxSpatialGrid::boundingBox ( ) const

overridevirtual

This function returns the bounding box that encloses the grid.

Implements SpatialGrid.

◆ dimension()

int BoxSpatialGrid::dimension ( ) const

overridevirtual

This function returns the dimension of the grid, which is 3 for all subclasses of this class.

Implements SpatialGrid.

◆ maxX()

BoxSpatialGrid::maxX ( ) const

inline

This function returns the value of the discoverable double property maxX : "the end point of the box in the X direction" .