The SKIRT project
advanced radiative transfer for astrophysics
MeanTrustBenchmarkDustMix Class Reference

#include <MeanTrustBenchmarkDustMix.hpp>

Inheritance diagram for MeanTrustBenchmarkDustMix:

Public Types

enum class  ScatteringType : int { HenyeyGreenstein , MaterialPhaseFunction , SphericalPolarization }
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

bool hasPolarizedScattering () const override
ScatteringMode scatteringMode () const override
ScatteringType scatteringType () const
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
bool 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
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 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 hasResonantScattering () const
virtual bool hasScatteringDispersion () const
virtual bool hasStochasticDustEmission () 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 vector< SnapshotParameterparameterInfo () const
virtual bool scatteringEmulatesSecondaryEmission () 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

Protected Member Functions

 MeanTrustBenchmarkDustMix ()
string resourceNameForMuellerMatrix () const override
string resourceNameForOpticalProps () const override
Protected Member Functions inherited from SingleGrainDustMix
 SingleGrainDustMix ()
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 ()
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
Protected Member Functions inherited from Item
 Item ()

Private Types

using BaseType
using ItemType

Private Attributes

ScatteringType _scatteringType

Friends

class ItemRegistry

Detailed Description

The MeanTrustBenchmarkDustMix class represents a population of identical dust grains with properties approximating those of a mixture of bare (i.e. non-composite) graphite, silicate and PAH dust grains. The size distribution of each of these dust grain populations is fine-tuned in such a way that the global dust properties accurately reproduce the extinction, emission and abundance constraints on the Milky Way. The size distributions are taken from Zubko, Dwek & Arendt (2004, ApJS, 152, 211) and correspond to model BARE_GR_S.

This dust mix has been prepared by Karl Misselt for the TRUST benchmark simulations; see Camps et al. 2015 (A&A 580:A87) and Gordon et al. 2017 (A&A 603:A114). The data can be downloaded from http://www.shg.ugent.be/html/_downloads.html or http://ipag.osug.fr/RT13/RTTRUST/opa.php

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.

Member Enumeration Documentation

◆ ScatteringType

The enumeration type indicating the scattering mode.

HenyeyGreenstein : "use the Henyey-Greenstein phase function (unpolarized)".

MaterialPhaseFunction : "use the phase function derived from actual material properties (unpolarized)".

SphericalPolarization : "support polarization through scattering by spherical grains".

Constructor & Destructor Documentation

◆ MeanTrustBenchmarkDustMix()

MeanTrustBenchmarkDustMix::MeanTrustBenchmarkDustMix ( )
inlineprotected

Default constructor for concrete Item subclass MeanTrustBenchmarkDustMix: "a TRUST benchmark dust mix (mean properties, optionally with polarization)".

Member Function Documentation

◆ hasPolarizedScattering()

bool MeanTrustBenchmarkDustMix::hasPolarizedScattering ( ) const
overridevirtual

This function returns a flag indicating whether the material mix supports polarization during scattering events or not. For this dust mix, the function returns true if the user configured the SphericalPolarization scattering type, and false otherwise.

Reimplemented from MaterialMix.

◆ resourceNameForMuellerMatrix()

string MeanTrustBenchmarkDustMix::resourceNameForMuellerMatrix ( ) const
overrideprotectedvirtual

This function returns the name of the stored table resource tabulating the Mueller matrix elements for this dust mix.

Reimplemented from SingleGrainDustMix.

◆ resourceNameForOpticalProps()

string MeanTrustBenchmarkDustMix::resourceNameForOpticalProps ( ) const
overrideprotectedvirtual

This function returns the name of the stored table resource tabulating the basic optical properties for this dust mix.

Implements SingleGrainDustMix.

◆ scatteringMode()

ScatteringMode MeanTrustBenchmarkDustMix::scatteringMode ( ) const
overridevirtual

This function returns the scattering mode supported by this material mix as configured by the user through the scatteringType property.

Reimplemented from DustMix.

◆ scatteringType()

ScatteringType MeanTrustBenchmarkDustMix::scatteringType ( ) const
inline

This function returns the value of the discoverable ScatteringType enumeration property scatteringType: "the type of scattering to be implemented".

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


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