CylinderSpatialGrid Class Reference

#include <CylinderSpatialGrid.hpp>

Inheritance diagram for CylinderSpatialGrid:

Public Member Functions
double	maxRadius () const
double	maxZ () const
double	minRadius () const
double	minZ () const
Public Member Functions inherited from SpatialGrid
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
	CylinderSpatialGrid ()
Box	boundingBox () const override
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 ()
Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType
using	ItemType

Private Attributes
double	_maxRadius
double	_maxZ
double	_minRadius
double	_minZ

Friends
class	ItemRegistry

Detailed Description

The CylinderSpatialGrid class is an abstract subclass of the general SpatialGrid class, and represents any spatial grid defined within a cylindrical configuration space, with the symmetry axis the Z-axis of the system.

Constructor & Destructor Documentation

CylinderSpatialGrid()

CylinderSpatialGrid::CylinderSpatialGrid ( )

inlineprotected

Default constructor for abstract Item subclass CylinderSpatialGrid: "a spatial grid bounded by a cylinder".

Member Function Documentation

boundingBox()

Box CylinderSpatialGrid::boundingBox ( ) const

overrideprotectedvirtual

This function returns the bounding box that encloses the grid.

Implements SpatialGrid.

maxRadius()

double CylinderSpatialGrid::maxRadius ( ) const

inline

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

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

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

maxZ()

double CylinderSpatialGrid::maxZ ( ) const

inline

This function returns the value of the discoverable double property maxZ: "the end point of the cylinder in the Z direction".

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

minRadius()

double CylinderSpatialGrid::minRadius ( ) const

inline

This function returns the value of the discoverable double property minRadius: "the inner cylindrical 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".

minZ()

double CylinderSpatialGrid::minZ ( ) const

inline

This function returns the value of the discoverable double property minZ: "the start point of the cylinder in the Z direction".

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

setupSelfBefore()

void CylinderSpatialGrid::setupSelfBefore ( )

overrideprotectedvirtual

This function verifies the characteristics of the grid.

Reimplemented from SimulationItem.

---

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

• CylinderSpatialGrid.hpp