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

#include <SecondaryEmissionOptions.hpp>

Inheritance diagram for SecondaryEmissionOptions:
Inheritance graph
[legend]

Public Member Functions

double secondaryPacketsMultiplier () const
 
double sourceBias () const
 
double spatialBias () const
 
bool storeEmissionRadiationField () 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

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

Private Attributes

double _secondaryPacketsMultiplier
 
double _sourceBias
 
double _spatialBias
 
bool _storeEmissionRadiationField
 

Friends

class ItemRegistry
 

Detailed Description

The SecondaryEmissionOptions class simply offers a number of configuration options related to secondary emission, regardless of the emitting media type.

Constructor & Destructor Documentation

◆ SecondaryEmissionOptions()

SecondaryEmissionOptions::SecondaryEmissionOptions ( )
inlineprotected

Default constructor for concrete Item subclass SecondaryEmissionOptions : "a set of options related to secondary emission" .

Member Function Documentation

◆ secondaryPacketsMultiplier()

SecondaryEmissionOptions::secondaryPacketsMultiplier ( ) const
inline

This function returns the value of the discoverable double property secondaryPacketsMultiplier : "the multiplier on the number of photon packets launched for 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 "1" .

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.

◆ sourceBias()

SecondaryEmissionOptions::sourceBias ( ) const
inline

This function returns the value of the discoverable double property sourceBias : "the fraction of photon packets distributed uniformly across secondary sources" .

The minimum value for this property is "[0" .

The maximum value for this property is "1]" .

The default value for this property is given by the conditional value expression "0.5" .

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.

◆ spatialBias()

SecondaryEmissionOptions::spatialBias ( ) const
inline

This function returns the value of the discoverable double property spatialBias : "the fraction of secondary photon packets distributed uniformly across spatial cells" .

The minimum value for this property is "[0" .

The maximum value for this property is "1]" .

The default value for this property is given by the conditional value expression "0.5" .

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.

◆ storeEmissionRadiationField()

SecondaryEmissionOptions::storeEmissionRadiationField ( ) const
inline

This function returns the value of the discoverable Boolean property storeEmissionRadiationField : "store the radiation field during emission so that it can be probed for output" .

The default value for this property is given by the conditional value expression "false" .

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.


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