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

#include <SpecialtyWavelengthGridProbe.hpp>

Inheritance diagram for SpecialtyWavelengthGridProbe:
Inheritance graph
[legend]

Public Member Functions

WavelengthGridmaterialWavelengthGrid () const override
 
WavelengthGridwavelengthGrid () const
 
Range wavelengthRange () const override
 
- Public Member Functions inherited from Probe
string itemName () const override
 
int iter () const
 
string probeName () const
 
void probePrimary (int iter)
 
void probeRun ()
 
void probeSecondary (int iter)
 
void probeSetup ()
 
- 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
 
virtual WavelengthGridmaterialWavelengthGrid () const
 
- Public Member Functions inherited from WavelengthRangeInterface
virtual ~WavelengthRangeInterface ()
 
virtual Range wavelengthRange () const =0
 

Protected Member Functions

 SpecialtyWavelengthGridProbe ()
 
- Protected Member Functions inherited from SpecialtyProbe
 SpecialtyProbe ()
 
- Protected Member Functions inherited from Probe
 Probe ()
 
virtual void initialize ()
 
virtual void probe ()=0
 
virtual When when () const
 
- 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 ()
 
- Protected Member Functions inherited from MaterialWavelengthRangeInterface
 MaterialWavelengthRangeInterface ()
 
- Protected Member Functions inherited from WavelengthRangeInterface
 WavelengthRangeInterface ()
 

Private Types

using BaseType = SpecialtyProbe
 
using ItemType = SpecialtyWavelengthGridProbe
 

Private Attributes

WavelengthGrid_wavelengthGrid
 

Friends

class ItemRegistry
 

Additional Inherited Members

- Protected Types inherited from Probe
enum class  When { Setup , Run , Primary , Secondary }
 

Detailed Description

SpecialtyWavelengthGridProbe is a base class for probes that require a configurable wavelength grid property. It implements the MaterialWavelengthRangeInterface to indicate that wavelength-dependent material properties may be required for the configured wavelength grid.

Constructor & Destructor Documentation

◆ SpecialtyWavelengthGridProbe()

SpecialtyWavelengthGridProbe::SpecialtyWavelengthGridProbe ( )
inlineprotected

Default constructor for abstract Item subclass SpecialtyWavelengthGridProbe : "a specialty wavelength grid probe" .

Member Function Documentation

◆ materialWavelengthGrid()

WavelengthGrid * SpecialtyWavelengthGridProbe::materialWavelengthGrid ( ) const
overridevirtual

This function returns a pointer to the user-configured wavelength grid for this probe, if any, indicating that wavelength-dependent material properties may be required for these wavelengths.

Reimplemented from MaterialWavelengthRangeInterface.

◆ wavelengthGrid()

SpecialtyWavelengthGridProbe::wavelengthGrid ( ) const
inline

This function returns the value of the discoverable item property wavelengthGrid : "the wavelength grid for this probe" .

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

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

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

◆ wavelengthRange()

Range SpecialtyWavelengthGridProbe::wavelengthRange ( ) const
overridevirtual

This function returns a wavelength range corresponding to the user-configured wavelength grid for this probe, if any, indicating that wavelength-dependent material properties may be required for this wavelength range.

Implements WavelengthRangeInterface.


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