AnnulusGeometry Class Reference

#include <AnnulusGeometry.hpp>

Inheritance diagram for AnnulusGeometry:

Public Member Functions
double	height () const
double	maxRadius () const
double	minRadius () const
Public Member Functions inherited from SepAxGeometry
Position	generatePosition () const override
virtual double	randomCylRadius () const =0
virtual double	randomZ () const =0
Public Member Functions inherited from AxGeometry
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
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
	AnnulusGeometry ()
double	density (double R, double z) const override
double	randomCylRadius () const override
double	randomZ () const override
void	setupSelfBefore () override
double	SigmaR () const override
double	SigmaZ () const override
Protected Member Functions inherited from SepAxGeometry
	SepAxGeometry ()
Protected Member Functions inherited from AxGeometry
	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 = SepAxGeometry
using	ItemType = AnnulusGeometry

Private Attributes
const double &	_h
double	_height
double	_maxRadius
double	_minRadius
double	_rho0
const double &	_Rmax
const double &	_Rmin

Friends
class	ItemRegistry

Detailed Description

The AnnulusGeometry class is a subclass of the SepAxGeometry class, and describes a uniform cylindrical geometry with a cylindrical hole. This geometry can model geometrically thin accretion disks with an inner truncation at $R_{\text{min}}$, or could be used to build multi-zone disks by combining many annuli.

In formula, this is easily expressed in cylindrical coordinates as

$$\rho (R,z)={\rho }_0\text{for }{R}_{\text{min}}<R<R_{\text{max}}\text{ and }-\frac{h}{2}<z<\frac{h}{2}.$$

The model has three free parameters: the cylinder height $h$, the radial outer radius $R_{\text{max}}$ and the inner truncation radius $R_{\text{min}}$.

Constructor & Destructor Documentation

AnnulusGeometry()

AnnulusGeometry::AnnulusGeometry ( )

inlineprotected

Default constructor for concrete Item subclass AnnulusGeometry : "an annulus geometry" .

Member Function Documentation

density()

double AnnulusGeometry::density ( double  R, double  z  ) const

overrideprotectedvirtual

This function returns the density $\rho (R,z)$ at the cylindrical radius $R$ and height $z$. It just implements the geometry definition.

Implements AxGeometry.

height()

AnnulusGeometry::height ( ) const

inline

This function returns the value of the discoverable double property height : "the annulus height" .

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

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

maxRadius()

AnnulusGeometry::maxRadius ( ) const

inline

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

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

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

minRadius()

AnnulusGeometry::minRadius ( ) const

inline

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

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

randomCylRadius()

double AnnulusGeometry::randomCylRadius ( ) const

overrideprotectedvirtual

This function returns the cylindrical radius $R$ of a random position drawn from the geometry, by picking a uniform deviate $\mathcal{X}$ and setting $R=\sqrt{R_{\text{min}}^2+{\mathcal{X}}_1(R_{\text{max}}^2-R_{\text{min}}^2)}$.

Implements SepAxGeometry.

randomZ()

double AnnulusGeometry::randomZ ( ) const

overrideprotectedvirtual

This function returns the height $z$ of a random position drawn from the geometry, by picking a uniform deviate $\mathcal{X}$ and setting $z=-\frac{h}{2}+\mathcal{X}h$.

Implements SepAxGeometry.

setupSelfBefore()

void AnnulusGeometry::setupSelfBefore ( )

overrideprotectedvirtual

This function verifies the validity of the parameters and calculates the uniform density ${\rho }_0$. This density is set by the normalisation condition that the total mass equals one, i.e.

$${\rho }_0=\frac{1}{V}=\frac{1}{(R_{\text{max}}^2-R_{\text{min}}^2)\pi h}.$$

Reimplemented from SimulationItem.

SigmaR()

double AnnulusGeometry::SigmaR ( ) const

overrideprotectedvirtual

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

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

For the annulus geometry, we find

$${\mathrm{\Sigma }}_R={\rho }_0(R_{\text{max}}-R_{\text{min}}).$$

Implements AxGeometry.

SigmaZ()

double AnnulusGeometry::SigmaZ ( ) const

overrideprotectedvirtual

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

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

For the annulus geometry, we find

$${\mathrm{\Sigma }}_Z={\rho }_{0}h.$$

If there is an inner hole ( $R_{\text{min}}>0$), obviously ${\mathrm{\Sigma }}_Z=0$.

Implements Geometry.

---

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

• AnnulusGeometry.hpp