 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <SpheroidalSilicateGrainComposition.hpp>
Public Types | |
| enum class | TableType : int { Builtin , OneTable , TwoTables } |
Public Member Functions | |
| string | alignedEmissionTable () const |
| double | alignmentFraction () const |
| string | emissionTable () const |
| string | name () const override |
| string | nonAlignedEmissionTable () const |
| bool | resourcesForSpheroidalEmission (bool &resource, double &interpol, string &tableName1, string &tableName2) const override |
| TableType | tableType () const |
 Public Member Functions inherited from PolarizedSilicateGrainComposition | |
| double | bulkDensity () const override |
| string | name () const override |
| string | resourceNameForEnthalpies () const override |
| string | resourceNameForMuellerMatrix () const override |
| string | resourceNameForOpticalProps () const override |
| 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 Item * | getItemProperty (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) |
| Item & | operator= (const Item &)=delete |
| Item * | parent () 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 | |
| SpheroidalSilicateGrainComposition () | |
| Protected Member Functions inherited from PolarizedSilicateGrainComposition | |
| PolarizedSilicateGrainComposition () | |
| 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 = PolarizedSilicateGrainComposition |
| using | ItemType = SpheroidalSilicateGrainComposition |
Private Attributes | |
| string | _alignedEmissionTable |
| double | _alignmentFraction |
| string | _emissionTable |
| string | _nonAlignedEmissionTable |
| TableType | _tableType |
Friends | |
| class | ItemRegistry |
The SpheroidalSilicateGrainComposition class represents the optical and calorimetric properties of spheroidal silicate dust grains with partial support for polarization. More precisely, the current implementation supports polarized thermal emission by (partially) aligned spheroidal grains, but assumes spherical grains for scattering and absorption interactions.
The optical scattering and absorption properties and the calorimetric properties are taken from the PolarizedSilicateGrainComposition class, from which this class derives. The optical properties driving the polarization signature for thermal emission are obtained from additional built-in tables or can be provided by the user, as described below.
In the current implementation, the internally used optical properties table always assumes a fixed spheroidal dust model with a constant alignment. The table generally is a linear combination of a table for non-aligned grains and one for aligned grains, combined using a linear alignment fraction between 0 and 1. The builtin version of the tables further assumes that only grains with sizes larger than 0.1 micron align with the magnetic field, and that the spheroidal grains have shapes distributed according to a CDE2 shape distribution (this is the fiducial model presented in Vandenbroucke, Baes & Camps, 2020).
If this fiducial model is not sufficient, users can provide their own custom tables in SKIRT stored table format, e.g. generated using CosTuuM. There are two options: either the user computes the tables for a specific alignment fraction and provides a single table, or the user provides separate tables for perfectly aligned and non-aligned grains. In the latter case, SKIRT will use the alignment fraction to appropriately interpolate between the two tables, as in the builtin case.
The choice between the 3 different scenarios (builtin tables with interpolation, a single custom table without interpolation or two custom tables with interpolation) is configured through an enum.
This item type is displayed only if the Boolean expression "Spheroidal" evaluates to true after replacing the names by true or false depending on their presence.
|
strong |
Builtin : "builtin resources" .
OneTable : "single custom table" .
TwoTables : "two custom tables with interpolation" .
|
inlineprotected |
Default constructor for concrete Item subclass SpheroidalSilicateGrainComposition : "a spheroidal silicate dust grain composition with support for polarization" .
|
inline |
This function returns the value of the discoverable string property alignedEmissionTable : "the name of the file tabulating properties for polarized emission by perfectly aligned spheroidal grains" .
This property is relevant only if the Boolean expression "tableTypeTwoTables" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable double property alignmentFraction : "the alignment fraction of the spheroidal grains with the local magnetic field" .
The default value for this property is given by the conditional value expression "1." .
The minimum value for this property is "0." .
The maximum value for this property is "1." .
This property is relevant only if the Boolean expression "tableTypeBuiltin|tableTypeTwoTables" evaluates to true after replacing the names by true or false depending on their presence.
|
inline |
This function returns the value of the discoverable string property emissionTable : "the name of the file tabulating properties for polarized emission by " "arbitrarily aligned spheroidal grains" .
This property is relevant only if the Boolean expression "tableTypeOneTable" evaluates to true after replacing the names by true or false depending on their presence.
|
overridevirtual |
This function returns a brief human-readable identifier for this grain composition.
Reimplemented from PolarizedSilicateGrainComposition.
|
inline |
This function returns the value of the discoverable string property nonAlignedEmissionTable : "the name of the file tabulating properties for polarized emission by non-aligned spheroidal grains" .
This property is relevant only if the Boolean expression "tableTypeTwoTables" evaluates to true after replacing the names by true or false depending on their presence.
|
overridevirtual |
This function returns information on the resources required for implementing thermal emission from aligned spheriodal grains. For more information, see GrainComposition::resourcesForSpheroidalEmission.
Reimplemented from GrainComposition.
|
inline |
This function returns the value of the discoverable TableType enumeration property tableType : "the type of emission tables to use" .
The default value for this property is given by the conditional value expression "Builtin" .