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

#include <LinearDustDestructionRecipe.hpp>

Inheritance diagram for LinearDustDestructionRecipe:
Inheritance graph
[legend]

Public Member Functions

double densityFraction (bool graphite, double a, const Array &Jv, double T) const override
 
double maxGraphiteTemperature () const
 
double maxSilicateTemperature () const
 
double minGraphiteTemperature () const
 
double minSilicateTemperature () const
 
- Public Member Functions inherited from DustDestructionRecipe
void beginUpdate (int numCells) override
 
virtual double densityFraction (bool graphite, double a, const Array &Jv, double T) const =0
 
double densityFractionTolerance () const
 
UpdateStatus update (MaterialState *state, const Array &Jv) override
 
- Public Member Functions inherited from DynamicStateRecipe
virtual void beginUpdate (int numCells)=0
 
virtual bool endUpdate (int numCells, int numUpdated, int numNotConverged)
 
int maxNotConvergedCells () const
 
virtual UpdateStatus update (MaterialState *state, const Array &Jv)=0
 
- 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

 LinearDustDestructionRecipe ()
 
void setupSelfBefore () override
 
- Protected Member Functions inherited from DustDestructionRecipe
 DustDestructionRecipe ()
 
- Protected Member Functions inherited from DynamicStateRecipe
 DynamicStateRecipe ()
 
- 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 = DustDestructionRecipe
 
using ItemType = LinearDustDestructionRecipe
 

Private Attributes

double _maxGraphiteTemperature
 
double _maxSilicateTemperature
 
double _minGraphiteTemperature
 
double _minSilicateTemperature
 

Friends

class ItemRegistry
 

Detailed Description

LinearDustDestructionRecipe derives from DustDestructionRecipe to implement a basic dust destruction recipe that depends solely on the equilibrium temperature \(T_\mathrm{eq}\) of the grain and on two cutoff temperatures \(T_\mathrm{min}\) and \(T_\mathrm{max}\). These cutoff temperatures can be configured separately for each type of grain material (silicate or graphite).

Specifically, there is no destruction if \(T_\mathrm{eq}<=T_\mathrm{min}\); all grains are destroyed if \(T_\mathrm{eq}>=T_\mathrm{min}\); and in between the destruction fraction is obtained by linear interpolation.

Constructor & Destructor Documentation

◆ LinearDustDestructionRecipe()

LinearDustDestructionRecipe::LinearDustDestructionRecipe ( )
inlineprotected

Default constructor for concrete Item subclass LinearDustDestructionRecipe : "a dust destruction recipe using a linear temperature dependence" .

Member Function Documentation

◆ densityFraction()

double LinearDustDestructionRecipe::densityFraction ( bool  graphite,
double  a,
const Array Jv,
double  T 
) const
overridevirtual

This function returns the non-destroyed density fraction for a grain population with the specified type (graphite or silicate) and equilibrium temperature using the linear dependence described in the class header. The grain radius and the radiation field are not used.

Implements DustDestructionRecipe.

◆ maxGraphiteTemperature()

LinearDustDestructionRecipe::maxGraphiteTemperature ( ) const
inline

This function returns the value of the discoverable double property maxGraphiteTemperature : "the temperature above which all graphite grains are destroyed" .

This property represents a physical quantity of type "temperature" .

The minimum value for this property is "[3 K" .

The maximum value for this property is "30000 K]" .

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

◆ maxSilicateTemperature()

LinearDustDestructionRecipe::maxSilicateTemperature ( ) const
inline

This function returns the value of the discoverable double property maxSilicateTemperature : "the temperature above which all silicate grains are destroyed" .

This property represents a physical quantity of type "temperature" .

The minimum value for this property is "[3 K" .

The maximum value for this property is "30000 K]" .

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

◆ minGraphiteTemperature()

LinearDustDestructionRecipe::minGraphiteTemperature ( ) const
inline

This function returns the value of the discoverable double property minGraphiteTemperature : "the temperature below which graphite grains are not destroyed" .

This property represents a physical quantity of type "temperature" .

The minimum value for this property is "[3 K" .

The maximum value for this property is "30000 K]" .

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

◆ minSilicateTemperature()

LinearDustDestructionRecipe::minSilicateTemperature ( ) const
inline

This function returns the value of the discoverable double property minSilicateTemperature : "the temperature below which silicate grains are not destroyed" .

This property represents a physical quantity of type "temperature" .

The minimum value for this property is "[3 K" .

The maximum value for this property is "30000 K]" .

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

◆ setupSelfBefore()

void LinearDustDestructionRecipe::setupSelfBefore ( )
overrideprotectedvirtual

This function verifies that the maximum temperatures are not below the minimum temperatures.

Reimplemented from SimulationItem.


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