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

#include <TrustGraphiteGrainComposition.hpp>

Inheritance diagram for TrustGraphiteGrainComposition:
Inheritance graph
[legend]

Public Member Functions

 TrustGraphiteGrainComposition (SimulationItem *parent)
 
double bulkDensity () const override
 
string name () const override
 
string resourceNameForEnthalpies () const override
 
string resourceNameForOpticalProps () const override
 
- Public Member Functions inherited from GrainComposition
virtual double bulkDensity () const =0
 
virtual string name () const =0
 
virtual string resourceNameForEnthalpies () const =0
 
virtual string resourceNameForMuellerMatrix () const
 
virtual string resourceNameForOpticalProps () const =0
 
virtual bool resourcesForSpheroidalEmission (bool &resource, double &interpol, string &tableName1, string &tableName2) 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

 TrustGraphiteGrainComposition ()
 
- Protected Member Functions inherited from GrainComposition
 GrainComposition ()
 
- 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 = GrainComposition
 
using ItemType = TrustGraphiteGrainComposition
 

Friends

class ItemRegistry
 

Detailed Description

The TrustGraphiteGrainComposition class represents the optical and calorimetric properties of graphite dust grains according to the dust model used for the TRUST benchmark (Gordon et al. 2017, A&A, 603, 114) and the SHG benchmark (Camps et al. 2015, A&A 580, A87).

The underlying data is provided by Karel Misselt as part of a download from the TRUST web site (http://ipag.osug.fr/RT13/RTTRUST/opa.php) and generally describes the BARE-GR-S model of Zubko, Dwek, and Arendt 2004, ApJS, 152, 211. The bulk mass density for the graphite grains is set to the value of 2240 kg/m3.

Constructor & Destructor Documentation

◆ TrustGraphiteGrainComposition() [1/2]

TrustGraphiteGrainComposition::TrustGraphiteGrainComposition ( )
inlineprotected

Default constructor for concrete Item subclass TrustGraphiteGrainComposition : "a TRUST benchmark graphite dust grain composition" .

◆ TrustGraphiteGrainComposition() [2/2]

TrustGraphiteGrainComposition::TrustGraphiteGrainComposition ( SimulationItem parent)
explicit

This constructor can be invoked by classes that wish to hard-code the creation of a new grain composition 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), and it's setup() function has been called.

Member Function Documentation

◆ bulkDensity()

double TrustGraphiteGrainComposition::bulkDensity ( ) const
overridevirtual

This function returns the bulk mass density of this grain material.

Implements GrainComposition.

◆ name()

string TrustGraphiteGrainComposition::name ( ) const
overridevirtual

This function returns a brief human-readable identifier for this grain composition.

Implements GrainComposition.

◆ resourceNameForEnthalpies()

string TrustGraphiteGrainComposition::resourceNameForEnthalpies ( ) const
overridevirtual

This function returns the name of the stored table resource tabulating the specific enthalpies per unit volume as a function of temperature.

Implements GrainComposition.

◆ resourceNameForOpticalProps()

string TrustGraphiteGrainComposition::resourceNameForOpticalProps ( ) const
overridevirtual

This function returns the name of the stored table resource tabulating the basic optical properties (absorption and scattering efficiencies and asymmetry parameter) as a function of wavelength and grain size.

Implements GrainComposition.


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