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

#include <UniformBoxGeometry.hpp>

Inheritance diagram for UniformBoxGeometry:
Inheritance graph
[legend]

Public Member Functions

double density (Position bfr) const override
 
Position generatePosition () const override
 
double maxX () const
 
double maxY () const
 
double maxZ () const
 
double minX () const
 
double minY () const
 
double minZ () const
 
double SigmaX () const override
 
double SigmaY () const override
 
double SigmaZ () const override
 
- Public Member Functions inherited from GenGeometry
int dimension () 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 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

 UniformBoxGeometry ()
 
void setupSelfBefore () override
 
- Protected Member Functions inherited from GenGeometry
 GenGeometry ()
 
- Protected Member Functions inherited from Geometry
 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 = GenGeometry
 
using ItemType = UniformBoxGeometry
 

Private Attributes

Box _box
 
double _maxX
 
double _maxY
 
double _maxZ
 
double _minX
 
double _minY
 
double _minZ
 
double _rho
 

Friends

class ItemRegistry
 

Detailed Description

The UniformBoxGeometry class describes a 3D geometry consisting of a uniform cuboid aligned with the coordinate system.

Constructor & Destructor Documentation

◆ UniformBoxGeometry()

UniformBoxGeometry::UniformBoxGeometry ( )
inlineprotected

Default constructor for concrete Item subclass UniformBoxGeometry : "a geometry with uniform density inside a box" .

Member Function Documentation

◆ density()

double UniformBoxGeometry::density ( Position  bfr) const
overridevirtual

This function returns the density \(\rho({\bf{r}})\) for this geometry at the position \({\bf{r}}\). It returns the constant value \(\rho=1/(x_\text{width}\,y_\text{width}\,z_\text{width})\) for all points inside the box, and zero outside the box.

Implements Geometry.

◆ generatePosition()

Position UniformBoxGeometry::generatePosition ( ) const
overridevirtual

This function generates a random position from the geometry, by drawing a uniform random point inside the box.

Implements Geometry.

◆ maxX()

UniformBoxGeometry::maxX ( ) const
inline

This function returns the value of the discoverable double property maxX : "the end point of the box in the X direction" .

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

◆ maxY()

UniformBoxGeometry::maxY ( ) const
inline

This function returns the value of the discoverable double property maxY : "the end point of the box in the Y direction" .

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

◆ maxZ()

UniformBoxGeometry::maxZ ( ) const
inline

This function returns the value of the discoverable double property maxZ : "the end point of the box in the Z direction" .

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

◆ minX()

UniformBoxGeometry::minX ( ) const
inline

This function returns the value of the discoverable double property minX : "the start point of the box in the X direction" .

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

◆ minY()

UniformBoxGeometry::minY ( ) const
inline

This function returns the value of the discoverable double property minY : "the start point of the box in the Y direction" .

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

◆ minZ()

UniformBoxGeometry::minZ ( ) const
inline

This function returns the value of the discoverable double property minZ : "the start point of the box in the Z direction" .

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

◆ setupSelfBefore()

void UniformBoxGeometry::setupSelfBefore ( )
overrideprotectedvirtual

This function verifies that the box has a positive volume, and calculates the (constant) density at each point, assuming a total mass of 1.

Reimplemented from Geometry.

◆ SigmaX()

double UniformBoxGeometry::SigmaX ( ) const
overridevirtual

This function returns the X-axis surface density of the geometry, defined as the integration of the density along the entire X-axis.

Implements Geometry.

◆ SigmaY()

double UniformBoxGeometry::SigmaY ( ) const
overridevirtual

This function returns the Y-axis surface density of the geometry, defined as the integration of the density along the entire Y-axis.

Implements Geometry.

◆ SigmaZ()

double UniformBoxGeometry::SigmaZ ( ) const
overridevirtual

This function returns the Z-axis surface density of the geometry, defined as the integration of the density along the entire Z-axis.

Implements Geometry.


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