The SKIRT project
advanced radiative transfer for astrophysics
Protected Member Functions | Private Types | Friends | List of all members
TabulatedDustMix Class Referenceabstract

#include <TabulatedDustMix.hpp>

Inheritance diagram for TabulatedDustMix:
Inheritance graph
[legend]

Protected Member Functions

 TabulatedDustMix ()
 
virtual double getDustProperties (Array &lambdav, Array &kappaextv, Array &albedov, Array &asymmparv) const =0
 
double getOpticalProperties (const Array &lambdav, const Array &thetav, Array &sigmaabsv, Array &sigmascav, Array &asymmparv, Table< 2 > &S11vv, Table< 2 > &S12vv, Table< 2 > &S33vv, Table< 2 > &S34vv, ArrayTable< 2 > &sigmaabsvv, ArrayTable< 2 > &sigmaabspolvv) override
 
- Protected Member Functions inherited from DustMix
 DustMix ()
 
virtual double getOpticalProperties (const Array &lambdav, const Array &thetav, Array &sigmaabsv, Array &sigmascav, Array &asymmparv, Table< 2 > &S11vv, Table< 2 > &S12vv, Table< 2 > &S33vv, Table< 2 > &S34vv, ArrayTable< 2 > &sigmaabsvv, ArrayTable< 2 > &sigmaabspolvv)=0
 
void informAvailableWavelengthRange (Range available)
 
virtual size_t initializeExtraProperties (const Array &lambdav)
 
void setupSelfAfter () override
 
- Protected Member Functions inherited from MaterialMix
 MaterialMix ()
 
Configurationconfig () const
 
Randomrandom () const
 
void setupSelfBefore () override
 
- 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 = DustMix
 
using ItemType = TabulatedDustMix
 

Friends

class ItemRegistry
 

Additional Inherited Members

- Public Types inherited from DustMix
enum class  ScatteringMode { HenyeyGreenstein , MaterialPhaseFunction , SphericalPolarization , SpheroidalPolarization }
 
- Public Types inherited from MaterialMix
enum class  DynamicStateType { None , Primary , Secondary , PrimaryIfMergedIterations }
 
enum class  MaterialType { Dust , Electrons , Gas }
 
- Public Member Functions inherited from DustMix
double asymmpar (double lambda) const override
 
Array emissionSpectrum (const MaterialState *state, const Array &Jv) const override
 
DisjointWavelengthGridemissionWavelengthGrid () const override
 
Array emissivity (const Array &Jv) const override
 
bool hasContinuumEmission () const override
 
double indicativeTemperature (const MaterialState *state, const Array &Jv) const override
 
double mass () const override
 
MaterialType materialType () const override
 
double opacityAbs (double lambda, const MaterialState *state, const PhotonPacket *pp) const override
 
double opacityExt (double lambda, const MaterialState *state, const PhotonPacket *pp) const override
 
double opacitySca (double lambda, const MaterialState *state, const PhotonPacket *pp) const override
 
void peeloffScattering (double &I, double &Q, double &U, double &V, double &lambda, Direction bfkobs, Direction bfky, const MaterialState *state, const PhotonPacket *pp) const override
 
void performScattering (double lambda, const MaterialState *state, PhotonPacket *pp) const override
 
virtual ScatteringMode scatteringMode () const
 
double sectionAbs (double lambda) const override
 
double sectionExt (double lambda) const override
 
const ArraysectionsAbs (double lambda) const override
 
const ArraysectionsAbspol (double lambda) const override
 
double sectionSca (double lambda) const override
 
vector< StateVariablespecificStateVariableInfo () const override
 
const ArraythetaGrid () const override
 
- Public Member Functions inherited from MaterialMix
virtual double asymmpar (double lambda) const
 
virtual Array emissionSpectrum (const MaterialState *state, const Array &Jv) const
 
virtual DisjointWavelengthGridemissionWavelengthGrid () const
 
virtual Array emissivity (const Array &Jv) const
 
virtual bool hasContinuumEmission () const
 
virtual DynamicStateType hasDynamicMediumState () const
 
virtual bool hasExtraSpecificState () const
 
virtual bool hasLineEmission () const
 
virtual bool hasNegativeExtinction () const
 
virtual bool hasPolarizedAbsorption () const
 
virtual bool hasPolarizedEmission () const
 
virtual bool hasPolarizedScattering () const
 
virtual bool hasResonantScattering () const
 
virtual bool hasScatteringDispersion () const
 
virtual bool hasStochasticDustEmission () const
 
virtual double indicativeTemperature (const MaterialState *state, const Array &Jv) const
 
virtual void initializeSpecificState (MaterialState *state, double metallicity, double temperature, const Array &params) const
 
bool isDust () const
 
bool isElectrons () const
 
