#include <Sphere1DSpatialGrid.hpp>

Inheritance diagram for Sphere1DSpatialGrid:

[legend]

Public Member Functions
int	cellIndex (Position bfr) const override

Position	centralPositionInCell (int m) const override

std::unique_ptr< PathSegmentGenerator >	createPathSegmentGenerator () const override

double	diagonal (int m) const override

int	dimension () const override

Mesh *	meshRadial () const

double	minRadius () const

int	numCells () const override

Position	randomPositionInCell (int m) const override

void	setupSelfAfter () override

double	volume (int m) const override

Public Member Functions inherited from SphereSpatialGrid
Box	boundingBox () const override

double	maxRadius () 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
	Sphere1DSpatialGrid ()

void	write_xy (SpatialGridPlotFile *outfile) const override

Protected Member Functions inherited from SphereSpatialGrid
	SphereSpatialGrid ()

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 ()

Private Types
using	BaseType = SphereSpatialGrid

using	ItemType = Sphere1DSpatialGrid

Private Attributes
Mesh *	_meshRadial

double	_minRadius

int	_Nr

Array	_rv

Friends
class	ItemRegistry

class	MySegmentGenerator

Detailed Description

The Sphere1DSpatialGrid class is a subclass of the SphereSpatialGrid class, and represents one-dimensional, spherically symmetric spatial grids. Each cell in such a grid is a spherical shell. Internally, a spherical spatial grid is specified through a set of \(N_r+1\) radial grid points \(r_i\) (with \(i=0,\ldots,N_r\)).

This item type is allowed only if the Boolean expression "!Dimension2&!Dimension3" evaluates to true after replacing the names by true or false depending on their presence.

Constructor & Destructor Documentation

◆ Sphere1DSpatialGrid()

Sphere1DSpatialGrid::Sphere1DSpatialGrid ( )

inlineprotected

Default constructor for concrete Item subclass Sphere1DSpatialGrid : "a spherically symmetric spatial grid" .

Member Function Documentation

◆ cellIndex()

int Sphere1DSpatialGrid::cellIndex ( Position bfr ) const

overridevirtual

This function returns the number of the cell that contains the position \({\bf{r}}\). It just determines the radial bin index and returns that number.

Implements SpatialGrid.

◆ centralPositionInCell()

Position Sphere1DSpatialGrid::centralPositionInCell ( int m ) const

overridevirtual

This function returns the central location from the cell with index \(m\). For a spherical grid, cell index \(m\) corresponds to the radial bin with lower border index \(i=m\), and the central radius is determined using

\[ r = \frac{r_i + r_{i+1}}{2}. \]

The returned position is arbitrarily located on the x-axis.

Implements SpatialGrid.

◆ createPathSegmentGenerator()

std::unique_ptr< PathSegmentGenerator > Sphere1DSpatialGrid::createPathSegmentGenerator ( ) const

overridevirtual

This function creates and hands over ownership of a path segment generator (an instance of a PathSegmentGenerator subclass) appropriate for a spherical grid, implemented as a private PathSegmentGenerator subclass.

The algorithm used to construct the path is fairly straightforward because of the symmetry in the grid.

Implements SpatialGrid.

◆ diagonal()

double Sphere1DSpatialGrid::diagonal ( int m ) const

overridevirtual

This function returns the "diagonal" of the cell with index \(m\). For 1D spherical grids, it simply returns the cell width, i.e. the difference between the outer and inner cell radius.

Implements SpatialGrid.

◆ dimension()

int Sphere1DSpatialGrid::dimension ( ) const

overridevirtual

This function returns the dimension of the grid, which is 1 for this class.

Implements SpatialGrid.

◆ meshRadial()

Sphere1DSpatialGrid::meshRadial ( ) const

inline

This function returns the value of the discoverable item property meshRadial : "the bin distribution in the radial direction" .

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

◆ minRadius()

Sphere1DSpatialGrid::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" .

◆ numCells()

int Sphere1DSpatialGrid::numCells ( ) const

overridevirtual

This function returns the number of cells in the grid.

Implements SpatialGrid.

◆ randomPositionInCell()

Position Sphere1DSpatialGrid::randomPositionInCell ( int m ) const

overridevirtual

This function returns a random location from the cell with index \(m\). For a spherical grid, cell index \(m\) corresponds to the radial bin with lower border index \(i=m\), and a random radius is determined using

\[ r = \left( r_i^3 + {\cal{X}} \,(r_{i+1}^3-r_i^3) \right)^{1/3} \]

with \({\cal{X}}\) a random deviate. This random radius is combined with a random position on the unit sphere to generate a random position from the cell.

Implements SpatialGrid.

◆ setupSelfAfter()

void Sphere1DSpatialGrid::setupSelfAfter ( )

overridevirtual

This function sets up a number of data members that depend on the Mesh object configured for this grid.

Reimplemented from SimulationItem.

◆ volume()

double Sphere1DSpatialGrid::volume ( int m ) const

overridevirtual

This function returns the volume of the cell with index \(m\). For a spherical grid, cell index \(m\) corresponds to the radial bin with lower border index \(i=m\), and the volume is easily calculated as

\[V = \frac{4\pi}{3}\, (r_{i+1}^3-r_i^3),\]

with \(r_i\) and \(r_{i+1}\) the inner and outer radius of the shell respectively.

Implements SpatialGrid.

◆ write_xy()

void Sphere1DSpatialGrid::write_xy ( SpatialGridPlotFile * outfile ) const

overrideprotectedvirtual

This function writes the intersection of the grid with the xy plane to the specified SpatialGridPlotFile object.

Reimplemented from SpatialGrid.

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

Sphere1DSpatialGrid.hpp

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Sphere1DSpatialGrid()

Member Function Documentation

◆ cellIndex()

◆ centralPositionInCell()

◆ createPathSegmentGenerator()

◆ diagonal()

◆ dimension()

◆ meshRadial()

◆ minRadius()

◆ numCells()

◆ randomPositionInCell()

◆ setupSelfAfter()

◆ volume()

◆ write_xy()