 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <LinearCutForm.hpp>
Public Member Functions | |
| double | endX () const |
| double | endY () const |
| double | endZ () const |
| int | numSamples () const |
| double | startX () const |
| double | startY () const |
| double | startZ () const |
| void | writeQuantity (const ProbeFormBridge *bridge) const override |
| virtual void | writeQuantity (const ProbeFormBridge *bridge) 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 | |
| LinearCutForm () | |
| Protected Member Functions inherited from GenericForm | |
| GenericForm () | |
| Protected Member Functions inherited from Form | |
| Form () | |
| 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 = GenericForm |
| using | ItemType = LinearCutForm |
Private Attributes | |
| double | _endX |
| double | _endY |
| double | _endZ |
| int | _numSamples |
| double | _startX |
| double | _startY |
| double | _startZ |
Friends | |
| class | ItemRegistry |
LinearCutForm represents a generic probe form. Refer to the ProbeFormBridge class for more information about probes and forms.
This particular form outputs a text column file listing the quantity being probed at a number of positions along an arbitrary line segment through the spatial domain of the simulation. The starting and ending point of the line segment can be configured using regular model coordinates, and the number of equidistant samples to be taken along the line can be specified as well.
The output file contains a line for each sample along the line segment. The first column specifies the distance along the line from the starting point, and subsequent column(s) list the quantity being probed.
This item type is displayed only if the Boolean expression "Level2" evaluates to true after replacing the names by true or false depending on their presence.
|
inlineprotected |
Default constructor for concrete Item subclass LinearCutForm : "a text column file with values along a given line segment" .
|
inline |
This function returns the value of the discoverable double property endX : "the position of the ending point, x component" .
This property represents a physical quantity of type "length" .
|
inline |
This function returns the value of the discoverable double property endY : "the position of the ending point, y component" .
This property represents a physical quantity of type "length" .
|
inline |
This function returns the value of the discoverable double property endZ : "the position of the ending point, z component" .
This property represents a physical quantity of type "length" .
|
inline |
This function returns the value of the discoverable integer property numSamples : "the number of samples along the line segment" .
The minimum value for this property is "3" .
The maximum value for this property is "100000" .
The default value for this property is given by the conditional value expression "250" .
|
inline |
This function returns the value of the discoverable double property startX : "the position of the starting point, x component" .
This property represents a physical quantity of type "length" .
|
inline |
This function returns the value of the discoverable double property startY : "the position of the starting point, y component" .
This property represents a physical quantity of type "length" .
|
inline |
This function returns the value of the discoverable double property startZ : "the position of the starting point, z component" .
This property represents a physical quantity of type "length" .
|
overridevirtual |
This function causes the form to output file(s) as described in the class header for the quantity being probed according to the information provided by the specified ProbeFormBridge instance.
Implements Form.