#include <AnnulusGeometry.hpp>
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 |
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\ \quad\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}}\).
|
inlineprotected |
Default constructor for concrete Item subclass AnnulusGeometry : "an annulus geometry" .
|
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.
|
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" .
|
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" .
|
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" .
|
overrideprotectedvirtual |
This function returns the cylindrical radius \(R\) of a random position drawn from the geometry, by picking a uniform deviate \({\cal{X}}\) and setting \(R = \sqrt{R_\text{min}^2 + {\cal{X}}_1\,(R_\text{max}^2-R_\text{min}^2)} \).
Implements SepAxGeometry.
|
overrideprotectedvirtual |
This function returns the height \(z\) of a random position drawn from the geometry, by picking a uniform deviate \({\cal{X}}\) and setting \(z = -\frac{h}{2} + {\cal{X}} h\).
Implements SepAxGeometry.
|
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.
|
overrideprotectedvirtual |
This function returns the surface density along a line in the equatorial plane starting at the centre of the coordinate system, i.e.
\[ \Sigma_R = \int_0^\infty \rho(R,0)\, {\text{d}}R. \]
For the annulus geometry, we find
\[ \Sigma_R = \rho_0 (R_{\text{max}} - R_{\text{min}}). \]
Implements AxGeometry.
|
overrideprotectedvirtual |
This function returns the surface density along the Z-axis, i.e. the integration of the density along the entire Z-axis,
\[ \Sigma_Z = \int_{-\infty}^\infty \rho(0,z)\, {\text{d}}z.\]
For the annulus geometry, we find
\[ \Sigma_Z = \rho_0 h. \]
If there is an inner hole ( \(R_{\text{min}}>0\)), obviously \(\Sigma_Z=0\).
Implements Geometry.