 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <OffsetGeometryDecorator.hpp>
Public Member Functions | |
| double | density (Position bfr) const override |
| int | dimension () const override |
| Position | generatePosition () const override |
| Geometry * | geometry () const |
| double | offsetX () const |
| double | offsetY () const |
| double | offsetZ () const |
| double | SigmaX () const override |
| double | SigmaY () const override |
| double | SigmaZ () const override |
| 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 | |
| OffsetGeometryDecorator () | |
| 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 () |
| Protected Member Functions inherited from Item | |
| Item () | |
Private Types | |
| using | BaseType |
| using | ItemType |
Private Attributes | |
| Geometry * | _geometry |
| double | _offsetX |
| double | _offsetY |
| double | _offsetZ |
Friends | |
| class | ItemRegistry |
The OffsetGeometryDecorator class is a decorator that adds an arbitrary offset to any geometry. The properties of an OffsetGeometryDecorator object include (1) a reference to the Geometry object being decorated and (2) three offsets in the x, y, and z directions. The resulting geometry is identical to the geometry being decorated, except that the density distribution is shifted over the specified offset. The geometry implemented by an OffsetGeometryDecorator object is 2D (axial symmetry) or 3D (no symmetries) depending on the symmetries of the geometry being decorated and on the specified offset. Specifically, it is 2D if the geometry being decorated is 1D or 2D and the offsets in the x and y directions are both zero. It is 3D if the geometry being decorated is 3D, or if at least one of the offsets in the x and y directions is nonzero.
|
inlineprotected |
Default constructor for concrete Item subclass OffsetGeometryDecorator: "a decorator that adds an offset to any geometry".
|
overridevirtual |
|
overridevirtual |
This function returns the dimension of the geometry. It is 2 if the dimension of the geometry being decorated is 1 or 2 and the offsets in the x and y directions are both zero. It is 3 if the dimension of the geometry being decorated is 3, or if at least one of the offsets in the x and y directions is nonzero.
Implements Geometry.
|
overridevirtual |
This 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}}\). It calls the density() function for the geometry being decorated and returns the translated position \({\bf{r}}+{\bf{r}_\text{offset}}\).
Implements Geometry.
|
inline |
This function returns the value of the discoverable item property geometry: "the geometry to be offset".
|
inline |
This function returns the value of the discoverable double property offsetX: "the offset in the x direction".
This property represents a physical quantity of type "length".
The default value for this property is given by the conditional value expression "0".
When a value is entered for this property, the names provided by the conditional value expression "offsetX:Dimension3" are inserted into the name sets used for evaluating Boolean expressions.
|
inline |
This function returns the value of the discoverable double property offsetY: "the offset in the y direction".
This property represents a physical quantity of type "length".
The default value for this property is given by the conditional value expression "0".
When a value is entered for this property, the names provided by the conditional value expression "offsetY:Dimension3" are inserted into the name sets used for evaluating Boolean expressions.
|
inline |
This function returns the value of the discoverable double property offsetZ: "the offset in the z direction".
This property represents a physical quantity of type "length".
The default value for this property is given by the conditional value expression "0".
When a value is entered for this property, the names provided by the conditional value expression "offsetZ:Dimension2" are inserted into the name sets used for evaluating Boolean expressions.
|
overridevirtual |
This 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. \]
It is impossible to calculate this value for a random value of the offset. The best option we have is to return the X-axis surface density of the original geometry, which is the true value in case there is only an offset in the x direction.
Implements Geometry.
|
overridevirtual |
This 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. \]
It is impossible to calculate this value for a random value of the offset. The best option we have is to return the Y-axis surface density of the original geometry, which is the true value in case there is only an offset in the y direction.
Implements Geometry.
|
overridevirtual |
This 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. \]
It is impossible to calculate this value for a random value of the offset. The best option we have is to return the Z-axis surface density of the original geometry, which is the true value in case there is only an offset in the z direction.
Implements Geometry.