Gyoto
|
Geometrically thin disk read from a set of FITS files. More...
#include <GyotoDynamicalDisk.h>
Public Types | |
typedef Gyoto::SmartPointer< Gyoto::SmartPointee > | Subcontractor_t(Gyoto::FactoryMessenger *, std::vector< std::string > const &) |
A subcontractor builds an object upon order from the Factory. More... | |
Public Member Functions | |
virtual Property const * | getProperties () const |
Get list of properties. More... | |
DynamicalDisk () | |
Standard constructor. | |
DynamicalDisk (const DynamicalDisk &) | |
Copy constructor. | |
virtual DynamicalDisk * | clone () const |
Cloner. More... | |
virtual | ~DynamicalDisk () |
Destructor. | |
std::string | file () const |
void | file (std::string const &fname) |
void | tinit (double t) |
double | tinit () const |
void | dt (double t) |
double | dt () const |
virtual double | emission (double nu_em, double dsem, state_t const &c_ph, double const c_obj[8]=NULL) const |
Specific intensity Iν More... | |
void | getVelocity (double const pos[4], double vel[4]) |
Get fluid 4-velocity at point. More... | |
double const * | getVelocity () const |
Get PatternDisk::velocity_. More... | |
double | emission (double nu_em, double dsem, state_t const &c_ph, double const c_obj[8]=NULL) const |
Specific intensity Iν More... | |
bool | spectralEmission () const |
void | spectralEmission (bool t) |
virtual double | emission (double nu_em, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const =delete |
Obsolete, update your code;. | |
virtual void | emission (double Inu[], double const nu_em[], size_t nbnu, double dsem, state_t const &coord_ph, double const coord_obj[8]=NULL) const |
Specific intensity Iν for several values of νem More... | |
virtual void | emission (double Inu[], double nu_em[], size_t nbnu, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const =delete |
Obsolete, update your code. | |
void | fillProperty (Gyoto::FactoryMessenger *fmp, Property const &p) const |
Output a single Property to XML. More... | |
virtual void | innerRadius (double) |
Set rin_. More... | |
virtual double | innerRadius () const |
Get rin_. More... | |
virtual double | innerRadius (std::string const &) const |
Get rin_. More... | |
virtual void | innerRadius (double) |
Set rin_. More... | |
virtual void | innerRadius (double, std::string const &) |
Set rin_. More... | |
virtual void | outerRadius (double) |
Set rout_. More... | |
virtual double | outerRadius () const |
Get rout_. More... | |
virtual double | outerRadius (std::string const &) const |
Get rout_. More... | |
virtual void | outerRadius (double) |
Set rout_. More... | |
virtual void | outerRadius (double, std::string const &) |
Set rout_. More... | |
virtual void | patternVelocity (double) |
Set PatternDisk::Omega_. More... | |
virtual double | patternVelocity () const |
Get PatternDisk::Omega_. | |
void | setEmission (double *pattern) |
Set PatternDisk::emission_. More... | |
void | setVelocity (double *pattern) |
Set PatternDisk::velocity__. More... | |
void | radius (double *pattern) |
Set PatternDisk::radius_. More... | |
virtual void | copyIntensity (double const *const pattern=NULL, size_t const naxes[3]=NULL) |
Set PatternDisk::emission_. More... | |
virtual double const * | getIntensity () const |
Get PatternDisk::emission_. | |
virtual void | getIntensityNaxes (size_t naxes[3]) const |
Get PatternDisk::nnu_, PatternDisk::nphi_, and PatternDisk::nr_. | |
virtual void | copyOpacity (double const *const pattern=NULL, size_t const naxes[3]=NULL) |
Set PatternDisk::opacity_. More... | |
virtual double const * | opacity () const |
Get PatternDisk::opacity_. | |
virtual void | copyVelocity (double const *const pattern=NULL, size_t const naxes[2]=NULL) |
Set PatternDisk::velocity_. More... | |
virtual void | copyGridRadius (double const *const pattern=NULL, size_t nr=0) |
Set PatternDisk::radius_. More... | |
virtual double const * | getGridRadius () const |
Get PatternDisk::radius_. | |
virtual void | repeatPhi (size_t n) |
Set PatternDisk::repeat_phi_. | |
virtual size_t | repeatPhi () const |
Get PatternDisk::repeat_phi_. | |
virtual void | nu0 (double freq) |
Set PatternDisk::nu0_. | |
virtual double | nu0 () const |
Get PatternDisk::nu0_. | |
virtual void | dnu (double dfreq) |
Set PatternDisk::dnu_. | |
virtual double | dnu () const |
Get PatternDisk::dnu_. | |
void | phimin (double phimin) |
Set PatternDisk::phimin_. | |
double | phimin () const |
Get PatternDisk::phimin_. | |
void | phimax (double phimax) |
Set PatternDisk::phimax_. | |
double | phimax () const |
Get PatternDisk::phimax_. | |
virtual double | transmission (double nu_em, double dsem, state_t const &, double const coord[8]) const |
Transmission: exp( αν * dsem ) More... | |
virtual double | transmission (double nuem, double dsem, state_t const &coord) const =delete |
Obsolete, update your code. | |
virtual double | transmission (double nuem, double dsem, double coord[8]) const =delete |
Obsolete, update your code. | |
virtual double | thickness () const |
Get thickness_. | |
virtual double | thickness (std::string const &) const |
Get thickness_. | |
virtual void | thickness (double) |
Set thickness_. | |
virtual void | thickness (double, std::string const &) |
Set thickness_. | |
virtual int | dir () const |
Get dir_. | |
virtual void | dir (int) |
Set dir_. | |
virtual bool | corotating () const |
virtual void | corotating (bool t) |
Get dir_==1. | |
virtual std::string | velocityKind () const |
Set dir_=t?1:-1. More... | |
virtual void | velocityKind (std::string const &) |
Set VelocityKind. | |
virtual double | operator() (double const coord[]) |
theta-pi/2 or z More... | |
virtual double | projectedRadius (double const coord[]) const |
Projected radius of position coord on the equatorial plane. | |
virtual double | sphericalPhi (double const coord[]) const |
Longitude. | |
virtual int | Impact (Gyoto::Photon *ph, size_t index, Astrobj::Properties *data=NULL) |
Does a photon at these coordinates impact the object? More... | |
virtual SmartPointer< Metric::Generic > | metric () const |
Get the Metric gg_. More... | |
virtual void | metric (SmartPointer< Metric::Generic >) |
Set the Metric gg_. More... | |
virtual double | rMax () |
Get maximal distance from center of coordinate system. More... | |
virtual double | rMax () const |
Get maximal distance from center of coordinate system. | |
virtual double | rMax (std::string const &unit) |
Get rmax_ is specified unit. More... | |
virtual double | rMax (std::string const &unit) const |
Get rmax_ is specified unit. | |
virtual void | rMax (double val) |
Set maximal distance from center of coordinate system. More... | |
virtual void | rMax (double val, std::string const &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") | |
GYOTO_OBJECT_ACCESSORS_UNIT (deltaMaxInsideRMax) | |
void | opticallyThin (bool flag) |
Set whether the object is optically thin. More... | |
bool | opticallyThin () const |
Query whether object is optically thin. More... | |
void | showshadow (bool flag) |
bool | showshadow () const |
void | redshift (bool flag) |
bool | redshift () const |
virtual Gyoto::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, state_t const &coord_ph_hit, double const *coord_obj_hit, double dt, Astrobj::Properties *data) const |
Fills Astrobj::Properties. More... | |
virtual void | processHitQuantities (Photon *ph, double *coord_ph_hit, double *coord_obj_hit, double dt, Astrobj::Properties *data) const =delete |
virtual void | radiativeQ (double Inu[], double Taunu[], double const nu_em[], size_t nbnu, double dsem, state_t const &coord_ph, double const coord_obj[8]=NULL) const |
emission and transmission together More... | |
virtual void | radiativeQ (double Inu[], double Taunu[], double nu_em[], size_t nbnu, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const =delete |
virtual void | radiativeQ (double *Inu, double *Qnu, double *Unu, double *Vnu, double *alphaInu, double *alphaQnu, double *alphaUnu, double *alphaVnu, double *rQnu, double *rUnu, double *rVnu, double const *nuem, size_t nbnu, double dsem, state_t const &cph, double const *co) const |
virtual double | integrateEmission (double nu1, double nu2, double dsem, state_t const &c_ph, double const c_obj[8]=NULL) const |
∫ν1ν2 Iν dν (or jν) More... | |
virtual double | integrateEmission (double nu1, double nu2, double dsem, double c_ph[8], double c_obj[8]=NULL) const =delete |
Obsolete, update your code. | |
virtual void | integrateEmission (double *I, double const *boundaries, size_t const *chaninds, size_t nbnu, double dsem, state_t const &cph, double const *co) 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 =delete |
Obsolete, update your code. | |
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. | |
virtual bool | isThreadSafe () const |
Whether this class is thread-safe. More... | |
void | set (Property const &p, Value val) |
Set Value of a Property. | |
void | set (Property const &p, Value val, std::string const &unit) |
Set Value (expressed in unit) of a Property. | |
void | set (std::string const &pname, Value val) |
Set Value of a Property. | |
void | set (std::string const &pname, Value val, std::string const &unit) |
Set Value (expressed in unit) of a Property. | |
Value | get (Property const &p) const |
Get Value of a Property. | |
Value | get (std::string const &pname) const |
Get Value of a Property. | |
Value | get (Property const &p, std::string const &unit) const |
Get Value of a Property, converted to unit. | |
Value | get (std::string const &pname, std::string const &unit) const |
Get Value of a Property, converted to unit. | |
Property const * | property (std::string const pname) const |
Find property by name. More... | |
virtual void | fillElement (Gyoto::FactoryMessenger *fmp) const |
Fill the XML element for this Object. More... | |
virtual int | setParameter (std::string name, std::string content, std::string unit) |
Set parameter by name. More... | |
virtual void | setParameter (Gyoto::Property const &p, std::string const &name, std::string const &content, std::string const &unit) |
Set parameter by Property (and name) More... | |
std::string | describeProperty (Gyoto::Property const &p) const |
Format desrciption for a property. More... | |
void | help () const |
Print (to stdout) some help on this class. More... | |
Public Attributes | |
GYOTO_OBJECT_THREAD_SAFETY | |
Static Public Attributes | |
static GYOTO_OBJECT Property const | properties [] |
Protected Member Functions | |
void | copyQuantities (int iq) |
Set underlying PatternDisk pointers to a specific date slice. More... | |
void | nullifyQuantities () |
void | getIndices (size_t i[3], double const co[4], double nu=0.) const |
Get emission_ cell corresponding to position co[4]. | |
Protected Attributes | |
SmartPointer< Spectrum::BlackBody > | spectrumBB_ |
emission law More... | |
double | rin_ |
disk inner radius in geometrical units | |
double | rout_ |
disk outer radius in geometrical units | |
double | thickness_ |
disk thickness More... | |
int | dir_ |
1 for corotating (default), -1 for counterrotating. | |
unsigned int | velocitykind_ |
tag for VelocityKind | |
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... | |
double | deltamaxinsidermax_ |
Maximum Photon integration step inside rmax_ [geometrical units]. More... | |
bool | flag_radtransf_ |
1 if radiative transfer inside Astrobj, else 0 | |
int | shadow_ |
1 to highlight the shadow region in the image | |
int | noredshift_ |
1 to impose redshift factor g = 1 | |
std::string | kind_ |
The "kind" that is output in the XML entity. More... | |
std::vector< std::string > | plugins_ |
The plug-ins that needs to be loaded to access this instance's class. More... | |
Private Attributes | |
char * | dirname_ |
FITS files directory. | |
double | tinit_ |
date of the first FITS file | |
double | dt_ |
Time increment between two FITS (assumed constant) | |
int | nb_times_ |
Number of dates. | |
int | nnu_ |
int | nphi_ |
int | nr_ |
Grid dimensions (assumed constant) | |
double ** | emission_array_ |
Array of PatternDisk::emission_ arrays. | |
double ** | velocity_array_ |
Array of PatternDisk::velocity_ arrays. | |
double ** | radius_array_ |
Array of PatternDisk::radius_ arrays. More... | |
int | SpectralEmission_ |
1 if spectral emission. More... | |
std::string | filename_ |
Optional FITS file name containing the arrays. | |
double * | emission_ |
Iν(ν, r, φ) More... | |
double * | opacity_ |
Same dimenstions as emission, or NULL. | |
double * | velocity_ |
velocity(r, φ) More... | |
double * | radius_ |
Radius vector. More... | |
double | Omega_ |
Pattern angular velocity. More... | |
double | t0_ |
Date for which i=0 corresponds to phi=0. More... | |
double | dnu_ |
Frequency scale of PatternDisk::emission_ in Hz. | |
double | nu0_ |
Lowest frequency provided in PatternDisk::emission_ in Hz. | |
double | dphi_ |
δφ between two grid columns | |
double | phimin_ |
Minimum φ in grid. | |
double | phimax_ |
Maximum φ in grid. | |
size_t | repeat_phi_ |
Number of times the pattern should be repeated to cover [0, 2Π]. More... | |
double | dr_ |
Radius step. | |
int | __defaultfeatures |
Whether some virtual methods are implemented. More... | |
int | refCount |
Reference counter. | |
pthread_mutex_t | mutex_ |
A mutex. More... | |
Friends | |
class | Gyoto::SmartPointer< Gyoto::Astrobj::DynamicalDisk > |
Geometrically 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.
|
inherited |
A subcontractor builds an object upon order from the Factory.
Various classes need to provide a subcontractor to be able to instantiate 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().
|
virtual |
Cloner.
Reimplemented from Gyoto::Astrobj::PatternDiskBB.
Reimplemented in Gyoto::Astrobj::DynamicalDiskBolometric.
|
virtualinherited |
Set PatternDisk::radius_.
PatternDisk::radius_ is first freed if not NULL and set to NULL.
If pattern is not NULL, PatternDisk::emission_ must have been set previously with matching dimensions. PatternDisk::radius_ is then reallocated, and pattern is copied into radius_.
pattern | Array to copy as radius_. May be NULL in which case radius_ is simply deallocated and set to NULL. |
nr | size of radius array. |
|
virtualinherited |
PatternDisk::emission_ is freed if not NULL, reallocated, and pattern is copied into emission_.
If PatternDisk::opacity_, PatternDisk::velocity_ or PatternDisk::radius_ have been set previously with mismatching sizes, they are deallocated too.
Finally, PatternDisk::nnu_, PatternDisk::nphi_, and PatternDisk::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_, nr_ }. |
|
virtualinherited |
PatternDisk::opacity_ is first freed if not NULL and set to NULL.
If pattern is not NULL, PatternDisk::emission_ must have been set previously with matching dimensions. PatternDisk::opacity_ is then reallocated, and pattern is copied into opacity_.
pattern | Array to copy as opacity_. May be NULL in which case opacity_ is simply deallocated and set to NULL. |
naxes | { nnu_, nphi_, nr_ }. |
|
protected |
Set underlying PatternDisk pointers to a specific date slice.
iq | Index of the date slice. |
|
virtualinherited |
PatternDisk::velocity_ is first freed if not NULL and set to NULL.
If pattern is not NULL, PatternDisk::emission_ must have been set previously with matching dimensions. PatternDisk::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_, nr_ }. |
|
virtualinherited |
Get max step constraint for adaptive integration.
[in] | coord | position |
Reimplemented in Gyoto::Astrobj::Complex.
|
inherited |
Format desrciption for a property.
Returns a string containing the name(s) and type of the property, as well as whether it supports unit.
|
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::Python::Standard, and Gyoto::Astrobj::Python::ThinDisk.
|
virtual |
Specific intensity Iν
Called by the default implementation for processHitQuantities().
emission() computes the intensity Iν emitted by the small volume of length dsem, in the emitter's frame. It should take self-absorption along dsem into account.
Reminder :
The equation used for radiative transfer (without absorption) is:
d(Iν/ν3)/dλ = (jν/ν2) [*]
where λ is the integration parameter along the null geodesic.
NB: Let us consider a particular observer, with ν being the frequency measured by this observer, and ds being the proper distance (as measured by the observer) that the photon travels as it moves from λ to λ+dλ along its geodesic. Then it can be shown that:
dλ = ds/ν
This shows that Eq. [*] is homogeneous.
The default implementation returns 1. if optically thick and dsem if optically thin. It allows for a quick implementation of your object for visualization purposes.
nu_em | Frequency at emission [Hz] |
dsem | length over which to integrate inside the object [geometrical units] |
coord_ph | Photon coordinate |
coord_obj | Emitter coordinate at current photon position |
Reimplemented from Gyoto::Astrobj::PatternDiskBB.
|
virtual |
Specific intensity Iν
Called by the default implementation for processHitQuantities().
emission() computes the intensity Iν emitted by the small volume of length dsem, in the emitter's frame. It should take self-absorption along dsem into account.
Reminder :
The equation used for radiative transfer (without absorption) is:
d(Iν/ν3)/dλ = (jν/ν2) [*]
where λ is the integration parameter along the null geodesic.
NB: Let us consider a particular observer, with ν being the frequency measured by this observer, and ds being the proper distance (as measured by the observer) that the photon travels as it moves from λ to λ+dλ along its geodesic. Then it can be shown that:
dλ = ds/ν
This shows that Eq. [*] is homogeneous.
The default implementation returns 1. if optically thick and dsem if optically thin. It allows for a quick implementation of your object for visualization purposes.
nu_em | Frequency at emission [Hz] |
dsem | length over which to integrate inside the object [geometrical units] |
coord_ph | Photon coordinate |
coord_obj | Emitter coordinate at current photon position |
Reimplemented from Gyoto::Astrobj::PatternDisk.
Reimplemented in Gyoto::Astrobj::DynamicalDiskBolometric.
|
virtual |
Reimplemented from Gyoto::Astrobj::PatternDisk.
|
virtual |
Reimplemented from Gyoto::Astrobj::PatternDisk.
|
virtualinherited |
Fill the XML element for this Object.
The base implementation simply calls fillProperty() for each Property defined for the Object.
Derived classes should avoid overriding fillElement(). It may make sense occasionally, e.g. to make sure that the metric is output first.
To customize how a given Property is rendered, it is better to override fillProperty().
If this method is overridden, the implementation should in general call fillElement() on the direct base.
Reimplemented in Gyoto::Astrobj::Complex, Gyoto::Spectrometer::Complex, and Gyoto::Scenery.
|
virtualinherited |
Output a single Property to XML.
The base implementation decides what to do based on the p.type. The format matches how setParameters() an setParameter() would interpret the XML descition.
Overriding this method should be avoided, but makes sense in some cases (for instance Screen::fillProperty() selects a different unit for Distance based on its magnitude, so that stellar sizes are expressed in solar radii while smaller sizes can be expressed in meters and larger sizes in parsecs).
Overriding implementation should fall-back on calling the implementation in the direct parent class:
Reimplemented from Gyoto::Object.
|
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 list of properties.
This method is declared automatically by the GYOTO_OBJECT macro and defined automatically by the GYOTO_PROPERTY_END macro.
Reimplemented from Gyoto::Astrobj::PatternDiskBB.
Reimplemented in Gyoto::Astrobj::DynamicalDiskBolometric.
|
virtual |
Reimplemented from Gyoto::Astrobj::PatternDisk.
|
virtual |
Get fluid 4-velocity at point.
Fill vel with the 4-vector velocity of the fluid at 4-position pos. getVelocity() should work at some distance from the equatorial plane. The default implementation calls Metric::Generic::circularVelocity().
[in] | pos | 4-position at which to compute velocity; |
[out] | vel | 4-velocity at pos. |
Reimplemented from Gyoto::Astrobj::PatternDisk.
|
inherited |
Print (to stdout) some help on this class.
Describe all properties that this instance supports.
|
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 address. 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).
Impact() may not extend the ph Worldline. The only two dates that are guaranteed to be defined are at indices index and index+1.
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 |
Get rin_.
Reimplemented from Gyoto::Astrobj::ThinDisk.
|
virtualinherited |
Set rin_.
Reimplemented from Gyoto::Astrobj::ThinDisk.
|
virtualinherited |
Set rin_.
Reimplemented from Gyoto::Astrobj::ThinDisk.
|
virtualinherited |
Set rin_.
Reimplemented from Gyoto::Astrobj::ThinDisk.
|
virtualinherited |
Get rin_.
Reimplemented from Gyoto::Astrobj::ThinDisk.
|
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.
Reimplemented in Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Python::Standard, and Gyoto::Astrobj::Python::ThinDisk.
|
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::Torus, Gyoto::Astrobj::Python::Standard, and Gyoto::Astrobj::Python::ThinDisk.
|
virtualinherited |
Whether this class is thread-safe.
Return True if this object is thread-safe, i.e. if an instance and its clone can be used in parallel threads (in the context of Scenery::raytrace()). Known objects which are not thread-safe include Lorene metrics and everything from the Python plug-in.
The default implementation considers that the class itself is thread safe and recurses into the declared properties to check whether they are safe too. Classes that abide to the Object/Property paradigm and are themselves thread-safe have nothing special to do.
Objects that clone children in their copy constructor that are not declared as properties must take these children into account.
Classes that are never thread-safe must declare it. It acn be easily done using GYOTO_OBJECT_THREAD_SAFETY in the class declaration and GYOTO_PROPERTY_THREAD_UNSAFE in the class definition.
|
virtualinherited |
Reimplemented in Gyoto::Astrobj::Complex, Gyoto::Astrobj::DeformedTorus, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::FlaredDiskSynchrotron, Gyoto::Astrobj::Jet, Gyoto::Astrobj::NeutronStar, Gyoto::Astrobj::OscilTorus, Gyoto::Astrobj::Star, Gyoto::Astrobj::StarTrace, Gyoto::Astrobj::ThickDisk, and Gyoto::Astrobj::XillverReflection.
|
virtualinherited |
Reimplemented in Gyoto::Astrobj::DeformedTorus, Gyoto::Astrobj::OscilTorus, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Complex, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::StarTrace, Gyoto::Astrobj::NeutronStar, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::Complex, Gyoto::Astrobj::DeformedTorus, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::FlaredDiskSynchrotron, Gyoto::Astrobj::Jet, Gyoto::Astrobj::Jet, Gyoto::Astrobj::OscilTorus, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::Star, Gyoto::Astrobj::StarTrace, Gyoto::Astrobj::ThickDisk, Gyoto::Astrobj::ThickDisk, Gyoto::Astrobj::XillverReflection, and Gyoto::Astrobj::XillverReflection.
|
virtualinherited |
theta-pi/2 or z
A function which changes sign on the equatorial plane.
Implements Gyoto::Functor::Double_constDoubleArray.
|
inherited |
Query whether object is optically thin.
|
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. |
|
virtualinherited |
Get rout_.
Reimplemented from Gyoto::Astrobj::ThinDisk.
|
virtualinherited |
Set rout_.
Reimplemented from Gyoto::Astrobj::ThinDisk.
|
virtualinherited |
Set rout_.
Reimplemented from Gyoto::Astrobj::ThinDisk.
|
virtualinherited |
Set rout_.
Reimplemented from Gyoto::Astrobj::ThinDisk.
|
virtualinherited |
Get rout_.
Reimplemented from Gyoto::Astrobj::ThinDisk.
|
virtualinherited |
Set PatternDisk::Omega_.
Unit: radians per geometrical unit time.
|
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::PageThorneDisk, and Gyoto::Astrobj::DynamicalDiskBolometric.
|
inherited |
|
virtualinherited |
emission and transmission together
Reimplemented in Gyoto::Astrobj::Blob, Gyoto::Astrobj::Jet, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::ThickDisk, Gyoto::Astrobj::Torus, and Gyoto::Astrobj::FlaredDiskSynchrotron.
|
inherited |
Set PatternDisk::radius_.
The pointer is copied directly, not the array content.
This is a low-level function. Beware that:
|
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, if its current value is DBL_MAX.
It can also be set using rMax().
Reimplemented in Gyoto::Astrobj::Complex, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::Star, and Gyoto::Astrobj::Torus.
|
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... |
|
virtualinherited |
Get rmax_ is specified unit.
Call rMax() and convert result to unit.
unit | string |
|
inherited |
The pointer is copied directly, not the array content.
This is a low-level function. Beware that:
|
virtualinherited |
Set parameter by Property (and name)
This function is used when parsing an XML description, if Property (p) of this name is found (i.e. either p.name or p.name_false is equal to name). Implementation should fall-back on calling the direct's parent implementation:
p | Property that matches name (p.name == name or p.name_false == name) |
name | XML name of the parameter (XML entity) |
content | string representation of the value |
unit | string representation of the unit |
Reimplemented in Gyoto::Astrobj::PolishDoughnut.
|
virtualinherited |
Set parameter by name.
This function is used when parsing an XML description, if no Property of this name is found. Overriding implementation should fall-back on calling the direct's parent implementation:
name | XML name of the parameter (XML entity). This may have a path component, e.g. "Astrobj::Radius", in which case a property named "Astrobj" will be sought in the current object, and setParameter will be called recusrively on this Astrobj with Radius as name. |
content | string representation of the value |
unit | string representation of the unit |
Reimplemented in Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Metric::KerrKS, Gyoto::Astrobj::Star, and Gyoto::Metric::RotStar3_1.
|
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 from Gyoto::Object.
Reimplemented in Gyoto::Astrobj::Complex, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::Star, and Gyoto::Astrobj::OscilTorus.
|
inherited |
Set PatternDisk::velocity__.
The pointer is copied directly, not the array content.
This is a low-level function. Beware that:
|
virtualinherited |
Transmission: exp( αν * dsem )
transmission() computes the transmission of this fluid element or 0 if optically thick. The default implementation returns 1. (no attenuation) if optically thin, 0. if optically thick.
nuem | frequency in the fluid's frame |
coord | Photon coordinate |
dsem | geometrical length in geometrical units |
Reimplemented from Gyoto::Astrobj::Generic.
|
virtualinherited |
Set dir_=t?1:-1.
Get VelocityKind
|
privateinherited |
Whether some virtual methods are implemented.
The default implementations of some methods call one-another. This member is used internally to avoid infinite recursion.
|
protectedinherited |
Maximum Photon integration step inside rmax_ [geometrical units].
Maximum step for Photon integation when inside the sphere of radius rmax_.
deltamaxinsidermax_ is in geometrical units.
|
privateinherited |
Iν(ν, r, φ)
An array of dimensionality double[nr_][nphi_][nnu_]. In FITS format, the first dimension is nu, the second phi, and the third r.
|
protectedinherited |
The "kind" that is output in the XML entity.
E.g. for an Astrobj, fillElement() will ensure
is written.
|
privateinherited |
A mutex.
When compiled with libpthread
|
privateinherited |
Pattern angular velocity.
XML element: <Omega>. FITS keyword: HIERARCH GYOTO PatternDisk Omega
|
protectedinherited |
The plug-ins that needs to be loaded to access this instance's class.
E.g. for an Astrobj, fillElement() will ensure
is written.
|
privateinherited |
Radius vector.
In case of adaptive grid.
|
private |
Array of PatternDisk::radius_ arrays.
radius vector
|
privateinherited |
Number of times the pattern should be repeated to cover [0, 2Π].
XML elment: <RepeatPhi>. FITS keyword: HIERARCH GYOTO PatternDisk RepeatPhi
|
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 compute a decent value for rmax_ at any time if rmax_ is DBL_MAX. External classes (Photons in particular) must use rMax() to access this information.
rmax_ is in geometrical units.
|
privateinherited |
1 if spectral emission.
XML: SpectralEmission
|
protectedinherited |
emission law
disk black body
|
privateinherited |
Date for which i=0 corresponds to phi=0.
XML element: <T0>. FITS keyword: HIERARCH GYOTO PatternDisk t0
|
protectedinherited |
disk thickness
Geometrical thickness in geometrical units. Used only in the optically thin regime (flag_radtransf_==1). Should be << rin_. Default: 1e-3.
|
privateinherited |
velocity(r, φ)
An array of dimensionality double[nr_][nphi_][2]. In FITS format, the second dimension is phi, and the third r. The first plane in the first FITS dimention is dφ/dt, the second dr/dt.