The SKIRT project
advanced radiative transfer for astrophysics
EmittingGasMix Class Reference

#include <EmittingGasMix.hpp>

Inheritance diagram for EmittingGasMix:

Public Member Functions

MaterialType materialType () const override
double sourceWeight () const
double wavelengthBias () const
WavelengthDistributionwavelengthBiasDistribution () const
Range wavelengthRange () 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 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 bool peeloffScattering (double &I, double &Q, double &U, double &V, double &lambda, Direction bfkobs, Direction bfky, const MaterialState *state, const PhotonPacket *pp) const
virtual void performScattering (double lambda, const MaterialState *state, PhotonPacket *pp) const
virtual bool scatteringEmulatesSecondaryEmission () const
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
Public Member Functions inherited from WavelengthRangeInterface
virtual ~WavelengthRangeInterface ()

Protected Member Functions

 EmittingGasMix ()
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 ()
Protected Member Functions inherited from Item
 Item ()
Protected Member Functions inherited from SourceWavelengthRangeInterface
 SourceWavelengthRangeInterface ()
Protected Member Functions inherited from WavelengthRangeInterface
 WavelengthRangeInterface ()

Private Types

using BaseType
using ItemType

Private Attributes

double _sourceWeight
double _wavelengthBias
WavelengthDistribution_wavelengthBiasDistribution

Friends

class ItemRegistry

Additional Inherited Members

Public Types inherited from MaterialMix
enum class  DynamicStateType { None , Primary , Secondary , PrimaryIfMergedIterations }
enum class  MaterialType { Dust , Electrons , Gas }

Detailed Description

The EmittingGasMix is an abstract base class describing gas material mixes that support secondary line or continuum emission. It provides generic configuration options related to secondary gas emission.

When an item of this type is used, the names provided by the conditional value expression "GasMix" are inserted into the name sets used for evaluating Boolean expressions.

Constructor & Destructor Documentation

◆ EmittingGasMix()

EmittingGasMix::EmittingGasMix ( )
inlineprotected

Default constructor for abstract Item subclass EmittingGasMix: "an emitting gas mix".

Member Function Documentation

◆ materialType()

MaterialType EmittingGasMix::materialType ( ) const
overridevirtual

This function returns the fundamental material type represented by this material mix, which is MaterialType::Gas.

Implements MaterialMix.

◆ sourceWeight()

double EmittingGasMix::sourceWeight ( ) const
inline

This function returns the value of the discoverable double property sourceWeight: "the weight of this secondary source for the number of photon packets launched".

The minimum value for this property is "]0".

The maximum value for this property is "1000]".

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

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.

◆ wavelengthBias()

double EmittingGasMix::wavelengthBias ( ) const
inline

This function returns the value of the discoverable double property wavelengthBias: "the fraction of secondary photon packet wavelengths sampled from a bias distribution".

The minimum value for this property is "[0".

The maximum value for this property is "1]".

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

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.

◆ wavelengthBiasDistribution()

WavelengthDistribution * EmittingGasMix::wavelengthBiasDistribution ( ) const
inline

This function returns the value of the discoverable item property wavelengthBiasDistribution: "the bias distribution for sampling secondary photon packet wavelengths".

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

This property is relevant only if the Boolean expression "wavelengthBias" 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.

◆ wavelengthRange()

Range EmittingGasMix::wavelengthRange ( ) const
overridevirtual

This function returns the wavelength range of the gas emission wavelength grid, implementing the SourceWavelengthRangeInterface interface so that the wavelength bias distribution configured here can locate its associated "source" wavelength range.

The function determines and returns the union of wavelength ranges published by the subclass for line and continuum emission.

Implements WavelengthRangeInterface.


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