Gyoto
|
A toroïdal accretion structure. More...
#include <GyotoPolishDoughnut.h>
Classes | |
class | intersection_t |
double intersection(double) Functor class More... | |
class | transcendental_t |
double transcendental(double) Functor class More... | |
Public Member Functions | |
PolishDoughnut () | |
Default constructor. | |
PolishDoughnut (const PolishDoughnut &) | |
Copy constructor. | |
virtual PolishDoughnut * | clone () const |
Cloner. More... | |
virtual | ~PolishDoughnut () |
Destructor. | |
void | operator= (const PolishDoughnut &) |
Assignment to another PolishDoughnut. | |
double | getL0 () const |
Get PolishDoughnut::l0_. | |
double | getLambda () const |
Get PolishDoughnut::lambda_. | |
void | setLambda (double lambda) |
Set PolishDoughnut::lambda_. | |
double | getTemperatureRatio () const |
Get PolishDoughnut::temperature_ratio_. | |
void | setTemperatureRatio (double temp) |
Set PolishDoughnut::temperature_ratio_. | |
double | getCentralDensity () const |
Get PolishDoughnut::central_density_. | |
double | getCentralDensity (std::string unit) const |
Get PolishDoughnut::central_density_ in specified unit. | |
void | setCentralDensity (double density) |
Set PolishDoughnut::central_density_. | |
void | setCentralDensity (double density, std::string unit) |
Set PolishDoughnut::central_density_ in specified unit. | |
double | getCentralTempOverVirial () const |
Get PolishDoughnut::centraltemp_over_virial_. | |
void | setCentralTempOverVirial (double val) |
Set PolishDoughnut::centraltemp_over_virial_. | |
double | getBeta () const |
Get PolishDoughnut::beta_. | |
void | setBeta (double beta) |
Set PolishDoughnut::beta_. | |
void | setSpectralOversampling (size_t) |
Set PolishDoughnut::spectral_oversampling_. | |
size_t | getSpectralOversampling () const |
Get PolishDoughnut::spectral_oversampling_. | |
double | getWsurface () const |
Get PolishDoughnut::W_surface_. | |
double | getWcentre () const |
Get PolishDoughnut::W_centre_. | |
double | getRcusp () const |
Get PolishDoughnut::r_cusp_. | |
double | getRcentre () const |
Get PolishDoughnut::r_centre_. | |
virtual Gyoto::SmartPointer < Gyoto::Metric::Generic > | getMetric () const |
Get the Metric Generic::gg_. | |
virtual void | setMetric (Gyoto::SmartPointer< Gyoto::Metric::Generic >) |
Set the Metric Generic::gg_. | |
void | useSpecificImpact (int yes=1) |
Set PolishDoughnut::use_specific_impact_. | |
int | Impact (Photon *ph, size_t index, Astrobj::Properties *data) |
Call either PolishDoughnut::Impact() or Standard::Impact() More... | |
int | Impact_ (Photon *ph, size_t index, Astrobj::Properties *data) |
A specific implementation of Generic::Impact() More... | |
virtual double | operator() (double const coord[4]) |
Function defining the object interior. More... | |
virtual int | setParameter (std::string name, std::string content, std::string unit) |
Set parameter by name. More... | |
virtual void | fillElement (FactoryMessenger *fmp) const |
Fill XML section. More... | |
virtual void | setSafetyValue (double val) |
Set Standard::safety_value_. | |
virtual double | getSafetyValue () const |
Get Standard::safety_value_. | |
virtual double | operator() (double const data[])=0 |
The actual function. | |
virtual double | giveDelta (double coord[8]) |
Maximum δ inside object. More... | |
virtual double | getRmax () |
Get maximal distance from center of coordinate system. More... | |
virtual double | getRmax (std::string unit) |
Get rmax_ is specified unit. More... | |
const std::string | getKind () const |
Get the kind of the Astrobj (e.g. "Star") | |
virtual void | setRmax (double val) |
Set maximal distance from center of coordinate system. More... | |
virtual void | setRmax (double val, std::string unit) |
Set maximal distance from center of coordinate system. More... | |
virtual void | unsetRmax () |
Set rmax_set_ to 0. More... | |
void | setFlag_radtransf (int flag) |
Set whether the object is optically thin. More... | |
int | getFlag_radtransf () 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 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... | |
Static Public Member Functions | |
static double | bessi0 (double xx) |
Modified Bessel function I0 | |
static double | bessi1 (double xx) |
Modified Bessel function I1 | |
static double | bessk0 (double xx) |
Modified Bessel function K0 | |
static double | bessk1 (double xx) |
Modified Bessel function K1 | |
static double | bessk (int nn, double xx) |
Modified Bessel function. | |
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 | |
virtual void | tell (Gyoto::Hook::Teller *msg) |
Update PolishDoughnut::aa_. More... | |
virtual void | getVelocity (double const pos[4], double vel[4]) |
Fluid velocity field. More... | |
virtual void | integrateEmission (double *I, double *boundaries, size_t *chaninds, size_t nbnu, double dsem, double *cph, double *co) const |
∫ν1ν2 Iν dν (or jν) More... | |
virtual double | emission (double nu_em, double dsem, double coord_ph[8], double coord_obj[8]) const |
Specific intensity Iν 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... | |
double | emissionBrems (double nu_em, double nu_crit, double numax, double T_electron, double n_e, double n_j, double amplification, double Cbrems, int comptonorder) const |
Bremsstrahlung proxy for emission() | |
double | emissionSynch (double nu_em, double nu_crit, double numax, double nu_0, double T_electron, double amplification, double Csynch, double alpha1, double alpha2, double alpha3, double preff, int comptonorder) const |
Synchrotron proxy for emission() | |
double | transmission (double nuem, double dsem, double coord_ph[8]) const |
Transmission: exp( αν * dsem ) More... | |
double | BBapprox (double nuem, double Te) const |
Approximated Black-Body function. | |
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. | |
Static Protected Member Functions | |
static double | funcxM (double alpha1, double alpha2, double alpha3, double xM) |
Mahadevan 96 fit function. | |
Protected Attributes | |
double | critical_value_ |
See operator()(double const coord[4]) | |
double | safety_value_ |
See operator()(double const coord[4]) | |
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... | |
const std::string | kind_ |
Kind of object (e.g. "Star"...) More... | |
int | flag_radtransf_ |
1 if radiative transfer inside Astrobj, else 0 | |
Private Member Functions | |
double | potential (double r, double theta) const |
Potential defining shape, used by operator()() | |
Private Attributes | |
SmartPointer < Gyoto::Metric::KerrBL > | gg_ |
KerrBL metric. More... | |
double | l0_ |
Angular momentum. Tied to PolishDoughnut::lambda_. | |
double | lambda_ |
Adimentionned angular momentum. | |
double | W_surface_ |
Potential surface value. Tied to PolishDoughnut::lambda_. | |
double | W_centre_ |
Potential central value. Tied to PolishDoughnut::lambda_. | |
double | r_cusp_ |
Cusp radius in geometrical units. Tied to PolishDoughnut::lambda_. | |
double | r_centre_ |
Central radius in geometrical units. Tied to PolishDoughnut::lambda_. | |
double | DeltaWm1_ |
1./(W_centre_ - W_surface_); | |
double | temperature_ratio_ |
Central ion/electron temperature ratio. | |
double | central_density_ |
Central density in kg/L (same as g cm^-3) | |
double | centraltemp_over_virial_ |
Tcenter/Tvirial | |
double | beta_ |
Pmagn/Pgas | |
int | use_specific_impact_ |
Use PolishDoughnut::Impact_() or Standard::Impact() | |
double | aa_ |
PolishDoughnut::gg_ spin, cached when setting PolishDoughnut::lambda_. | |
double | aa2_ |
aa_2 | |
size_t | spectral_oversampling_ |
Oversampling used in integrateEmission() | |
intersection_t | intersection |
double intersection(double) Functor | |
Friends | |
class | Gyoto::SmartPointer< Gyoto::Astrobj::PolishDoughnut > |
std::ostream & | operator<< (std::ostream &, const PolishDoughnut &) |
Display. | |
A toroïdal accretion structure.
Reference: Straub, O.; Vincent, F. H.; Abramowicz, M. A.; Gourgoulhon, E.; & Paumard, T. 2012, Modelling the black hole silhouette in Sagittarius A* with ion tori, A&A 543:83.
|
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().
|
virtual |
Cloner.
This method must be implemented by the various Astrobj::Generic subclasses in order to support cloning:
Cloning is necessary for multi-threading, recommended for interaction with the Yorick plug-in etc.
Implementing it is very straightforward, as long as the copy constructor Generic(const Generic& ) has been implemented:
Implements Gyoto::Astrobj::Generic.
|
protectedvirtual |
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::Generic.
|
protectedvirtual |
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 from Gyoto::Astrobj::Generic.
|
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::Standard.
|
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.
|
inherited |
Query whether object is optically thin.
|
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 setRmax(). If setRmax has been used to set rmax_, getRmax() must not recompute it.
Reimplemented in Gyoto::Astrobj::Star, and Gyoto::Astrobj::Torus.
|
virtualinherited |
Get rmax_ is specified unit.
Call getRmax() and convert result to unit.
unit | string |
|
protectedvirtual |
Fluid velocity field.
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. |
Implements Gyoto::Astrobj::Standard.
|
virtualinherited |
Maximum δ inside object.
Gives the requested integration step δt (in coordinate time t) between two neighbooring points along a portion of geodesic inside an astrobj
coord | input coordinate at which δt is given |
|
virtual |
Call either PolishDoughnut::Impact() or Standard::Impact()
Depending on PolishDoughnut::use_specific_impact_. See useSpecificImpact().
Reimplemented from Gyoto::Astrobj::Standard.
int Gyoto::Astrobj::PolishDoughnut::Impact_ | ( | Photon * | ph, |
size_t | index, | ||
Astrobj::Properties * | data | ||
) |
A specific implementation of Generic::Impact()
This should not be better than Standard::Impact(). Call useSpecificImpact() or Set <UseSpecifictImpact/> in the XML file to use it.
|
protectedvirtual |
∫ν1ν2 Iν dν (or jν)
PolishDought::emission() is slow. Integrating it is very slow. This implementation simply oversamples the spectrum by PolishDoughnut::spectral_oversampling_ and sums the trapezoids.
For general documentation, see Astrobj::Generic::integrateEmission(double * I, double const * boundaries, size_t const * chaninds, size_t nbnu, double dsem, double *cph, double *co) const .
|
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.
|
virtual |
Function defining the object interior.
A potential, distance, or whatever function such that operator()(double const coord[4]) < Standard::critical_value_ if and only if coord is inside the object. This function is used by the default implmenetation of Impact(). If Impact() is overloaded, it is not necessary to overload operator()(double coord[4]). The default implementation throws an error.
Implements Gyoto::Astrobj::Standard.
|
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.
|
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. |
|
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::Standard.
|
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::PatternDisk, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::Star, Gyoto::Astrobj::UniformSphere, Gyoto::Astrobj::Torus, and Gyoto::Astrobj::Complex.
|
virtualinherited |
Set maximal distance from center of coordinate system.
Set maximal distance from center of coordinate system at which a Photon may hit the object.
Side effect: set rmax_set_ to 1.
val | new rmax_ in geometrical units. |
|
virtualinherited |
Set maximal distance from center of coordinate system.
Call Generic::setRmax(double val) after converting val from unit to geometrical units.
val | rmax_ expressed in unit "unit"; |
unit | string... |
|
protectedvirtual |
|
protectedvirtual |
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 rmax_set_ to 0.
getRmax() will then be free to recompute rmax_. Astrobjs which cache rmax_ may need to update it when unsetRmax() is called.
Reimplemented in Gyoto::Astrobj::Star.
|
private |
KerrBL metric.
This Astrobj::Generic subclass only works (so far?) in KerrBL metric. We store a copy of the Astrobj::Generic::gg_ SmartPointer appropriately cast. The two pointers point to the same instance.
|
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 getRmax() is called. External classes (Photons in particular) must use getRmax() to access this information.
rmax_set_==1 means that rmax_ was set using setRmax() or the constructor. In this case, getRmax() 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 setRmax() or the constructor. In this case, getRmax() must always return this value, not recompute it.
Use unsetRmax() to reset rmax_set_ to 0.