 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <SphericalCellSource.hpp>
Public Types | |
| enum class | AutoRevolveType : int { None , Inclination , Azimuth , InclinationAndAzimuth } |
Public Member Functions | |
| AutoRevolveType | autoRevolve () const |
| int | numAzimuthRevolveBins () const |
| int | numInclinationRevolveBins () const |
 Public Member Functions inherited from ImportedSource | |
| int | dimension () const override |
| string | filename () const |
| bool | hasVelocity () const override |
| bool | importBias () const |
| bool | importCurrentMass () const |
| bool | importVelocity () const |
| bool | importVelocityDispersion () const |
| void | launch (PhotonPacket *pp, size_t historyIndex, double L) const override |
| double | luminosity () const override |
| double | meanSpecificLuminosity (const Band *band, int m) const |
| double | meanSpecificLuminosity (Range wavelengthRange, int m) const |
| void | prepareForLaunch (double sourceBias, size_t firstIndex, size_t numIndices) override |
| SEDFamily * | sedFamily () const |
| const Snapshot * | snapshot () const |
| double | specificLuminosity (double wavelength) const override |
| double | specificLuminosity (double wavelength, int m) const |
| string | useColumns () const |
| Range | wavelengthRange () const override |
| Public Member Functions inherited from Source | |
| virtual int | dimension () const =0 |
| virtual bool | hasVelocity () const =0 |
| virtual void | launch (PhotonPacket *pp, size_t historyIndex, double L) const =0 |
| virtual double | luminosity () const =0 |
| virtual void | prepareForLaunch (double sourceBias, size_t firstIndex, size_t numIndices) |
| double | sourceWeight () const |
| virtual double | specificLuminosity (double wavelength) const =0 |
| double | wavelengthBias () const |
| WavelengthDistribution * | wavelengthBiasDistribution () 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 WavelengthRangeInterface | |
| virtual | ~WavelengthRangeInterface () |
| virtual Range | wavelengthRange () const =0 |
Protected Member Functions | |
| SphericalCellSource () | |
| Snapshot * | createAndOpenSnapshot () override |
| Protected Member Functions inherited from ImportedSource | |
| ImportedSource () | |
| ~ImportedSource () | |
| virtual Snapshot * | createAndOpenSnapshot ()=0 |
| void | setupSelfAfter () override |
| Protected Member Functions inherited from Source | |
| Source () | |
| void | informAvailableWavelengthRange (Range available, string itemType) |
| Random * | random () const |
| void | setupSelfBefore () override |
| 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 () | |
| Protected Member Functions inherited from SourceWavelengthRangeInterface | |
| SourceWavelengthRangeInterface () | |
| Protected Member Functions inherited from WavelengthRangeInterface | |
| WavelengthRangeInterface () | |
Private Types | |
| using | BaseType = ImportedSource |
| using | ItemType = SphericalCellSource |
Private Attributes | |
| AutoRevolveType | _autoRevolve |
| int | _numAzimuthRevolveBins |
| int | _numInclinationRevolveBins |
Friends | |
| class | ItemRegistry |
A SphericalCellSource instance represents a primary radiation source with a spatial and spectral luminosity distribution described by a list of spherical cells lined up with the spherical coordinate axes; refer to the SphericalCellSnapshot 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 SphericalCellSource instance, including the selected SEDFamily:
\[ r_\mathrm{min}\,(\mathrm{pc}) \quad \theta_\mathrm{min}\,(\mathrm{deg}) \quad \varphi_\mathrm{min}\,(\mathrm{deg}) \quad r_\mathrm{max}\,(\mathrm{pc}) \quad \theta_\mathrm{max}\,(\mathrm{deg}) \quad \varphi_\mathrm{max}\,(\mathrm{deg}) \quad [ v_x\,(\mathrm{km/s}) \quad v_y\,(\mathrm{km/s}) \quad v_z\,(\mathrm{km/s}) \quad [ \sigma_v\,(\mathrm{km/s}) ] \quad [M_\mathrm{curr}\,(\mathrm{M}_\odot)] \quad b\,(1) \quad \dots \text{SED family parameters} \dots \]
The first six columns specify the coordinates of the bordering surfaces of the cell. The autoRevolve property controls a feature to automatically revolve 2D data to 3D. See the SphericalCellSnapshot class for more information.
If the importVelocity option is enabled, the next three columns specify the \(v_r\), \(v_\theta\), \(v_\varphi\) components of the bulk velocity, in spherical coordinates, for the source population represented by the cell. If additionally the importVelocityDispersion option is enabled, the next column specifies the velocity dispersion \(\sigma_v\), adjusting the velocity for each photon packet launch with a random offset sampled from a spherically symmetric Gaussian distribution. If the importCurrentMass option is enabled, the next column provides the current mass of the cell, \(M_\mathrm{curr}\). This mass is currently only used for probing the input model. If the importBias option is enabled, the next column specifies the bias parameter, \(b\), which is used to bias the photon sampling for each cell (see the documentation of the ImportedSource class).
The remaining columns specify the parameters required by the configured SED family to select and scale the appropriate SED. For example for the Bruzual-Charlot SED family, the remaining columns provide the initial mass, the metallicity, and the age of the stellar population represented by the cell. Refer to the documentation of the configured type of SEDFamily for information about the expected parameters and their default units.
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 for selecting the auto-revolve option.
None : "no auto-revolve" .
Inclination : "auto-revolve inclination" .
Azimuth : "auto-revolve azimuth" .
InclinationAndAzimuth : "auto-revolve both inclination and azimuth" .
|
inlineprotected |
Default constructor for concrete Item subclass SphericalCellSource : "a primary source imported from spherical cell data" .
|
inline |
This function returns the value of the discoverable AutoRevolveType enumeration property autoRevolve : "automatically revolve 1D or 2D data to a 3D model" .
The default value for this property is given by the conditional value expression "None" .
|
overrideprotectedvirtual |
This function constructs a new SphericalCellSource object, calls its open() function, and returns a pointer to the object. Ownership of the Snapshot object is transferred to the caller.
Implements ImportedSource.
|
inline |
This function returns the value of the discoverable integer property numAzimuthRevolveBins : "the number of azimuth bins for auto-revolving 1D or 2D data" .
This property is relevant only if the Boolean expression "autoRevolveAzimuth|autoRevolveInclinationAndAzimuth" 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" .
|
inline |
This function returns the value of the discoverable integer property numInclinationRevolveBins : "the number of inclination bins for auto-revolving 1D or 2D data" .
This property is relevant only if the Boolean expression "autoRevolveInclination|autoRevolveInclinationAndAzimuth" 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" .