 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <OffsetVectorFieldDecorator.hpp>
Public Member Functions | |
| int | dimension () const override |
| double | offsetX () const |
| double | offsetY () const |
| double | offsetZ () const |
| Vec | vector (Position bfr) const override |
| VectorField * | vectorField () const |
| virtual int | dimension () const =0 |
| virtual Vec | vector (Position bfr) 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 | |
| OffsetVectorFieldDecorator () | |
| Protected Member Functions inherited from VectorField | |
| VectorField () | |
| 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 = VectorField |
| using | ItemType = OffsetVectorFieldDecorator |
Private Attributes | |
| double | _offsetX |
| double | _offsetY |
| double | _offsetZ |
| VectorField * | _vectorField |
Friends | |
| class | ItemRegistry |
The OffsetVectorFieldDecorator class is a decorator that adds an arbitrary offset to any vector field. The properties of an OffsetVectorFieldDecorator object include (1) a reference to the VectorField object being decorated and (2) three offsets in the x, y, and z directions. The resulting vector field is identical to the vector field being decorated, except that it is shifted over the specified offset. The vector field implemented by an OffsetVectorFieldDecorator object is 2D (axial symmetry) or 3D (no symmetries) depending on the symmetries of the vector field being decorated and on the specified offset. Specifically, it is 2D if the vector field being decorated is 1D or 2D and the offsets in the x and y directions are both zero. It is 3D if the vector field 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 OffsetVectorFieldDecorator : "a decorator that adds an offset to any vector field" .
|
overridevirtual |
This function returns the dimension of the vector field. It is 2 if the dimension of the vector field 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 vector field being decorated is 3, or if at least one of the offsets in the x and y directions is nonzero.
Implements VectorField.
|
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.
This function returns the value of the vector field at the position \({\bf{r}}\). It calls the vector() function for the vector field being decorated with the translated position \({\bf{r}}-{\bf{r}_\text{offset}}\).
Implements VectorField.
|
inline |
This function returns the value of the discoverable item property vectorField : "the vector field to be offset" .