Gyoto
|
Like a Star that would be on all points of its orbit at all time. More...
#include <GyotoStarTrace.h>
Public Types | |
typedef Gyoto::SmartPointer< Gyoto::SmartPointee > | Subcontractor_t(Gyoto::FactoryMessenger *) |
A subcontractor builds an object upon order from the Factory. More... | |
Public Member Functions | |
virtual Property const * | getProperties () const |
Get list of properties. More... | |
StarTrace (SmartPointer< Metric::Generic > gg, double radius, double pos[4], double v[3]) | |
Standard constructor. More... | |
StarTrace () | |
Default constructor. More... | |
StarTrace (const StarTrace &orig) | |
Copy constructor. | |
StarTrace (const Star &o, double tmin, double tmax) | |
Build StarTrace from Star. | |
virtual StarTrace * | clone () const |
Cloner. More... | |
virtual | ~StarTrace () |
Destructor. | |
void | xAllocate (size_t) |
Allocate x0, x1 etc. with a specified size. More... | |
void | xAllocateXYZ () |
Allocate x_, y_, z_. | |
size_t | xExpand (int) |
Expand x0, x1 etc... to hold more elements. More... | |
void | computeXYZ (size_t i) |
Compute (and cache) x_, y_ and z_ for one date. | |
void | computeXYZ () |
Compute (and cache) x_, y_ and z_. | |
virtual void | setInitCoord (const double coord[8], int dir=0) |
Set Initial coordinate. | |
virtual void | metric (SmartPointer< Metric::Generic > gg) |
Set the Metric gg_. | |
virtual void | xStore (size_t ind, double coord[8]) |
Store coord at index ind. | |
virtual std::string | className () const |
"StarTrace" | |
virtual std::string | className_l () const |
"startrace" | |
double | TMin () const |
Get tmin_. | |
void | TMin (double) |
Set tmin_. | |
double | TMax () const |
Get tmax_. | |
void | TMax (double) |
Set tmax_. | |
virtual void | setInitialCondition (double coord[8]) |
Same as Worldline::setInitialCondition(gg, coord, sys,1) | |
virtual double | operator() (double const coord[4]) |
Square distance to the center of the sphere. More... | |
virtual SmartPointer< Metric::Generic > | metric () const |
Get the Metric gg_. | |
virtual double | getMass () const |
Return 1. 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... | |
void | setInitialCondition (SmartPointer< Metric::Generic > gg, const double coord[8], const int dir) |
Set or re-set the initial condition prior to integration. 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... | |
virtual void | setParameters (FactoryMessenger *fmp) |
Main loop in Subcontractor_t function. More... | |
virtual void | setParameters (Gyoto::FactoryMessenger *fmp) |
Main loop for parsing Properties from XML description. More... | |
virtual void | fillProperty (Gyoto::FactoryMessenger *fmp, Property const &p) const |
Output a single Property to XML. More... | |
virtual void | getCartesian (double const *const dates, size_t const n_dates, double *const x, double *const y, double *const z, double *const xprime=NULL, double *const yprime=NULL, double *const zprime=NULL) |
Get the 6 Cartesian coordinates for specific dates. More... | |
virtual void | getVelocity (double const pos[4], double vel[4]) |
Yield velocity of the center of the sphere. | |
virtual void | spectrum (SmartPointer< Spectrum::Generic >) |
Set spectrum_. | |
virtual SmartPointer< Spectrum::Generic > | spectrum () const |
Get spectrum_. | |
virtual void | opacity (SmartPointer< Spectrum::Generic >) |
Set opacity_. | |
virtual SmartPointer< Spectrum::Generic > | opacity () const |
Get opacity_. | |
double | radius () const |
Get radius_ in geometrical units. | |
virtual void | radius (double) |
Set radius_ in geometrical units. | |
double | radius (std::string const &) const |
Get radius_ in specified unit. | |
virtual void | radius (double, std::string const &) |
Set radius_ in specified unit. | |
double | deltaMaxOverRadius () const |
Get dltmor_. | |
virtual void | deltaMaxOverRadius (double f) |
Set dltmor_. | |
double | deltaMaxOverDistance () const |
Get dltmod_. | |
virtual void | deltaMaxOverDistance (double f) |
Set dltmod_. | |
bool | isotropic () const |
void | isotropic (bool) |
double | alpha () const |
void | alpha (double) |
virtual double | operator() (double const data[])=0 |
The actual function. | |
virtual double | deltaMax (double *coord) |
virtual double | deltaMax (double coord[8]) |
Get max step constraint for adaptive integration. More... | |
double | deltaMax () const |
Get delta_max_. | |
virtual double | deltaMax (double const pos[8], double delta_max_external) const |
void | deltaMax (double h1) |
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 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... | |
virtual double | transmission (double nuem, double dsem, double coord[8]) const |
Transmission: exp( αν * dsem ) More... | |
virtual void | safetyValue (double val) |
Set Standard::safety_value_. | |
virtual double | safetyValue () const |
Get Standard::safety_value_. | |
virtual int | Impact (Gyoto::Photon *ph, size_t index, Astrobj::Properties *data=NULL) |
Does a photon at these coordinates impact the object? More... | |
virtual double | giveDelta (double coord[8]) |
Maximum δ inside object. More... | |
const std::string | kind () const |
Get the kind of the Astrobj (e.g. "Star") | |
void | opticallyThin (bool flag) |
Set whether the object is optically thin. More... | |
bool | opticallyThin () const |
Query whether object is optically thin. More... | |
void | radiativeQ (bool flag) |
bool | radiativeQ () const |
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 |
void | redshift (bool flag) |
bool | redshift () const |
virtual Gyoto::Quantity_t | getDefaultQuantities () |
Which quantities to compute if know was requested. More... | |
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. | |
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... | |
size_t | getImin () const |
Get imin_. | |
size_t | getImax () const |
Get imax_. | |
size_t | getI0 () const |
Get i0_. | |
void | initCoord (std::vector< double > const &) |
std::vector< double > | initCoord () const |
virtual void | setInitCoord (double pos[4], double vel[3], int dir=1) |
Set initial coordinate. More... | |
virtual void | setPosition (double pos[4]) |
Set initial 4-position. | |
virtual void | setVelocity (double vel[3]) |
Set initial 3-velocity. | |
void | reset () |
Forget integration, keeping initial contition. | |
void | reInit () |
Reset and recompute particle properties. | |
void | integrator (std::string const &type) |
Set the integrator. More... | |
std::string | integrator () const |
Describe the integrator used by state_. | |
double | deltaMin () const |
Get delta_min_. | |
void | deltaMin (double h1) |
Set delta_min_. | |
void | absTol (double) |
Set abstol_. | |
double | absTol () const |
Get abstol_. | |
void | relTol (double) |
Set reltol_. | |
double | relTol () const |
Get reltol_. | |
double | deltaMaxOverR () const |
Get delta_max_over_r_. | |
void | deltaMaxOverR (double t) |
Set delta_max_over_r_. | |
void | delta (const double delta) |
Assignment to another Worldline. More... | |
void | delta (double, const std::string &unit) |
Set delta_ in specified units. | |
double | delta () const |
Get delta_. | |
double | delta (const std::string &unit) const |
Get delta_ in specified units. | |
double | tMin () const |
Get tmin_. | |
double | tMin (const std::string &unit) const |
Get tmin_ in specified unit. | |
void | tMin (double tlim) |
Set tmin_. | |
void | tMin (double, const std::string &unit) |
Set tmin_ in specified unit. | |
void | adaptive (bool mode) |
Set adaptive_. | |
bool | adaptive () const |
Get adaptive_. | |
void | secondary (bool sec) |
Set secondary_. | |
bool | secondary () const |
Get secondary_. | |
void | maxiter (size_t miter) |
Set maxiter_. | |
size_t | maxiter () const |
Get maxiter_. | |
double const * | getCst () const |
Returns the worldline's cst of motion (if any) More... | |
void | setCst (double const *cst, size_t const ncsts) |
Set Metric-specific constants of motion. More... | |
void | getInitialCoord (double dest[8]) const |
Get initial coordinate. | |
void | getCoord (size_t index, double dest[8]) const |
Get coordinates corresponding to index. | |
void | getCoord (double const *const dates, size_t const n_dates, double *const x1dest, double *const x2dest, double *const x3dest, double *const x0dot=NULL, double *const x1dot=NULL, double *const x2dot=NULL, double *const x3dot=NULL) |
Get 8-coordinates for specific dates. More... | |
void | getCoord (double *x0, double *x1, double *x2, double *x3) const |
Get all computed positions. More... | |
void | getCartesianPos (size_t index, double dest[4]) const |
Get Cartesian expression of 4-position at index. | |
virtual void | xFill (double tlim) |
Fill x0, x1... by integrating the Worldline from previously set inittial condition to time tlim. | |
size_t | get_nelements () const |
Get number of computed dates. | |
void | get_t (double *dest) const |
Get computed dates. | |
void | get_xyz (double *x, double *y, double *z) const |
Get 3-position in cartesian coordinates for computed dates. | |
void | checkPhiTheta (double coord[8]) const |
Bring θ in [0,Π] and φ in [0,2Π]. More... | |
void | getSkyPos (SmartPointer< Screen > screen, double *dalpha, double *ddellta, double *dD) const |
Get computed positions in sky coordinates. | |
void | get_dot (double *x0dot, double *x1dot, double *x2dot, double *x3dot) const |
Get computed 4-velocities. | |
void | get_prime (double *x1prime, double *x2prime, double *x3prime) const |
Get computed 3-velocities. | |
void | save_txyz (char *fichierxyz) const |
Save in a file. | |
void | save_txyz (char *const filename, double const t1, double const mass_sun, double const distance_kpc, std::string const unit, SmartPointer< Screen > sc=NULL) |
Save, converted. | |
Public Attributes | |
GYOTO_WORLDLINE | |
int | stopcond |
Whether and why integration is finished. | |
Static Public Attributes | |
static GYOTO_OBJECT Property const | properties [] |
Protected Member Functions | |
virtual double | emission (double nu_em, double dsem, double cp[8], double co[8]=NULL) const |
Emission is determined by spectrum_ and opacity_. | |
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 double | transmission (double nuem, double dsem, double *) const |
Transmission is determined by opacity_. | |
void | processHitQuantities (Photon *ph, double *coord_ph_hit, double *coord_obj_hit, double dt, Properties *data) const |
Fills Astrobj::Properties. More... | |
virtual void | xAllocate () |
Allocate x0, x1 etc. with default size. More... | |
virtual void | xExpand (double *&x, int dir) |
Expand one array to hold more elements. More... | |
virtual void | tell (Gyoto::Hook::Teller *) |
This is how a Teller tells. More... | |
Protected Attributes | |
double | tmin_ |
Minimum date to consider on the underlying Star orbit. | |
double | tmax_ |
Maximum date to consider on the underlying Star orbit. | |
double * | x_ |
Cartesian x. | |
double * | y_ |
Cartesian y. | |
double * | z_ |
Cartesian z. | |
double | radius_ |
sphere radius [geometrical units] | |
bool | isotropic_ |
if 1, then emission just returns 1 | |
double | alpha_ |
index Gamma is: alpha_ = 2-Gamma More... | |
SmartPointer< Spectrum::Generic > | spectrum_ |
sphere emission law | |
SmartPointer< Spectrum::Generic > | opacity_ |
if optically thin, opacity law | |
double | dltmor_ |
see deltaMax(double*) | |
double | dltmod_ |
see deltaMax(double*) | |
double | critical_value_ |
See operator()(double const coord[4]) | |
double | safety_value_ |
See operator()(double const coord[4]) | |
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... | |
bool | flag_radtransf_ |
1 if radiative transfer inside Astrobj, else 0 | |
int | radiativeq_ |
1 to use the new radiativeQ function (under dvp) | |
int | noredshift_ |
1 to impose redshift factor g = 1 | |
std::string | kind_ |
The "kind" that is output in the XML entity. More... | |
SmartPointer< Gyoto::Metric::Generic > | metric_ |
The Gyoto::Metric in this part of the universe. | |
double * | x0_ |
t or T | |
double * | x1_ |
r or x | |
double * | x2_ |
θ or y | |
double * | x3_ |
φ or z | |
double * | x0dot_ |
tdot or Tdot | |
double * | x1dot_ |
rdot or xdot | |
double * | x2dot_ |
θdot or ydot | |
double * | x3dot_ |
φdot or zdot | |
size_t | x_size_ |
Size of x0_, x1_... arrays. | |
size_t | imin_ |
Minimum index for which x0_, x1_... have been computed. | |
size_t | i0_ |
Index of initial condition in array. | |
size_t | imax_ |
Maximum index for which x0_, x1_... have been computed. | |
bool | adaptive_ |
Whether integration should use adaptive delta. | |
bool | secondary_ |
Experimental: choose 0 to compute only primary image. More... | |
double | delta_ |
Initial integrating step. More... | |
double * | cst_ |
Worldline's csts of motion (if any) | |
size_t | cst_n_ |
Number of constants of motion. | |
int | wait_pos_ |
Hack in setParameters() | |
double * | init_vel_ |
Hack in setParameters() | |
size_t | maxiter_ |
Maximum number of iterations when integrating. | |
double | delta_min_ |
Minimum integration step for the adaptive integrator. More... | |
double | delta_max_ |
Maximum integration step for the adaptive integrator. More... | |
double | delta_max_over_r_ |
Numerical tuning parameter. More... | |
double | abstol_ |
Absolute tolerance of the integrator. More... | |
double | reltol_ |
Absolute tolerance of the integrator. More... | |
SmartPointer< Worldline::IntegState::Generic > | state_ |
An object to hold the integration state. | |
Friends | |
class | Gyoto::SmartPointer< Gyoto::Astrobj::StarTrace > |
Like a Star that would be on all points of its orbit at all time.
StarTrace inherits all the members and methods from Star. It has two additional members, tmin_ and tmax_, which specify the time interval of the Star's orbit that is to be considerred illuminated.
A StarTrace is not (necessarily) continuous: the Star is considerred to be present at all the locations computed by xFill(), meaning that if the integration step is large compared to radius_, the object will be a collection of discrete blobs. To ensure continuity, one should use a non-adaptive step and specify a reasonable step. Computation is also faster in optically thick mode.
|
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().
Gyoto::Astrobj::StarTrace::StarTrace | ( | SmartPointer< Metric::Generic > | gg, |
double | radius, | ||
double | pos[4], | ||
double | v[3] | ||
) |
Standard constructor.
Create Star object and set initial condition.
gg | Gyoto::SmartPointer to the Gyoto::Metric in this part of the Universe |
radius | star radius |
pos | initial 4-position |
v | initial 3-velocity |
Gyoto::Astrobj::StarTrace::StarTrace | ( | ) |
Default constructor.
Create Star object with undefined initial conditions. One needs to set the coordinate system, the metric, and the initial position and velocity before integrating the orbit. setInititialCondition() can be used for that.
|
inherited |
Bring θ in [0,Π] and φ in [0,2Π].
checkPhiTheta() Modifies coord if the corrdinates are spherical-like so that coord[2]=theta is in [0,pi] and coord[3]=phi is in [0,2pi]. Important to use in all astrobj in spherical coordinates to prevent "z-axis problems".
|
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:
Reimplemented from Gyoto::Astrobj::Star.
|
inherited |
|
virtualinherited |
|
virtualinherited |
Get max step constraint for adaptive integration.
[in] | coord | position |
Reimplemented in Gyoto::Astrobj::Complex.
|
virtualinherited |
Get delta max at a given position
[in] | pos | 4-position |
[in] | delta_max_external | external constraint on delta_max |
|
inherited |
Set delta_max_
|
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.
|
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.
|
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 |
Get the 6 Cartesian coordinates for specific dates.
This method is present in both the API of UniformSphere and Worldline. It is pure virtual in UniformSphere. The Star reimplementation is a trivial wrapper around Worldline::getCartesian().
Implements Gyoto::Astrobj::UniformSphere.
|
inherited |
Get 8-coordinates for specific dates.
The coordinates will be computed using the integrator, so they will be as accurate as possible. Some heuristics are used to speed up the process and it is presumably faster to call this routine with a sorted list of dates. The line will be integrated further as required. An error will be thrown if it is not possible to reach a certain date.
dates | the list of dates for which the coordinates are to be computed; |
n_dates | the number of dates to compute ; |
x1dest,x2dest,x3dest,x0dot,x1dot,x2dot,x3dot | arrays in which to store the result. These pointer may be set to NULL to retrieve only part of the information. They must be pre-allocated. |
|
inherited |
Get all computed positions.
Get all the pre-computed 8 coordinates (e.g. thanks to a prior call to xFill()) of this worldline.
|
inherited |
Returns the worldline's cst of motion (if any)
Return pointer to array holding the previously set Metric-specific constants of motion
|
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.
|
virtualinherited |
Return 1.
The mass of a Star is always 1. Stars do not perturb the metric. The only relevant point is that Stars are massive particules, their exact mass is of no importance.
Implements Gyoto::Worldline.
|
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::Star.
|
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 |
|
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).
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.
Reimplemented in Gyoto::Astrobj::PolishDoughnut.
|
protectedvirtualinherited |
∫ν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 from Gyoto::Astrobj::Generic.
|
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 the integrator.
Initialize state_ to use the required integrator.
[in] | type | Either "Legacy" or (if GYOTO_HAVE_BOOST_INTEGRATORS) one of "runge_kutta_cash_karp54", "runge_kutta_fehlberg78", "runge_kutta_dopri5", "runge_kutta_cash_karp54_classic" |
|
virtual |
Square distance to the center of the sphere.
Ensure integration does not miss the object
Reimplemented from Gyoto::Astrobj::UniformSphere.
|
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.
|
protectedvirtualinherited |
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 from Gyoto::Astrobj::Generic.
|
inherited |
|
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 from Gyoto::Astrobj::Generic.
|
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 Metric-specific constants of motion.
The will (re)allocate Worldline::cst_, copy cst into it, and set Worldline::cst_n_.
|
virtualinherited |
Set initial coordinate.
pos | initial 4-position |
vel | initial 3-velocity |
dir | direction of integration |
|
inherited |
Set or re-set the initial condition prior to integration.
gg | Gyoto::SmartPointer to the Gyoto::Metric in this universe; |
coord | 8 element array containing the initial condition, i.e. the 4-position and the 4-velocity of the Photon at the receiving end; |
dir | direction: 1 for future, -1 for past. |
|
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) |
content | string representation of the value |
unit | string representation of the unit |
Reimplemented from Gyoto::Object.
|
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 |
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::Astrobj::Generic.
|
virtualinherited |
Main loop for parsing Properties from XML description.
This function queries the FactoryMessenger for elements to parse, and tries to matche each element to a Property to set it accordingly.
Any class that tries to be buildable from XML must supply a subcontractor (for base classes such as Metric, Astrobj, Spectrum and Spectrometer, it is done as a template that must be specialized for each class).
This subcontractor typically looks somewhat like this:
Although this is discouraged, it is possible to override the following functions to customize how XML entities are parsed: - setParameters() if low-level access to the FactoryMessenger is required; - setParameter(std::string name, std::string content, std::string unit) to interpret an entity that does not match a Property (e.g. alternative name); - setParameter(Gyoto::Property const &p, std::string const &name, std::string const &content, std::string const &unit) to change how a Property is interpreted.
|
protectedvirtualinherited |
This is how a Teller tells.
A teller will basically call listener->tell(this).
msg | Teller* the Teller who is telling... Useful if the Listener listens to several Tellers. |
Reimplemented from Gyoto::Hook::Listener.
|
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 in Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Torus, and Gyoto::Astrobj::DynamicalDisk3D.
|
virtual |
Allocate x0, x1 etc. with a specified size.
size | : number of cells in each array x0, x1 etc. |
Reimplemented from Gyoto::Worldline.
|
protectedvirtualinherited |
Allocate x0, x1 etc. with default size.
The default size is GYOTO_DEFAULT_X_SIZE
|
virtual |
Expand x0, x1 etc... to hold more elements.
Double the size of arrays x0, x1 etc. and copy old version of the array in the first half if dir =1 and in the second half if dir =-1.
dir | : 1 to expand after last element, -1 to expand before first element |
Reimplemented from Gyoto::Worldline.
|
protectedvirtualinherited |
Expand one array to hold more elements.
If you need to expand more arrays than x0_ ... x3_ and the dots, call this on your array before calling xExpand(int dir).
[in,out] | x | array to expand |
[in] | dir |
|
protectedinherited |
Absolute tolerance of the integrator.
Used by the adaptive integrators implemented in IntegState::Boost. Refer to the boost::numeric::odeint documentation for more details.
|
protectedinherited |
index Gamma is: alpha_ = 2-Gamma
such that nu*I_nu = nu^alpha_; note that Xray photon
|
protectedinherited |
Initial integrating step.
Default: GYOTO_DEFAULT_DELTA
|
protectedinherited |
Maximum integration step for the adaptive integrator.
The default (GYOTO_DEFAULT_DELTA_MAX) is usually fine.
For IntegState::Legacy, set it in the Metric instead!
|
protectedinherited |
Numerical tuning parameter.
For IntegState::Legacy, set it in the Metric instead!
Ensure that delta (the numerical integration step) is never larger than a fraction of the distance between the current location and the center of the coordinate system.
The default (GYOTO_DEFAULT_DELTA_MAX_OVER_R) is usually fine.
|
protectedinherited |
Minimum integration step for the adaptive integrator.
The default (GYOTO_DEFAULT_DELTA_MIN) is usually fine.
For IntegState::Legacy, set it in the Metric instead!
|
protectedinherited |
The "kind" that is output in the XML entity.
E.g. for an Astrobj, fillElement() will ensure
is written.
|
protectedinherited |
Absolute tolerance of the integrator.
Used by the adaptive integrators implemented in IntegState::Boost. Refer to the boost::numeric::odeint documentation for more details.
|
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.
|
protectedinherited |
Experimental: choose 0 to compute only primary image.
This feature is in development.