 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <IterationOptions.hpp>
Public Member Functions | |
| bool | includePrimaryEmission () const |
| int | maxPrimaryIterations () const |
| int | maxSecondaryIterations () const |
| int | minPrimaryIterations () const |
| int | minSecondaryIterations () const |
| double | primaryIterationPacketsMultiplier () const |
| double | secondaryIterationPacketsMultiplier () const |
 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 | |
| IterationOptions () | |
| 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 = IterationOptions |
Friends | |
| class | ItemRegistry |
The IterationOptions class simply offers a number of options for configuring iterations during primary and/or secondary emission. These options are relevant only when the simulation has a dynamic medium state and/or a dynamic secondary emission.
|
inlineprotected |
Default constructor for concrete Item subclass IterationOptions : "a set of options for configuring iterations during primary and/or secondary emission" .
|
inline |
This function returns the value of the discoverable Boolean property includePrimaryEmission : "include primary emission in the secondary emission iterations" .
The default value for this property is given by the conditional value expression "false" .
This property is relevant only if the Boolean expression "IterateSecondary" evaluates to true after replacing the names by true or false depending on their presence.
This property is displayed only if the Boolean expression "Level3" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable integer property maxPrimaryIterations : "the maximum number of iterations during primary emission" .
The minimum value for this property is "1" .
The maximum value for this property is "1000" .
The default value for this property is given by the conditional value expression "10" .
This property is relevant only if the Boolean expression "IteratePrimary" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable integer property maxSecondaryIterations : "the maximum number of iterations during secondary emission" .
The minimum value for this property is "0" .
The maximum value for this property is "1000" .
The default value for this property is given by the conditional value expression "10" .
This property is relevant only if the Boolean expression "IterateSecondary" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable integer property minPrimaryIterations : "the minimum number of iterations during primary emission" .
The minimum value for this property is "1" .
The maximum value for this property is "1000" .
The default value for this property is given by the conditional value expression "1" .
This property is relevant only if the Boolean expression "IteratePrimary" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable integer property minSecondaryIterations : "the minimum number of iterations during secondary emission" .
The minimum value for this property is "1" .
The maximum value for this property is "1000" .
The default value for this property is given by the conditional value expression "1" .
This property is relevant only if the Boolean expression "IterateSecondary" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable double property primaryIterationPacketsMultiplier : "the multiplier on the number of photon packets launched for each primary emission iteration" .
The minimum value for this property is "]0" .
The maximum value for this property is "1000]" .
The default value for this property is given by the conditional value expression "1" .
This property is relevant only if the Boolean expression "IteratePrimary|includePrimaryEmission" evaluates to true after replacing the names by true or false depending on their presence.
This property is displayed only if the Boolean expression "Level3" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable double property secondaryIterationPacketsMultiplier : "the multiplier on the number of photon packets launched for each secondary emission iteration" .
The minimum value for this property is "]0" .
The maximum value for this property is "1000]" .
The default value for this property is given by the conditional value expression "1" .
This property is relevant only if the Boolean expression "IterateSecondary" evaluates to true after replacing the names by true or false depending on their presence.
This property is displayed only if the Boolean expression "Level3" evaluates to true after replacing the names by true or false depending on their presence.