Gyoto
|
Geometrically thick optically thin disk read from a set of FITS files. More...
#include <GyotoDynamicalDisk3D.h>
Public Member Functions | |
DynamicalDisk3D () | |
Standard constructor. | |
DynamicalDisk3D (const DynamicalDisk3D &) | |
Copy constructor. | |
virtual DynamicalDisk3D * | clone () const |
Cloner. | |
virtual | ~DynamicalDisk3D () |
Destructor. | |
void | metric (SmartPointer< Metric::Generic > gg) |
Set the Metric gg_. | |
virtual int | setParameter (std::string name, std::string content, std::string unit) |
Set parameter by name. More... | |
double | emission1date (double nu_em, double dsem, double c_ph[8], double c_obj[8]) const |
Compute emission at one grid date. | |
virtual double | emission (double nu_em, double dsem, double c_ph[8], double c_obj[8]) const |
Interpolate emission between grid dates. | |
double | transmission1date (double nu_em, double dsem, double c_ph[8], double c_obj[8]) const |
Compute transmission at one grid date. | |
double | transmission (double nu_em, double dsem, double c_obj[8]) const |
Interpolate transmission between grid dates. | |
void | getVelocity (double const pos[4], double vel[4]) |
Get fluid 4-velocity at point. More... | |
double const * | getVelocity () const |
Get Disk3D::velocity_. | |
virtual void | fillElement (FactoryMessenger *fmp) const |
Fill XML section. More... | |
void | setEmissquant (double *pattern) |
Set Disk3D::emissquant_. More... | |
void | opacity (double *pattern) |
virtual double const * | opacity () const |
Get Disk3D::opacity_. | |
void | setVelocity (double *pattern) |
Set Disk3D::velocity__. More... | |
virtual void | copyEmissquant (double const *const pattern=NULL, size_t const naxes[4]=NULL) |
Set Disk3D::emissquant_. More... | |
virtual double const * | getEmissquant () const |
Get Disk3D::emissquant_. | |
virtual void | getEmissquantNaxes (size_t naxes[4]) const |
Get { Disk3D::nnu_, Disk3D::nphi_, Disk3D::nz_, Disk3D::nr_ }. | |
virtual void | copyOpacity (double const *const pattern=NULL, size_t const naxes[4]=NULL) |
virtual void | copyVelocity (double const *const pattern=NULL, size_t const naxes[3]=NULL) |
Set Disk3D::velocity_. More... | |
virtual void | repeatPhi (size_t n) |
Set Disk3D::repeat_phi_. | |
virtual size_t | repeatPhi () const |
Get Disk3D::repeat_phi_. | |
virtual void | nu0 (double freq) |
Set Disk3D::nu0_. | |
virtual double | nu0 () const |
Get Disk3D::nu0_. | |
virtual void | dnu (double dfreq) |
Set Disk3D::dnu_. | |
virtual double | dnu () const |
Get Disk3D::dnu_. | |
void | rin (double rrin) |
Set Disk3D::rin_. | |
double | rin () const |
Get Disk3D::rin_. | |
void | rout (double rout) |
Set Disk3D::rout_. | |
double | rout () const |
Get Disk3D::rout_. | |
void | zmin (double zmin) |
Set Disk3D::zmin_. | |
double | zmin () const |
Get Disk3D::zmin_. | |
void | zmax (double zmax) |
Set Disk3D::zmax_. | |
double | zmax () const |
Get Disk3D::zmax_. | |
void | phimin (double phimin) |
Set Disk3D::phimin_. | |
double | phimin () const |
Get Disk3D::phimin_. | |
void | phimax (double phimax) |
Set Disk3D::phimax_. | |
double | phimax () const |
Get Disk3D::phimax_. | |
int | Impact (Photon *ph, size_t index, Astrobj::Properties *data) |
Does a photon at these coordinates impact the object? More... | |
virtual SmartPointer < Metric::Generic > | metric () const |
Get the Metric gg_. | |
virtual double | rMax () |
Get maximal distance from center of coordinate system. More... | |
virtual double | rMax (std::string unit) |
Get rmax_ is specified unit. More... | |
virtual void | rMax (double val) |
Set maximal distance from center of coordinate system. More... | |
virtual void | rMax (double val, std::string unit) |
Set maximal distance from center of coordinate system. More... | |
virtual double | deltaMax (double coord[8]) |
Get max step constraint for adaptive integration. More... | |
const std::string | kind () const |
Get the kind of the Astrobj (e.g. "Star") | |
virtual void | unsetRmax () |
Set rmax_set_ to 0. More... | |
void | opticallyThin (int flag) |
Set whether the object is optically thin. More... | |
int | opticallyThin () const |
Query whether object is optically thin. More... | |
virtual Quantity_t | getDefaultQuantities () |
Which quantities to compute if know was requested. More... | |
virtual void | setParameters (FactoryMessenger *fmp) |
Main loop in Subcontractor_t function. More... | |
virtual void | processHitQuantities (Photon *ph, double *coord_ph_hit, double *coord_obj_hit, double dt, Astrobj::Properties *data) const |
Fills Astrobj::Properties. More... | |
virtual void | emission (double Inu[], double nu_em[], size_t nbnu, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const |
Specific intensity Iν for several values of νem More... | |
virtual double | integrateEmission (double nu1, double nu2, double dsem, double c_ph[8], double c_obj[8]=NULL) const |
∫ν1ν2 Iν dν (or jν) More... | |
virtual void | integrateEmission (double *I, double const *boundaries, size_t const *chaninds, size_t nbnu, double dsem, double *cph, double *co) const |
∫ν1ν2 Iν dν (or jν) More... | |
Protected Types | |
typedef Gyoto::SmartPointer < Gyoto::SmartPointee > | Subcontractor_t (Gyoto::FactoryMessenger *) |
A subcontractor builds an object upon order from the Factory. More... | |
Protected Member Functions | |
void | copyQuantities (int iq) |
Set underlying Disk3D pointers to a specific date slice. More... | |
void | getIndices (size_t i[4], double const co[4], double nu=0.) const |
Get emissquant_ cell corresponding to position co[4]. | |
void | incRefCount () |
Increment the reference counter. Warning: Don't mess with the counter. | |
int | decRefCount () |
Decrement the reference counter and return current value. Warning: Don't mess with the counter. | |
int | getRefCount () |
Get the current number of references. | |
Protected Attributes | |
SmartPointer< Spectrum::BlackBody > | spectrumBB_ |
emission law More... | |
SmartPointer < Gyoto::Metric::Generic > | gg_ |
The Metric in this end of the Universe. | |
double | rmax_ |
Maximum distance to the center of the coordinate system [geometrical units]. More... | |
int | rmax_set_ |
Never recompute rmax: it was externally set. More... | |
std::string | kind_ |
Kind of object (e.g. "Star"...) More... | |
int | flag_radtransf_ |
1 if radiative transfer inside Astrobj, else 0 | |
Private Attributes | |
int | temperature_ |
1 if temperature is given in fits data file, 0 if emission coef is directly given | |
char * | dirname_ |
FITS files directory. | |
double | tinit_ |
Time of the first FITS file. | |
double | dt_ |
Time increment between two FITS (assumed constant) | |
int | nb_times_ |
Number of times. | |
double | PLindex_ |
power law index such that density_elec(E) ∝ E-p | |
int | novel_ |
put to 1 if velocity of emitting particle is not provided | |
double ** | emission_array_ |
double ** | absorption_array_ |
double ** | velocity_array_ |
velocity(r, z, phi) More... | |
Friends | |
class | Gyoto::SmartPointer< Gyoto::Astrobj::DynamicalDisk3D > |
Geometrically thick optically thin disk read from a set of FITS files.
This class describes a PatternDiskBB that evolves dynamically. It is described by a set of FITS files for different times. Its emission is blackbody.
The disk is assumed to be described by a regular, constant in time, grid.
The metric must be Kerr in BL coordinates.
|
inherited |
A subcontractor builds an object upon order from the Factory.
Various classes need to provide a subcontractor to be able to instanciate themselves upon order from the Factory. A subcontractor is a function (often a static member function) which accepts a pointer to a FactoryMessenger as unique parameter, communicates with the Factory using this messenger to read an XML description of the object to build, and returns this objet. SmartPointee::Subcontractor_t* is just generic enough a typedef to cast to and from other subcontractor types: Astrobj::Subcontractor_t, Metric::Subcontractor_t, Spectrum::Subcontractor_t. A subcontractor needs to be registered using the relevant Register() function: Astrobj::Register(), Metric::Register(), Spectrum::Register().
|
virtualinherited |
Set Disk3D::emissquant_.
Disk3D::emissquant_ is freed if not NULL, reallocated, and pattern is copied into emission_.
If Disk3D::velocity_ or has been set previously with mismatching sizes, it is deallocated too.
Finally, Disk3D::nnu_, Disk3D::nphi_, Disk3D::nz_ and Disk3D::nr_ are set according to naxes.
pattern | Array to copy as emission_. May be NULL in which case emission_ is simply deallocated and set to NULL. |
naxes | { nnu_, nphi_, nz_, nr_ }. |
|
protected |
Set underlying Disk3D pointers to a specific date slice.
iq | Index of the date slice. |
|
virtualinherited |
Set Disk3D::velocity_.
Disk3D::velocity_ is first freed if not NULL and set to NULL.
If pattern is not NULL, Disk3D::emissquant_ must have been set previously with matching dimensions. Disk3D::velocity_ is then reallocated, and pattern is copied into velocity_.
pattern | Array to copy as velocity_. May be NULL in which case velocity_ is simply deallocated and set to NULL. |
naxes | { nphi_, nz_, nr_ }. |
|
virtualinherited |
Get max step constraint for adaptive integration.
[in] | coord | position |
Reimplemented in Gyoto::Astrobj::Complex.
|
virtualinherited |
Specific intensity Iν for several values of νem
Called by the default implementation for processHitQuantities().
emission() computes the intensity Iν emitted by the small volume of length dsem. It should take self-absorption along dsem into account.
Same as emission(double nu_em, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const looping on several values of nu_em.
Inu[nbnu] | Output (must be set to a previously allocated array of doubles) |
nu_em[nbnu] | Frequencies at emission |
nbnu | Size of Inu[] and nu_em[] |
dsem | Length over which to integrate inside the object |
coord_ph | Photon coordinate |
coord_obj | Emitter coordinate at current photon position |
Reimplemented in Gyoto::Astrobj::PolishDoughnut.
|
virtual |
Fill XML section.
Astrobj implementations should impement fillElement to save their parameters to XML and call the generic implementation to save generic parts such as Flag_radtrans: Generic::fillElement(fmp).
Reimplemented from Gyoto::Astrobj::Generic.
|
virtualinherited |
Which quantities to compute if know was requested.
Return a Gyoto::Quantity_t suitable as input to Gyoto::Scenery::setRequestedQuantities() to set de default quantities to compute for this object. The default of these defaults GYOTO_QUANTITY_INTENSITY.
Reimplemented in Gyoto::Astrobj::PageThorneDisk.
|
virtual |
Get fluid 4-velocity at point.
Fill vel with the 4-vector velocity of the fluid at 4-position pos.
[in] | pos | 4-position at which to compute velocity; |
[out] | vel | 4-velocity at pos. |
Reimplemented from Gyoto::Astrobj::Disk3D.
|
virtualinherited |
Does a photon at these coordinates impact the object?
Impact() checks whether a Photon impacts the object between two integration steps of the photon's trajectory (those two steps are photon->getCoord(index, coord1) and photon->getCoord(index+1, coord2)). Impact returns 1 if the photon impacts the object between these two steps, else 0. In many cases of geometrically thick obects, the implementation Astrobj::Standard::Impact() will be fine.
Impact will call Generic::processHitQuantities() (which is virtual and may be re-implemented) to compute observable properties on demand: if the data pointer is non-NULL, the object will look in it for pointers to properties which apply to its kind. If a pointer to a property known to this object is present, then the property is computed and store at the pointed-to adress. For instance, all objects know the "intensity" property. If data->intensity != NULL, the instensity is computed and stored in *data->intensity.
If data is non-NULL and only in this case, processHitQuantities() will also call ph->transmit() to update the transmissions of the Photon (see Photon::transmit(size_t, double)). This must not be done if data is NULL (see Astrobj::Complex::Impact() for an explanation).
ph | Gyoto::Photon aimed at the object; |
index | Index of the last photon step; |
data | Pointer to a structure to hold the observables at impact. |
Implements Gyoto::Astrobj::Generic.
|
virtualinherited |
∫ν1ν2 Iν dν (or jν)
Compute the integral of emission() from ν1 to ν2. The default implementation is a numerical integrator which works well enough and is reasonably fast if emission() is a smooth function (i.e. no emission or absorption lines). If possible, it is wise to implement an analytical solution. It is used by processHitQuantities to compute the "BinSpectrum" quantity which is the most physical: it is the only quantity that can be actually measured directly by a real-life instrument.
Reimplemented in Gyoto::Astrobj::UniformSphere, and Gyoto::Astrobj::Torus.
|
virtualinherited |
∫ν1ν2 Iν dν (or jν)
Like double integrateEmission(double nu1, double nu2, double dsem, double c_ph[8], double c_obj[8]) const for each Spectrometer channel.
|
inherited |
Set whether the object is optically thin.
Set flag indicating that radiative transfer should be integrated, i.e. the object is to be considered optically thin.
flag | 1 if optically thin, 0 if optically thick. |
|
inherited |
Query whether object is optically thin.
|
virtualinherited |
Fills Astrobj::Properties.
processHitQuantities fills the requested data in Impact. To use it, you need to call it in the Impact() method for your object in case of hit. It will fill Redshift, Intensity, Spectrum, BinSpectrum and update the Photon's transmission by calling Photon::transmit(), only if data==NULL.
You can overload it for your Astrobj. The generic implementation calls emission(), integrateEmission() and transmission() below.
Reimplemented in Gyoto::Astrobj::UniformSphere, and Gyoto::Astrobj::PageThorneDisk.
|
virtualinherited |
Get maximal distance from center of coordinate system.
Get maximal distance from center of coordinate system at which a Photon may hit the object.
Child classes may use the rmax_ member to cache this value.
It can also be set using rmax(). If rmax has been used to set rmax_, rMax() must not recompute it.
Reimplemented in Gyoto::Astrobj::Star, and Gyoto::Astrobj::Torus.
|
virtualinherited |
Get rmax_ is specified unit.
Call rMax() and convert result to unit.
unit | string |
|
virtualinherited |
|
virtualinherited |
Set maximal distance from center of coordinate system.
Call Generic::rMax(double val) after converting val from unit to geometrical units.
val | rmax_ expressed in unit "unit"; |
unit | string... |
|
inherited |
Set Disk3D::emissquant_.
The pointer is copied directly, not the array content.
This is a low-level function. Beware that:
|
virtual |
Set parameter by name.
Assume MyKind is a subclass of Astrobj::Generic which has two members (a string StringMember and a double DoubleMember):
If MyKind is not a direct subclass of Generic but is a subclass of e.g. Standard, UniformSphere of ThinDisk, it should call the corresponding setParameter() implementation instead of Generic::setParameter().
name | XML name of the parameter |
content | string representation of the value |
unit | string representation of the unit |
Reimplemented from Gyoto::Astrobj::Disk3D.
|
virtualinherited |
Main loop in Subcontractor_t function.
The Subcontractor_t function for each Astrobj kind should look somewhat like this (templated as Gyoto::Astrobj::Subcontractor<MyKind>):
Each object kind should implement setParameter(string name, string content, string unit) to interpret the individual XML elements. setParameters() can be overloaded in case the specific Astrobj class needs low level access to the FactoryMessenger. See UniformSphere::setParameters().
Reimplemented in Gyoto::Astrobj::UniformSphere, Gyoto::Astrobj::Star, Gyoto::Astrobj::Torus, and Gyoto::Astrobj::Complex.
|
inherited |
Set Disk3D::velocity__.
The pointer is copied directly, not the array content.
This is a low-level function. Beware that:
|
virtualinherited |
Set rmax_set_ to 0.
rmax() will then be free to recompute rmax_. Astrobjs which cache rmax_ may need to update it when unrmax() is called.
Reimplemented in Gyoto::Astrobj::Star.
|
private |
An array of arrays of dimensionality double[nr_][nz_][nphi_][nnu_]. In FITS format, the first dimension is nu, the second phi, the third z, the last r. It contains absorption coef, or a closely related quantity.
|
private |
An array of arrays of dimensionality double[nr_][nz_][nphi_][nnu_]. In FITS format, the first dimension is nu, the second phi, the third z, the last r. It contains emission coef, or a closely related quantity.
|
protectedinherited |
Kind of object (e.g. "Star"...)
The kind should match the name of the class, e.g. "Star" for a Gyoto::Star.
|
protectedinherited |
Maximum distance to the center of the coordinate system [geometrical units].
Maximum distance from the center of the coordinate system at which a photon may hit the object. Child classes may choose to update rMax at all time or to use it to cache the value, for instance when rMax() is called. External classes (Photons in particular) must use rMax() to access this information.
rmax_set_==1 means that rmax_ was set using rMax() or the constructor. In this case, rMax() must always return this value, not recompute it.
rmax_ is in geometrical units.
|
protectedinherited |
Never recompute rmax: it was externally set.
rmax_set_==1 means that rmax_ was set using rMax(double r) or the constructor. In this case, rMax() must always return this value, not recompute it.
Use unsetRmax() to reset rmax_set_ to 0.
|
protected |
emission law
disk black body
|
private |
velocity(r, z, phi)
An array of arrays of dimensionality double[nr_][nz_][nphi_][3]. In FITS format, the second dimension is phi, and the third r. The first plane in the first FITS dimention is dphi/dt, the second dz/dt, the third dr/dt.