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

#include <DynamicStateOptions.hpp>

Inheritance diagram for DynamicStateOptions:
Inheritance graph
[legend]

Public Member Functions

const vector< DynamicStateRecipe * > & recipes () 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 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

 DynamicStateOptions ()
 
- 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 = DynamicStateOptions
 

Private Attributes

vector< DynamicStateRecipe * > _recipes
 

Friends

class ItemRegistry
 

Detailed Description

The DynamicStateOptions class simply offers a number of configuration options related to the capability of dynamically adjusting the medium state while iterating over primary emission.

Constructor & Destructor Documentation

◆ DynamicStateOptions()

DynamicStateOptions::DynamicStateOptions ( )
inlineprotected

Default constructor for concrete Item subclass DynamicStateOptions : "a set of options for dynamically adjusting the medium state" .

Member Function Documentation

◆ recipes()

DynamicStateOptions::recipes ( ) const
inline

This function returns the value of the discoverable item list property recipes : "the dynamic medium state recipes" .

This property is relevant only if the Boolean expression "IteratePrimary|IterateSecondary" evaluates to true after replacing the names by true or false depending on their presence.

This property is required only if the Boolean expression "false" evaluates to true after replacing the names by true or false depending on their presence.

When a value is entered for this property, the names provided by the conditional value expression "DynamicState" are inserted into the name sets used for evaluating Boolean expressions.


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