SphereSpatialGrid Class Reference

#include <SphereSpatialGrid.hpp>

Inheritance diagram for SphereSpatialGrid:

Public Member Functions
Box	boundingBox () const override
double	maxRadius () const
double	minRadius () 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

Protected Member Functions
	SphereSpatialGrid ()
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 ()

Static Protected Member Functions
static int	initPolarGrid (Array &thetav, Array &cosv, const Mesh *mesh)

Private Types
using	BaseType = SpatialGrid
using	ItemType = SphereSpatialGrid

Private Attributes
double	_maxRadius
double	_minRadius

Friends
class	ItemRegistry

Detailed Description

The SphereSpatialGrid class is an abstract subclass of the general SpatialGrid class, and represents any spatial grid defined within a spherical configuration space, centered on the origin of the system.

Constructor & Destructor Documentation

SphereSpatialGrid()

SphereSpatialGrid::SphereSpatialGrid ( )

inlineprotected

Default constructor for abstract Item subclass SphereSpatialGrid : "a spatial grid bounded by a sphere" .

Member Function Documentation

boundingBox()

Box SphereSpatialGrid::boundingBox ( ) const

overridevirtual

This function returns the bounding box that encloses the grid.

Implements SpatialGrid.

initPolarGrid()

static int SphereSpatialGrid::initPolarGrid ( Array &  thetav, Array &  cosv, const Mesh *  mesh  )

staticprotected

This function initializes a polar-inclination grid from the specified mesh, making sure that there is exactly one boundary corresponding to the equatorial plane ( \(\theta=\pi/2\) or equivalently \(\cos\theta=0\)). If the mesh does not include such as a boundary, one is automatically added. If the mesh includes multiple boundaries very close to the equatorial plane, a fatal error is thrown.

The function stores the resulting boundaries and the corresponding cosine values in the provided arrays, resizing them appropriately, and returns the number of boundaries.

maxRadius()

SphereSpatialGrid::maxRadius ( ) const

inline

This function returns the value of the discoverable double property maxRadius : "the outer radius of the grid" .

This property represents a physical quantity of type "length" .

The minimum value for this property is "]0" .

minRadius()

SphereSpatialGrid::minRadius ( ) const

inline

This function returns the value of the discoverable double property minRadius : "the inner radius of the grid" .

This property represents a physical quantity of type "length" .

The minimum value for this property is "[0" .

The default value for this property is given by the conditional value expression "0" .

setupSelfBefore()

void SphereSpatialGrid::setupSelfBefore ( )

overrideprotectedvirtual

This function verifies the characteristics of the grid.

Reimplemented from SpatialGrid.

---

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

• SphereSpatialGrid.hpp