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

#include <GrainSizeDistribution.hpp>

Inheritance diagram for GrainSizeDistribution:
Inheritance graph
[legend]

Public Member Functions

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

 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 = SimulationItem
 
using ItemType = GrainSizeDistribution
 

Friends

class ItemRegistry
 

Detailed Description

GrainSizeDistribution is an abstract base class that represents a size distribution for the dust grains in a particular dust population. Specifically, it represents a function \(\text{dnda}(a)\) that specifies the relative number of dust grains with size \(a\) in the population,

\[ \text{dnda}(a) \propto \frac{\text{d}n_\text{D}}{\text{d}a} \qquad \text{for}\quad a_\text{min} \leq a \leq a_\text{max}. \]

An appropriate proportionality factor for the size distribution function is determined through a normalization mechanism provided externally to this class. Some GrainSizeDistribution subclasses implement a size distribution function with a well-defined proportionality factor, documented in the class header, while other subclasses have arbitrary scaling (i.e. the proportionality factor is unspecified). In the first case, the normalization can be done by specifying a multiplication factor on the size distribution (often just a factor of one). In both cases, the normalization can be done by specifying the amount of dust in the population, for example as a dust mass per hydrogen atom or per hydrogen mass.

The GrainSizeDistribution class offers access to the size distribution range and the size distribution value within that range. It expects each subclass to implement the functions declared in this interface, i.e. the functions amin() and amax() to specify the grain size range, and the function dnda() to specify the grain size distribution function within that range.

Constructor & Destructor Documentation

◆ GrainSizeDistribution()

GrainSizeDistribution::GrainSizeDistribution ( )
inlineprotected

Default constructor for abstract Item subclass GrainSizeDistribution : "a dust grain size distribution" .

Member Function Documentation

◆ amax()

virtual double GrainSizeDistribution::amax ( ) const
pure virtual

This function returns the maximum grain size \(a_\text{max}\), i.e. the upper limit of the distribution.

Implemented in FileGrainSizeDistribution, ListGrainSizeDistribution, RangeGrainSizeDistribution, SingleGrainSizeDistribution, ZubkoGraphiteGrainSizeDistribution, ZubkoPAHGrainSizeDistribution, and ZubkoSilicateGrainSizeDistribution.

◆ amin()

virtual double GrainSizeDistribution::amin ( ) const
pure virtual

This function returns the minimum grain size \(a_\text{min}\), i.e. the lower limit of the distribution.

Implemented in FileGrainSizeDistribution, ListGrainSizeDistribution, RangeGrainSizeDistribution, SingleGrainSizeDistribution, ZubkoGraphiteGrainSizeDistribution, ZubkoPAHGrainSizeDistribution, and ZubkoSilicateGrainSizeDistribution.

◆ dnda()

virtual double GrainSizeDistribution::dnda ( double  a) const
pure virtual

This function returns the value of the distribution \(\text{dnda} \propto \frac{\text{d}n_\text{D}}{\text{d}a}\) for a given grain size \(a\). If \(a<a_\text{min}\) or \(a>a_\text{max}\) the result is undefined (i.e. the function does not need to check the bounds).

Implemented in FileGrainSizeDistribution, ListGrainSizeDistribution, LogNormalGrainSizeDistribution, ModifiedLogNormalGrainSizeDistribution, ModifiedPowerLawGrainSizeDistribution, PowerLawGrainSizeDistribution, SingleGrainSizeDistribution, ZubkoGraphiteGrainSizeDistribution, ZubkoPAHGrainSizeDistribution, and ZubkoSilicateGrainSizeDistribution.


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