AxGeometry Class Reference

#include <AxGeometry.hpp>

Inheritance diagram for AxGeometry:

Public Member Functions
virtual double	density (double R, double z) const =0
double	density (Position bfr) const override
int	dimension () const override
virtual double	SigmaR () const =0
double	SigmaX () const override
double	SigmaY () const override
Public Member Functions inherited from Geometry
virtual double	density (Position bfr) const =0
virtual int	dimension () const =0
virtual Position	generatePosition () const =0
virtual double	SigmaX () const =0
virtual double	SigmaY () const =0
virtual double	SigmaZ () const =0
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
	AxGeometry ()
Protected Member Functions inherited from Geometry
	Geometry ()
Random *	random () const
void	setupSelfBefore () override
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 = Geometry
using	ItemType = AxGeometry

Friends
class	ItemRegistry

Detailed Description

The AxGeometry class is an abstract subclass of the general Geometry class, and serves as a base class for axisymmetric geometries, i.e. geometries where the density can be written as $\rho (\mathbf{r})=\rho (R,z)$.

When an item of this type is used, the names provided by the conditional value expression "Dimension2" are inserted into the name sets used for evaluating Boolean expressions.

Constructor & Destructor Documentation

AxGeometry()

AxGeometry::AxGeometry ( )

inlineprotected

Default constructor for abstract Item subclass AxGeometry : "an axisymmetric geometry" .

Member Function Documentation

density() [1/2]

virtual double AxGeometry::density ( double  R, double  z  ) const

pure virtual

This pure virtual function returns the density $\rho (R,z)$ at the cylindrical radius $R$ and height $z$.

Implemented in AnnulusGeometry, BrokenExpDiskGeometry, ConicalShellGeometry, DonutGeometry, ExpDiskGeometry, HyperboloidGeometry, HyperboloidShellGeometry, MultiGaussianExpansionGeometry, ParaboloidGeometry, ParaboloidShellGeometry, RingGeometry, SpheroidalGeometryDecorator, TorusGeometry, and TTauriDiskGeometry.

density() [2/2]

double AxGeometry::density ( Position  bfr ) const

overridevirtual

This function returns the density $\rho (\mathbf{r})$ at the position $\mathbf{r}$. For axisymmetric geometries, the density only depends on the cylindrical coordinates $R$ and $z$, such that only the member function $\rho (R,z)$ needs to be defined.

Implements Geometry.

dimension()

int AxGeometry::dimension ( ) const

overridevirtual

This function returns the dimension of the geometry, which is 2 for all subclasses of this class since it is a base class for axisymmetric geometries.

Implements Geometry.

SigmaR()

virtual double AxGeometry::SigmaR ( ) const

pure virtual

This pure virtual function returns the radial surface density, i.e. the integration of the density along a line in the equatorial plane starting at the centre of the coordinate system,

$${\mathrm{\Sigma }}_R={\int }_0^{\mathrm{\infty }}\rho (R,0)\text{d}R.$$

Implemented in AnnulusGeometry, BrokenExpDiskGeometry, ConicalShellGeometry, DonutGeometry, ExpDiskGeometry, HyperboloidGeometry, HyperboloidShellGeometry, MultiGaussianExpansionGeometry, ParaboloidGeometry, ParaboloidShellGeometry, RingGeometry, SpheroidalGeometryDecorator, TorusGeometry, and TTauriDiskGeometry.

SigmaX()

double AxGeometry::SigmaX ( ) const

overridevirtual

This function returns the X-axis surface density, i.e. the integration of the density along the entire X-axis,

$${\mathrm{\Sigma }}_X={\int }_{-\mathrm{\infty }}^{\mathrm{\infty }}\rho (x,0,0)\text{d}x.$$

For an axisymmetric geometry, we can write ${\mathrm{\Sigma }}_X=2{\mathrm{\Sigma }}_R$, where ${\mathrm{\Sigma }}_R$ is the radial surface density.

Implements Geometry.

SigmaY()

double AxGeometry::SigmaY ( ) const

overridevirtual

This function returns the Y-axis surface density, i.e. the integration of the density along the entire Y-axis,

$${\mathrm{\Sigma }}_Y={\int }_{-\mathrm{\infty }}^{\mathrm{\infty }}\rho (0,y,0)\text{d}y.$$

For an axisymmetric geometry, we can write ${\mathrm{\Sigma }}_Y=2{\mathrm{\Sigma }}_R$, where ${\mathrm{\Sigma }}_R$ is the radial surface density.

Implements Geometry.

---

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

• AxGeometry.hpp