The SKIRT project
advanced radiative transfer for astrophysics
OligoWavelengthGrid Class Reference

#include <OligoWavelengthGrid.hpp>

Inheritance diagram for OligoWavelengthGrid:

Public Member Functions

 OligoWavelengthGrid (SimulationItem *parent, const vector< double > &wavelengths)
Public Member Functions inherited from DisjointWavelengthGrid
int bin (double lambda) const override
vector< int > bins (double lambda) const override
const Arraydlambdav () const
double effectiveWidth (int ell) const override
Array extdlambdav () const
Array extlambdav () const
const Arraylambdav () const
double leftBorder (int ell) const override
int numBins () const override
double rightBorder (int ell) const override
double transmission (int ell, double lambda) const override
double wavelength (int ell) const override
Public Member Functions inherited from WavelengthGrid
Range wavelengthRange () 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

void setupSelfBefore () override
Protected Member Functions inherited from DisjointWavelengthGrid
 DisjointWavelengthGrid ()
void setupSelfAfter () override
void setWavelengthBins (const Array &lambdav, double relativeHalfWidth, bool constantWidth=false)
void setWavelengthBorders (const Array &borderv, bool logScale)
void setWavelengthRange (const Array &lambdav, bool logScale)
void setWavelengthSegments (const Array &bordcharv)
void setWavelengthSegments (const vector< double > &borderv, const vector< double > &characv)
Protected Member Functions inherited from WavelengthGrid
 WavelengthGrid ()
Protected Member Functions inherited from SimulationItem
 SimulationItem ()
virtual bool offersInterface (const std::type_info &interfaceTypeInfo) const
Protected Member Functions inherited from Item
 Item ()

Private Attributes

vector< double > _wavelengths

Detailed Description

OligoWavelengthGrid is a subclass of the DisjointWavelengthGrid class representing the wavelength grid in an oligochromatic simulation. The class constructs a set of distinct nonadjacent wavelength bins with a half bin width given by 1/1000 of the shortest wavelength in the list. Refer to the DisjointWavelengthGrid class for more details.

The list of wavelengths is specified through the constructor, because the oligo wavelength grid is created programmatically rather than directly configured by the user. The order of the specified wavelengths is not important; they will be sorted anyway.

Constructor & Destructor Documentation

◆ OligoWavelengthGrid()

OligoWavelengthGrid::OligoWavelengthGrid ( SimulationItem * parent,
const vector< double > & wavelengths )
explicit

This constructor can be invoked programmatically to create an oligochromatic wavelength grid. Before the constructor returns, the newly created object is hooked up as a child to the specified parent in the simulation hierarchy (so it will automatically be deleted), and its setup() function has been called.

Member Function Documentation

◆ setupSelfBefore()

void OligoWavelengthGrid::setupSelfBefore ( )
overrideprotectedvirtual

This function sets the wavelength grid to the wavelengths specified in the constructor.

Reimplemented from SimulationItem.


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