Gyoto
|
Base class for metrics. More...
#include <GyotoMetric.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... | |
const std::string | kind () const |
Get kind_. | |
int | getRefCount () |
Generic (const int coordkind, const std::string &name) | |
Constructor setting Generic::coordkind_ and kind_. | |
Generic (Generic const &o) | |
Copy constructor. | |
virtual | ~Generic () |
Destructor. | |
virtual Generic * | clone () const |
Virtual copy constructor. | |
void | mass (const double) |
Set mass used in unitLength() | |
void | mass (const double, const std::string &unit) |
Set mass used in unitLength() | |
int | coordKind () const |
Get coordinate kind. | |
double | mass () const |
Get mass used in unitLength() | |
double | mass (const std::string &unit) const |
Get mass used in unitLength() | |
double | unitLength () const |
M * G / c^2, M is in kg, unitLength in meters. More... | |
double | unitLength (const std::string &unit) const |
unitLength expressed in specified unit | |
virtual double | getRmb () const |
virtual double | getRms () const |
virtual double | getSpecificAngularMomentum (double rr) const |
virtual double | getPotential (double const pos[4], double l_cst) const |
double | deltaMin () const |
void | deltaMin (double h1) |
double | deltaMax () const |
virtual double | deltaMax (double const pos[8], double delta_max_external) const |
void | deltaMax (double h1) |
double | deltaMaxOverR () const |
Get delta_max_over_r_. | |
void | deltaMaxOverR (double t) |
Set delta_max_over_r_. | |
bool | keplerian () const |
Get keplerian_. | |
void | keplerian (bool) |
Set keplerian_. | |
virtual void | cartesianVelocity (double const coord[8], double vel[3]) |
Compute xprime, yprime and zprime from 8-coordinates. | |
virtual double | SysPrimeToTdot (const double coord[4], const double v[3]) const |
Compute tdot as a function of dr/dt, dtheta/dt and dphi/dt. Everything is in geometrical units. More... | |
virtual void | circularVelocity (double const pos[4], double vel[4], double dir=1.) const |
Yield circular velocity at a given position. More... | |
virtual void | nullifyCoord (double coord[8]) const |
Set tdot (coord[4]) such that coord is light-like. Everything is in geometrical units. More... | |
virtual void | nullifyCoord (double coord[8], double &tdot2) const |
Set tdot (coord[4]) such that coord is light-like and return other possible tdot. More... | |
virtual double | ScalarProd (const double pos[4], const double u1[4], const double u2[4]) const |
Scalar product. More... | |
virtual void | observerTetrad (std::string const obskind, double const pos[4], double fourvel[4], double screen1[4], double screen2[4], double screen3[4]) const |
Computes the orthonormal local tetrad of the observer. More... | |
virtual double | gmunu (double const x[4], int mu, int nu) const |
Metric coefficients. More... | |
virtual void | gmunu (double g[4][4], double const pos[4]) const |
Metric coefficients. More... | |
virtual double | christoffel (const double coord[4], const int alpha, const int mu, const int nu) const |
Chistoffel symbol. More... | |
virtual int | christoffel (double dst[4][4][4], const double coord[4]) const |
Chistoffel symbol. More... | |
virtual int | myrk4 (Worldline *line, const double coord[8], double h, double res[8]) const |
RK4 integrator. | |
virtual int | myrk4_adaptive (Gyoto::Worldline *line, const double coord[8], double lastnorm, double normref, double coordnew[8], double h0, double &h1, double deltamax=GYOTO_DEFAULT_DELTA_MAX) const |
RK4 integrator with adaptive step. | |
virtual int | isStopCondition (double const coord[8]) const |
Check whether integration should stop. More... | |
virtual int | diff (const double y[8], double res[8]) const |
F function such as dy/dtau=F(y,cst) | |
virtual void | setParticleProperties (Gyoto::Worldline *line, double const coord[8]) const |
Set Metric-specific constants of motion. Used e.g. in KerrBL. | |
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. | |
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 | fillProperty (Gyoto::FactoryMessenger *fmp, Property const &p) const |
Output a single Property to XML. More... | |
virtual void | fillElement (Gyoto::FactoryMessenger *fmp) const |
Fill the XML element for this Object. More... | |
virtual void | setParameters (Gyoto::FactoryMessenger *fmp) |
Main loop for parsing Properties from XML description. 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... | |
virtual void | hook (Listener *listener) |
Start listening. More... | |
virtual void | unhook (Listener *listener) |
Stop listening. More... | |
Static Public Attributes | |
static GYOTO_OBJECT Property const | properties [] |
Protected Member Functions | |
void | kind (const std::string) |
Set kind_. More... | |
void | coordKind (int coordkind) |
Set coordkind_. More... | |
virtual void | tellListeners () |
Call tell() on each hooked Listener. More... | |
Protected Attributes | |
double | delta_min_ |
Minimum integration step for the adaptive integrator. | |
double | delta_max_ |
Maximum integration step for the adaptive integrator. | |
double | delta_max_over_r_ |
Numerical tuning parameter. More... | |
bool | keplerian_ |
1 if circularVelocity should return the Newtonian Keplerian velocity, in r^-3/2 | |
std::string | kind_ |
The "kind" that is output in the XML entity. More... | |
Private Attributes | |
double | mass_ |
Mass yielding geometrical unit (in kg). | |
int | coordkind_ |
Kind of coordinates (cartesian-like, spherical-like, unspecified) | |
Friends | |
class | Gyoto::SmartPointer< Gyoto::Metric::Generic > |
|
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 |
Chistoffel symbol.
Value of Christoffel symbol Γαμν at point (x1, x2, x3).
Reimplemented in Gyoto::Metric::NumericalMetricLorene, and Gyoto::Metric::Minkowski.
|
virtual |
Chistoffel symbol.
Value of Christoffel symbol Γαμν at point (x1, x2, x3).
Reimplemented in Gyoto::Metric::NumericalMetricLorene, Gyoto::Metric::KerrBL, Gyoto::Metric::KerrKS, and Gyoto::Metric::Minkowski.
|
virtual |
Yield circular velocity at a given position.
Give the velocity of a massive particle in circular orbit at the given position projected onto the equatorial plane. Such a velocity may not exist everywhere (or anywhere) for a given metric. This method is intended to be used by Astrobj classes such as Torus or ThinDisk.
If keplerian_ is set to true, this method should return the Keplerian velcity instead (derived classes should ensure this, see KerrBL::circularVelocity() for instance).
The default implementation throws an error if keplerian_ is set to false.
pos | input: position, |
vel | output: velocity, |
dir | 1 for corotating, -1 for counterrotating. |
Reimplemented in Gyoto::Metric::KerrBL, and Gyoto::Metric::KerrKS.
|
protected |
Set coordkind_.
coordkind(int coordkind) is protected because, for most Metrics, it should not be changed in runtime.Set coordinate kind
double Gyoto::Metric::Generic::deltaMax | ( | ) | const |
Get delta_max_
|
virtual |
Get delta max at a given position
pos | 4-position |
void Gyoto::Metric::Generic::deltaMax | ( | double | h1 | ) |
Set delta_max_
double Gyoto::Metric::Generic::deltaMin | ( | ) | const |
Get delta_min_
void Gyoto::Metric::Generic::deltaMin | ( | double | h1 | ) |
Set delta_min_
|
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 |
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::Scenery, Gyoto::Spectrometer::Complex, and Gyoto::Astrobj::Complex.
|
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 in Gyoto::Screen, Gyoto::Scenery, Gyoto::Astrobj::Star, Gyoto::Spectrometer::Uniform, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PolishDoughnut, and Gyoto::Astrobj::DirectionalDisk.
|
virtual |
Returns potential W=-ln(|u_t|) for a cst specific angular momentum l_cst Should be implemented in derived classes if useful If called on the base class, returns an error
Reimplemented in Gyoto::Metric::NumericalMetricLorene, and Gyoto::Metric::KerrBL.
|
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::Object.
Reimplemented in Gyoto::Metric::Python, Gyoto::Metric::NumericalMetricLorene, Gyoto::Metric::KerrBL, Gyoto::Metric::KerrKS, Gyoto::Metric::RotStar3_1, and Gyoto::Metric::Minkowski.
|
virtual |
Returns the marginally bound radius Should be implemented in derived classes if useful If called on the base class, returns an error
Reimplemented in Gyoto::Metric::NumericalMetricLorene, and Gyoto::Metric::KerrBL.
|
virtual |
Returns the marginally stable (ISCO) radius Should be implemented in derived classes if useful If called on the base class, returns an error
Reimplemented in Gyoto::Metric::NumericalMetricLorene, and Gyoto::Metric::KerrBL.
|
virtual |
Returns the specific angular momentum l=-u_phi/u_t Should be implemented in derived classes if useful If called on the base class, returns an error
Reimplemented in Gyoto::Metric::NumericalMetricLorene, and Gyoto::Metric::KerrBL.
|
virtual |
|
virtual |
|
inherited |
Print (to stdout) some help on this class.
Describe all properties that this instance supports.
|
virtualinherited |
Start listening.
Use from a Hook::Listener object method:
where "this" is a Listener and "teller" is a Teller.
Use unhook() later to stop listening to a given Teller.
listener | pointer to the new listener |
|
virtual |
Check whether integration should stop.
The integrating loop will ask this the Metric through this method whether or not it is happy to continue the integration. Typically, the Metric should answer 0 when everything is fine, 1 when too close to the event horizon, inside the BH...
coord | 8-coordinate vector to check. |
|
protected |
Set kind_.
kind(const std::string) is protected because, for most Metrics, it should not be changed in runtime.Set kind_
|
virtual |
Set tdot (coord[4]) such that coord is light-like. Everything is in geometrical units.
Set coord[4] so that the 4-velocity coord[4:7] is lightlike, i.e. of norm 0. There may be up to two solutions. coord[4] is set to the hightest. The lowest can be retrieved using nullifyCoord(double coord[8], double& tdot2) const. Everything is expressed in geometrical units.
[in,out] | coord | 8-position, coord[4] will be set according to the other elements; |
Reimplemented in Gyoto::Metric::KerrBL.
|
virtual |
Set tdot (coord[4]) such that coord is light-like and return other possible tdot.
Set coord[4] so that the 4-velocity coord[4:7] is lightlike, i.e. of norm 0. There may be up to two solutions. coord[4] is set to the hightest. The lowest can be retrieved in tdot2. Everything is expressed in geometrical units.
[in,out] | coord | 8-position, coord[4] will be set according to the other elements; |
[out] | tdot2 | will be set to the smallest solution |
Reimplemented in Gyoto::Metric::KerrBL.
|
virtual |
Computes the orthonormal local tetrad of the observer.
obskind | input: kind of observer (eg: "ZAMO","KeplerianObserver"...) |
pos | input: position, |
fourvel | output: observer 4-velocity (norm -1) |
screen1 | output: first vector in the screen plane |
screen2 | output: second vector in the screen plane |
screen3 | output: vector normal to the screen |
Reimplemented in Gyoto::Metric::KerrBL, and Gyoto::Metric::Minkowski.
|
inherited |
|
virtual |
Scalar product.
Compute the scalarproduct of the two quadrivectors u1 and u2 in this Metric, at point pos expressed in coordinate system sys.
pos | 4-position; |
u1 | 1st quadrivector; |
u2 | 2nd quadrivector; |
Reimplemented in Gyoto::Metric::RotStar3_1, and Gyoto::Metric::KerrBL.
|
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::Star, Gyoto::Metric::RotStar3_1, and Gyoto::Metric::KerrKS.
|
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 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.
Reimplemented in Gyoto::Astrobj::Generic, Gyoto::Photon, Gyoto::Astrobj::Star, Gyoto::Spectrometer::Complex, Gyoto::Spectrometer::Uniform, and Gyoto::Astrobj::Complex.
|
virtual |
Compute tdot as a function of dr/dt, dtheta/dt and dphi/dt. Everything is in geometrical units.
coord | 4-position (geometrical units); |
v | 3-velocity dx1/dx0, dx2/dx0, dx3/dx0; |
|
protectedvirtualinherited |
Call tell() on each hooked Listener.
Whenever a Teller mutates, it should warn any Listener hooked to it using tellListeners().
|
virtualinherited |
Stop listening.
Use from a Hook::Listener object method:
where "this" is a Listener, "teller" is a Teller, and "this" has called teller->hook(this) previously.
listener | pointer to the listener |
double Gyoto::Metric::Generic::unitLength | ( | ) | const |
M * G / c^2, M is in kg, unitLength in meters.
Metrics implementations are free to express lengths and distances in whatever unit they see fit (presumably most often geometrical units). This function returns this unit in SI (meters).
|
protected |
Numerical tuning parameter.
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.
For investigations close to the event horizon, 0.5 is usually fine. If high accuracy is needed long after deflection (weak lensing), then this must be smaller. A good test is to look at a MinDistance map for a FixedStar: it must be smooth.
|
protectedinherited |
The "kind" that is output in the XML entity.
E.g. for an Astrobj, fillElement() will ensure
is written.