bool isGas () const
 
virtual bool isSpecificStateConverged (int numCells, int numUpdated, int numNotConverged, MaterialState *currentAggregate, MaterialState *previousAggregate) const
 
virtual Array lineEmissionCenters () const
 
virtual Array lineEmissionMasses () const
 
virtual Array lineEmissionSpectrum (const MaterialState *state, const Array &Jv) const
 
virtual double mass () const =0
 
virtual MaterialType materialType () const =0
 
virtual double opacityAbs (double lambda, const MaterialState *state, const PhotonPacket *pp) const =0
 
virtual double opacityExt (double lambda, const MaterialState *state, const PhotonPacket *pp) const =0
 
virtual double opacitySca (double lambda, const MaterialState *state, const PhotonPacket *pp) const =0
 
virtual vector< SnapshotParameterparameterInfo () const
 
virtual void peeloffScattering (double &I, double &Q, double &U, double &V, double &lambda, Direction bfkobs, Direction bfky, const MaterialState *state, const PhotonPacket *pp) const =0
 
virtual void performScattering (double lambda, const MaterialState *state, PhotonPacket *pp) const =0
 
virtual double sectionAbs (double lambda) const =0
 
virtual double sectionExt (double lambda) const =0
 
virtual const ArraysectionsAbs (double lambda) const
 
virtual const ArraysectionsAbspol (double lambda) const
 
virtual double sectionSca (double lambda) const =0
 
virtual vector< StateVariablespecificStateVariableInfo () const =0
 
virtual const ArraythetaGrid () const
 
virtual UpdateStatus updateSpecificState (MaterialState *state, const Array &Jv) 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
 

Detailed Description

TabulatedDustMix is an abstract class for representing basic dust mixes described by tabulated properties for a single representative grain using the Henyey-Greenstein scattering mode.

Specifically, the tabulated properties include the extinction mass coefficient \(\kappa^\text{ext}_\lambda\), the scattering albedo \(\varpi_\lambda\) and the scattering asymmetry parameter \(g_\lambda\), as a function of wavelength \(\lambda\). Because a basic dust mix such as this one is usually used in isolation and the dust distribution is normalized to a given optical depth or total dust mass, the value of the extinction coefficient is essentially scale free. Still, the dust mass per hydrogen atom \(\mu\) may be specified to set the absolute scale of the property, so that the cross sections listed by some of the probes have an appropriately scaled value.

The wavelengths must be listed in increasing or decreasing order. Property values outside of the tabulated wavelength range are clamped to the nearest border value. As a special-case consequence, if only a single wavelength is tabulated, the properties are considered to be constant for all wavelengths.

The subclass must load the tabulated data, and this abstract class handles everything else.

This item type is allowed only if the Boolean expression "!StochasticDustEmission" evaluates to true after replacing the names by true or false depending on their presence.

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

Constructor & Destructor Documentation

◆ TabulatedDustMix()

TabulatedDustMix::TabulatedDustMix ( )
inlineprotected

Default constructor for abstract Item subclass TabulatedDustMix : "a basic dust mix with properties tabulated by the user" .

Member Function Documentation

◆ getDustProperties()

virtual double TabulatedDustMix::getDustProperties ( Array lambdav,
Array kappaextv,
Array albedov,
Array asymmparv 
) const
protectedpure virtual

This function must be implemented in each subclass to store the wavelengths and the corresponding tabulated properties in the array arguments, and to return the dust mass per hydrogen atom. The function must guarantee that all arrays have the same size. The wavelengths must be listed in increasing or decreasing order.

Implemented in MeanFileDustMix, and MeanListDustMix.

◆ getOpticalProperties()

double TabulatedDustMix::getOpticalProperties ( const Array lambdav,
const Array thetav,
Array sigmaabsv,
Array sigmascav,
Array asymmparv,
Table< 2 > &  S11vv,
Table< 2 > &  S12vv,
Table< 2 > &  S33vv,
Table< 2 > &  S34vv,
ArrayTable< 2 > &  sigmaabsvv,
ArrayTable< 2 > &  sigmaabspolvv 
)
overrideprotectedvirtual

This function is invoked by the DustMix base class to obtain the representative grain optical properties for this dust mix. The first argument specifies the wavelength grid on which the absorption and scattering cross sections and the asymmetry parameter must be tabulated. The second argument is not used. The function store these tabulated properties into the three subsequent output arrays, which will already have the same length as the input wavelength grid when the function gets called. The Mueller matrix tables remain untouched. Finally, the function returns the dust mass per hydrogen atom for the dust mix.

This function in turn invokes the getDustProperties() function that must be implemented by each TabulatedDustMix subclass, and it subsequently resamples the returned properties on the requested wavelength grid.

Implements DustMix.


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