 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <CylindricalCellMedium.hpp>
Public Types | |
| enum class | MassType : int { MassDensity , Mass , NumberDensity , Number } |
Public Member Functions | |
| bool | autoRevolve () const |
| MassType | massType () const |
| int | numAutoRevolveBins () const |
| Public Member Functions inherited from ImportedMedium | |
| Vec | bulkVelocity (Position bfr) const override |
| int | dimension () const override |
| string | filename () const |
| Position | generatePosition () const override |
| bool | hasMagneticField () const override |
| bool | hasMetallicity () const override |
| bool | hasParameters () const override |
| bool | hasTemperature () const override |
| bool | hasVariableMix () const override |
| bool | hasVelocity () const override |
| bool | importMagneticField () const |
| bool | importMetallicity () const |
| bool | importTemperature () const |
| bool | importVariableMixParams () const |
| bool | importVelocity () const |
| Vec | magneticField (Position bfr) const override |
| double | mass () const override |
| double | massDensity (Position bfr) const override |
| double | massFraction () const |
| MaterialMix * | materialMix () const |
| MaterialMixFamily * | materialMixFamily () const |
| double | maxTemperature () const |
| double | metallicity (Position bfr) const override |
| const MaterialMix * | mix () const override |
| const MaterialMix * | mix (Position bfr) const override |
| double | number () const override |
| double | numberDensity (Position bfr) const override |
| int | numSites () const override |
| double | opticalDepthX (double lambda) const override |
| double | opticalDepthY (double lambda) const override |
| double | opticalDepthZ (double lambda) const override |
| void | parameters (Position bfr, Array ¶ms) const override |
| Position | sitePosition (int index) const override |
| const Snapshot * | snapshot () const |
| double | temperature (Position bfr) const override |
| string | useColumns () 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 |
| Public Member Functions inherited from SiteListInterface | |
| virtual | ~SiteListInterface () |
Protected Member Functions | |
| CylindricalCellMedium () | |
| Snapshot * | createAndOpenSnapshot () override |
| Protected Member Functions inherited from ImportedMedium | |
| ImportedMedium () | |
| ~ImportedMedium () | |
| void | setupSelfAfter () override |
| Protected Member Functions inherited from Medium | |
| Medium () | |
| Protected Member Functions inherited from SimulationItem | |
| SimulationItem () | |
| virtual bool | offersInterface (const std::type_info &interfaceTypeInfo) const |
| virtual void | setupSelfBefore () |
| Protected Member Functions inherited from Item | |
| Item () | |
| Protected Member Functions inherited from SiteListInterface | |
| SiteListInterface () | |
Private Types | |
| using | BaseType |
| using | ItemType |
Private Attributes | |
| bool | _autoRevolve |
| MassType | _massType |
| int | _numAutoRevolveBins |
Friends | |
| class | ItemRegistry |
A CylindricalCellMedium instance represents a transfer medium with a spatial density distribution (and, optionally, other properties) described by a list of cylindrical cells lined up with the cylindrical coordinate axes; refer to the CylindricalCellSnapshot class for more information. The cell data is usually extracted from a cosmological simulation snapshot, and it must be provided in a column text file formatted as described below.
Refer to the description of the TextInFile class for information on overall formatting and on how to include header lines specifying the units for each column in the input file. In case the input file has no unit specifications, the default units mentioned below are used instead. The number of columns expected in the input file depends on the options configured by the user for this CylindricalCellMedium instance:
\[ R_\mathrm{min}\,(\mathrm{pc}) \quad \varphi_\mathrm{min}\,(\mathrm{deg}) \quad z_\mathrm{min}\,(\mathrm{pc}) \quad R_\mathrm{max}\,(\mathrm{pc}) \quad \varphi_\mathrm{max}\,(\mathrm{deg}) \quad z_\mathrm{max}\,(\mathrm{pc}) \quad \{\, \rho\,(\text{M}_\odot\,\text{pc}^{-3}) \;\;|\;\; M\,(\text{M}_\odot) \;\;|\;\; n\,(\text{cm}^{-3}) \;\;|\;\; N\,(1) \,\} \quad [Z\,(1)] \quad [T\,(\mathrm{K})] \]
\[ [ v_x\,(\mathrm{km/s}) \quad v_y\,(\mathrm{km/s}) \quad v_z\,(\mathrm{km/s}) ] \quad [ B_x\,(\mu\mathrm{G}) \quad B_y\,(\mu\mathrm{G}) \quad B_z\,(\mu\mathrm{G}) ] \quad [ \dots\text{mix family params}\dots ] \]
The first six columns specify the coordinates of the bordering planes and cylinders of the cell. The autoRevolve property controls a feature to automatically revolve 2D data to 3D. See the CylindricalCellSnapshot class for more information.
Depending on the value of the massType option, the seventh column lists the average mass density \(\rho\), the integrated mass \(M\), the average number density \(n\), or the integrated number density \(N\) for the cell.
If the importMetallicity option is enabled, the next column specifies a "metallicity" fraction, which is multiplied with the mass/density column to obtain the actual mass/density of the cell. If the importTemperature option is enabled, the next column specifies a temperature. If this temperature is higher than the maximum configured temperature, the mass and density of the cell are set to zero, regardless of the mass or density specified in the seventh column. If the importTemperature option is disabled, or the maximum temperature value is set to zero, such a cutoff is not applied.
If both the importMetallicity and importTemperature options are enabled, this leads to the following expression for the mass of an imported particle:
\[ M_\mathrm{imported} = \begin{cases} f_\mathrm{mass}\,Z\,M & \mathrm{if}\; T<T_\mathrm{max} \;\mathrm{or}\; T_\mathrm{max}=0 \\ 0 & \mathrm{otherwise} \end{cases} \]
If the importVelocity option is enabled, the subsequent three columns specify the \(v_R\), \(v_\varphi\), \(v_z\) components of the bulk velocity, in cylindrical coordinates, for the material represented by the cell.
If the importMagneticField option is enabled, the subsequent three columns specify the \(B_R\), \(B_\varphi\), \(B_z\) magnetic field vector components for the cell, in cylindrical coordinates.
Finally, if the importVariableMixParams option is enabled, the remaining columns specify the parameters used by the configured material mix family to select a particular material mix for the cell.
This item type is displayed only if the Boolean expression "Level2" evaluates to true after replacing the names by true or false depending on their presence.
|
strong |
The enumeration type indicating the type of mass quantity to be imported.
MassDensity : "mass density".
Mass : "mass (volume-integrated)".
NumberDensity : "number density".
Number : "number (volume-integrated)".
|
inlineprotected |
Default constructor for concrete Item subclass CylindricalCellMedium: "a transfer medium imported from cylindrical cell data".
|
inline |
This function returns the value of the discoverable Boolean property autoRevolve: "automatically revolve 2D data to a 3D model".
The default value for this property is given by the conditional value expression "false".
|
overrideprotectedvirtual |
This function constructs a new CylindricalCellSnapshot object, calls its open() function, configures it to import a mass or density column, and finally returns a pointer to the object. Ownership of the Snapshot object is transferred to the caller.
Implements ImportedMedium.
|
inline |
This function returns the value of the discoverable MassType enumeration property massType: "the type of mass quantity to be imported".
The default value for this property is given by the conditional value expression "MassDensity".
|
inline |
This function returns the value of the discoverable integer property numAutoRevolveBins: "the number of azimuth bins for auto-revolving 2D data".
This property is relevant only if the Boolean expression "autoRevolve" evaluates to true after replacing the names by true or false depending on their presence.
The minimum value for this property is "2".
The maximum value for this property is "1024".
The default value for this property is given by the conditional value expression "16".