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

#include <ModifiedPowerLawGrainSizeDistribution.hpp>

Inheritance diagram for ModifiedPowerLawGrainSizeDistribution:
Inheritance graph
[legend]

Public Member Functions

 ModifiedPowerLawGrainSizeDistribution (SimulationItem *parent, double minSize, double maxSize, double powerLawIndex, double turnOffPoint, double scaleExponentialDecay, double exponentExponentialDecay, double scaleCurvature, double strengthCurvature, double exponentCurvature)
 
double dnda (double a) const override
 
double exponentCurvature () const
 
double exponentExponentialDecay () const
 
double powerLawIndex () const
 
double scaleCurvature () const
 
double scaleExponentialDecay () const
 
double strengthCurvature () const
 
double turnOffPoint () const
 
- Public Member Functions inherited from RangeGrainSizeDistribution
double amax () const override
 
double amin () const override
 
double maxSize () const
 
double minSize () const
 
virtual double amax () const =0
 
virtual double amin () const =0
 
virtual double dnda (double a) const =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

 ModifiedPowerLawGrainSizeDistribution ()
 
- Protected Member Functions inherited from RangeGrainSizeDistribution
 RangeGrainSizeDistribution ()
 
 RangeGrainSizeDistribution (double minSize, double maxSize)
 
void setupSelfBefore () override
 
- Protected Member Functions inherited from GrainSizeDistribution
 GrainSizeDistribution ()
 
- 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 = RangeGrainSizeDistribution
 
using ItemType = ModifiedPowerLawGrainSizeDistribution
 

Private Attributes

const double & _ac
 
const double & _alpha
 
const double & _at
 
const double & _au
 
const double & _eta
 
double _exponentCurvature
 
double _exponentExponentialDecay
 
const double & _gamma
 
double _powerLawIndex
 
double _scaleCurvature
 
double _scaleExponentialDecay
 
double _strengthCurvature
 
double _turnOffPoint
 
const double & _zeta
 

Friends

class ItemRegistry
 

Detailed Description

ModifiedPowerLawGrainSizeDistribution is a GrainSizeDistribution subclass that represents a dust grain size distribution of the form

\[ \frac{\text{d}n_\text{D}}{\text{d}a} \propto a^{\alpha} \,f_\text{ed}(a) \,f_\text{cv}(a) \qquad\text{for}\quad a_\text{min} \leq a \leq a_\text{max}, \]

with an exponential decay term

\[ f_\text{ed}(a) = \begin{cases} 1 & \quad a\leq a_\text{t} \\ \exp\left(-[(a-a_\text{t})/a_\text{c}]^\gamma \right) & \quad a>a_\text{t} \end{cases} \]

and a curvature term

\[ f_\text{cv}(a) = \left[ 1+|\zeta|\,(a/a_u)^\eta \right]^{\text{sign}(\zeta)}. \]

The size range of the distribution can be configured in the RangeGrainSizeDistribution base class. The remaining seven parameters \(\alpha\), \(a_\text{t}\), \(a_\text{c}\), \(\gamma\), \(a_\text{u}\), \(\zeta\) and \(\eta\) can be configured as attributes in this class. The function is scaled arbitrarily.

The functional form for the grain size distribution implemented by this class is inspired by the DustEM code, which is described in Compiègne et al. 2011 (AA, 525, A103) and can be downloaded from http://www.ias.u-psud.fr/DUSTEM/.

Constructor & Destructor Documentation

◆ ModifiedPowerLawGrainSizeDistribution() [1/2]

ModifiedPowerLawGrainSizeDistribution::ModifiedPowerLawGrainSizeDistribution ( )
inlineprotected

Default constructor for concrete Item subclass ModifiedPowerLawGrainSizeDistribution : "a modified power-law dust grain size distribution" .

◆ ModifiedPowerLawGrainSizeDistribution() [2/2]

ModifiedPowerLawGrainSizeDistribution::ModifiedPowerLawGrainSizeDistribution ( SimulationItem parent,
double  minSize,
double  maxSize,
double  powerLawIndex,
double  turnOffPoint,
double  scaleExponentialDecay,
double  exponentExponentialDecay,
double  scaleCurvature,
double  strengthCurvature,
double  exponentCurvature 
)
explicit

This constructor can be invoked by classes that wish to hard-code the creation of a new grain size distribution object of this type (as opposed to creation through the ski file). 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), its properties have been initialized to the specified values, and its setup() function has been called.

Member Function Documentation

◆ dnda()

double ModifiedPowerLawGrainSizeDistribution::dnda ( double  a) const
overridevirtual

This function returns the value of \(\frac{\text{d}n_\text{D}}{\text{d}a}\) as described in the header for this class (with an arbitrary proportionality factor of one).

Implements GrainSizeDistribution.

◆ exponentCurvature()

ModifiedPowerLawGrainSizeDistribution::exponentCurvature ( ) const
inline

This function returns the value of the discoverable double property exponentCurvature : "the exponent η in the curvature term" .

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

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

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

◆ exponentExponentialDecay()

ModifiedPowerLawGrainSizeDistribution::exponentExponentialDecay ( ) const
inline

This function returns the value of the discoverable double property exponentExponentialDecay : "the exponent γ in the exponential decay term" .

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

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

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

◆ powerLawIndex()

ModifiedPowerLawGrainSizeDistribution::powerLawIndex ( ) const
inline

This function returns the value of the discoverable double property powerLawIndex : "the index α of the power law" .

The minimum value for this property is "[-10" .

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

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

◆ scaleCurvature()

ModifiedPowerLawGrainSizeDistribution::scaleCurvature ( ) const
inline

This function returns the value of the discoverable double property scaleCurvature : "the scale a_u in the curvature term" .

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

The minimum value for this property is "[1 Angstrom" .

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

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

◆ scaleExponentialDecay()

ModifiedPowerLawGrainSizeDistribution::scaleExponentialDecay ( ) const
inline

This function returns the value of the discoverable double property scaleExponentialDecay : "the scale a_c in the exponential decay term" .

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

The minimum value for this property is "[1 Angstrom" .

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

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

◆ strengthCurvature()

ModifiedPowerLawGrainSizeDistribution::strengthCurvature ( ) const
inline

This function returns the value of the discoverable double property strengthCurvature : "the strength ζ in the curvature term" .

The minimum value for this property is "[-10" .

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

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

◆ turnOffPoint()

ModifiedPowerLawGrainSizeDistribution::turnOffPoint ( ) const
inline

This function returns the value of the discoverable double property turnOffPoint : "the turn-off point a_t in the exponential decay term" .

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

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

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

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


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