The SKIRT project
advanced radiative transfer for astrophysics
Public Member Functions | Protected Member Functions | Private Types | Private Attributes | Friends | List of all members
Geometry Class Referenceabstract

#include <Geometry.hpp>

Inheritance diagram for Geometry:
Inheritance graph
[legend]

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 ItemgetItemProperty (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)
 
Itemoperator= (const Item &)=delete
 
Itemparent () 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 ()
 
Randomrandom () 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 = SimulationItem
 
using ItemType = Geometry
 

Private Attributes

Random_random
 

Friends

class ItemRegistry
 

Detailed Description

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.\]

Constructor & Destructor Documentation

◆ Geometry()

Geometry::Geometry ( )
inlineprotected

Default constructor for abstract Item subclass Geometry : "a geometry" .

Member Function Documentation

◆ density()

virtual double Geometry::density ( Position  bfr) const
pure virtual

◆ dimension()

virtual int Geometry::dimension ( ) const
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.

◆ generatePosition()

virtual Position Geometry::generatePosition ( ) const
pure virtual

◆ random()

Random * Geometry::random ( ) const
inlineprotected

This function returns the simulation's random generator as a service to subclasses.

◆ setupSelfBefore()

void Geometry::setupSelfBefore ( )
overrideprotectedvirtual

◆ SigmaX()

virtual double Geometry::SigmaX ( ) const
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.

◆ SigmaY()

virtual double Geometry::SigmaY ( ) const
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.

◆ SigmaZ()

virtual double Geometry::SigmaZ ( ) const
pure virtual

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