RadiationFieldOptions Class Reference

#include <RadiationFieldOptions.hpp>

Inheritance diagram for RadiationFieldOptions:

Public Member Functions
DisjointWavelengthGrid *	radiationFieldWLG () const
bool	storeRadiationField () 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
	RadiationFieldOptions ()
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 = RadiationFieldOptions

Private Attributes
DisjointWavelengthGrid *	_radiationFieldWLG
bool	_storeRadiationField

Friends
class	ItemRegistry

Detailed Description

The RadiationFieldOptions class simply offers a number of configuration options that are related to the radiation field. A simulation always stores the radiation field when it has a secondary emission phase or when it has a dynamic medium state (or both). If neither is the case, and forced scattering is enabled (see PhotonPacketOptions), the user can still request to store the radiation field so that it can be probed for output.

Constructor & Destructor Documentation

RadiationFieldOptions()

RadiationFieldOptions::RadiationFieldOptions ( )

inlineprotected

Default constructor for concrete Item subclass RadiationFieldOptions : "a set of options related to the radiation field" .

Member Function Documentation

radiationFieldWLG()

RadiationFieldOptions::radiationFieldWLG ( ) const

inline

This function returns the value of the discoverable item property radiationFieldWLG : "the wavelength grid for storing the radiation field" .

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

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

storeRadiationField()

RadiationFieldOptions::storeRadiationField ( ) const

inline

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

The default value for this property is given by the conditional value expression "Emission|IteratePrimary:true;false" .

This property is relevant only if the Boolean expression "!Emission&!IteratePrimary&ForceScattering" 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.

When a value is entered for this property, the names provided by the conditional value expression "!Emission&!IteratePrimary&ForceScattering&storeRadiationField:RadiationField" are inserted into the name sets used for evaluating Boolean expressions.

---

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

• RadiationFieldOptions.hpp