 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <Geometry.hpp>
Public Member Functions | |
| 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 | |
| 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 () |
| Protected Member Functions inherited from Item | |
| Item () | |
Private Types | |
| using | BaseType |
| using | ItemType |
Private Attributes | |
| Random * | _random |
Friends | |
| class | ItemRegistry |
Geometry is the general abstract class that describes the density distribution of a primary source or of some obscuring medium. It is an abstract class, which essentially describes the interface that needs to be implemented by any subclass. There are two key member functions that each Geometry subclass should have: a function returning the density \(\rho({\bf{r}})\) and a function drawing a random position from this geometry. We normalize each geometry such that the total mass is equal to one, i.e.
\[ \iiint \rho({\bf{r}})\, {\text{d}}{\bf{r}} = 1.\]
|
inlineprotected |
|
pure virtual |
This pure virtual function returns the density \(\rho({\bf{r}})\) at the position \({\bf{r}}\).
Implemented in AxGeometry, ClipGeometryDecorator, ClumpyGeometryDecorator, CombineGeometryDecorator, ImportedGeometry, OffsetGeometryDecorator, ReadFits3DGeometry, ReadFitsGeometry, RedistributeGeometryDecorator, RotateGeometryDecorator, SpheGeometry, SpiralStructureGeometryDecorator, TriaxialGeometryDecorator, and UniformBoxGeometry.
|
pure virtual |
This pure virtual function returns the dimension of the geometry, which depends on its (lack of) symmetry. A value of 1 means spherical symmetry, 2 means axial symmetry and 3 means none of these symmetries. The function's implementation must be provided in a subclass.
Implemented in AxGeometry, AxPowerLawRedistributeGeometryDecorator, BoxClipGeometryDecorator, CombineGeometryDecorator, CylindricalClipGeometryDecorator, GenGeometry, OffsetGeometryDecorator, SpheGeometry, SphePowerLawRedistributeGeometryDecorator, and SphericalClipGeometryDecorator.
|
pure virtual |
This pure virtual function generates a random position from the geometry, by drawing a random point from the three-dimensional probability density \(p({\bf{r}})\, {\text{d}}{\bf{r}} = \rho({\bf{r}})\, {\text{d}}{\bf{r}}\).
Implemented in ClipGeometryDecorator, ClumpyGeometryDecorator, CombineGeometryDecorator, ConicalShellGeometry, DonutGeometry, HyperboloidGeometry, HyperboloidShellGeometry, ImportedGeometry, MultiGaussianExpansionGeometry, OffsetGeometryDecorator, ParaboloidGeometry, ParaboloidShellGeometry, ReadFits3DGeometry, ReadFitsGeometry, RedistributeGeometryDecorator, RotateGeometryDecorator, SepAxGeometry, SpheGeometry, SpheroidalGeometryDecorator, SpiralStructureGeometryDecorator, TorusGeometry, TriaxialGeometryDecorator, TTauriDiskGeometry, and UniformBoxGeometry.
|
inlineprotected |
This function returns the simulation's random generator as a service to subclasses.
|
overrideprotectedvirtual |
This function caches the simulation's random generator for use by subclasses.
Reimplemented from SimulationItem.
Reimplemented in HyperboloidGeometry, HyperboloidShellGeometry, MeshGeometry, MultiGaussianExpansionGeometry, ParaboloidGeometry, ParaboloidShellGeometry, PlummerGeometry, PseudoSersicGeometry, ReadFits3DGeometry, ReadFitsGeometry, RingGeometry, RotateGeometryDecorator, SersicGeometry, ShellGeometry, SphericalClipGeometryDecorator, SpiralStructureGeometryDecorator, TorusGeometry, TTauriDiskGeometry, and UniformBoxGeometry.
|
pure virtual |
This pure virtual function returns the X-axis surface density, i.e. the integration of the density along the entire X-axis,
\[ \Sigma_X = \int_{-\infty}^\infty \rho(x,0,0)\, {\text{d}}x. \]
Implemented in AxGeometry, ClipGeometryDecorator, ClumpyGeometryDecorator, CombineGeometryDecorator, CylindricalClipGeometryDecorator, ImportedGeometry, OffsetGeometryDecorator, ReadFits3DGeometry, ReadFitsGeometry, RedistributeGeometryDecorator, RotateGeometryDecorator, SpheGeometry, SpiralStructureGeometryDecorator, TriaxialGeometryDecorator, and UniformBoxGeometry.
|
pure virtual |
This pure virtual function returns the Y-axis surface density, i.e. the integration of the density along the entire Y-axis,
\[ \Sigma_Y = \int_{-\infty}^\infty \rho(0,y,0)\, {\text{d}}y. \]
Implemented in AxGeometry, ClipGeometryDecorator, ClumpyGeometryDecorator, CombineGeometryDecorator, CylindricalClipGeometryDecorator, ImportedGeometry, OffsetGeometryDecorator, ReadFits3DGeometry, ReadFitsGeometry, RedistributeGeometryDecorator, RotateGeometryDecorator, SpheGeometry, SpiralStructureGeometryDecorator, TriaxialGeometryDecorator, and UniformBoxGeometry.
|
pure virtual |
This pure virtual function returns the Z-axis surface density, i.e. the integration of the density along the entire Z-axis,
\[ \Sigma_Z = \int_{-\infty}^\infty \rho(0,0,z)\, {\text{d}}z. \]
Implemented in AnnulusGeometry, BrokenExpDiskGeometry, ClipGeometryDecorator, ClumpyGeometryDecorator, CombineGeometryDecorator, ConicalShellGeometry, CylindricalClipGeometryDecorator, DonutGeometry, ExpDiskGeometry, HyperboloidGeometry, HyperboloidShellGeometry, ImportedGeometry, MultiGaussianExpansionGeometry, OffsetGeometryDecorator, ParaboloidGeometry, ParaboloidShellGeometry, ReadFits3DGeometry, ReadFitsGeometry, RedistributeGeometryDecorator, RingGeometry, RotateGeometryDecorator, SpheGeometry, SpheroidalGeometryDecorator, SpiralStructureGeometryDecorator, TorusGeometry, TriaxialGeometryDecorator, TTauriDiskGeometry, and UniformBoxGeometry.