Metric coded in Python. More...
#include <GyotoPython.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... | |
| Python (const Python &) | |
| virtual Python * | clone () const |
| Virtual copy constructor. | |
| void | spherical (bool) |
| bool | spherical () const |
| virtual std::string | module () const |
| Return module_. | |
| virtual void | module (const std::string &) |
| Set module_ and import the Python module. More... | |
| virtual std::string | inlineModule () const |
| Return inline_module_. | |
| virtual void | inlineModule (const std::string &) |
| Set inline_module_ and import the Python module. More... | |
| virtual std::string | klass () const |
| Retrieve class_. | |
| virtual void | klass (const std::string &) |
| Set class_ and instantiate the Python class. More... | |
| virtual size_t | instance () const |
| Retrieve pInstance_. More... | |
| virtual void | instance (size_t address) |
| virtual void | detachInstance () |
| Detach pInstance_ and cached method pointers. More... | |
| virtual void | attachInstance (PyObject *instance) |
| Attach pInstance_ and cached method pointers. More... | |
| virtual std::vector< double > | parameters () const |
| Retrieve parameters_. | |
| virtual void | parameters (const std::vector< double > &) |
| Set parameters_ and send them to pInstance_. More... | |
| virtual void | mass (double m) |
| Set mass used in unitLength() | |
| void | gmunu (double g[4][4], const double *x) const |
| int | christoffel (double dst[4][4][4], const double *x) const |
| double | getRmb () const |
| double | getRms () const |
| double | getSpecificAngularMomentum (double rr) const |
| double | getPotential (double const pos[4], double l_cst) const |
| int | isStopCondition (double const coord[8]) const |
| Check whether integration should stop. More... | |
| void | circularVelocity (double const pos[4], double vel[4], double dir=1.) const |
| Yield circular velocity at a given position. More... | |
| virtual bool | knowsProperty (const std::string &name) const |
| virtual void | set (std::string const &key, Value val) |
| virtual void | set (std::string const &key, Value val, std::string const &unit) |
| virtual void | set (Property const &p, Value val) |
| virtual void | set (Property const &p, Value val, std::string const &unit) |
| virtual Value | get (std::string const &key) const |
| virtual Value | get (std::string const &key, std::string const &unit) const |
| Value | get (Property const &p, std::string const &unit) const |
| Value | get (Property const &p) const |
| virtual int | setParameter (std::string name, std::string content, std::string unit) |
| 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 | fillProperty (Gyoto::FactoryMessenger *fmp, Property const &p) const |
| virtual void | fillElement (Gyoto::FactoryMessenger *fmp) const |
| void | setParameters (Gyoto::FactoryMessenger *fmp) |
| int | coordKind () const |
| Get coordinate kind. | |
| int | getRefCount () |
| virtual void | mass (const double, const std::string &unit) |
| Set mass used in unitLength() | |
| 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 | |
| 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 | zamoVelocity (double const pos[4], double vel[4]) const |
| Yield ZAMO 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 void | normalizeFourVel (double coord[8]) const |
| Normalize fourvelvel to -1. More... | |
| virtual void | normalizeFourVel (double const pos[4], double fourvel[4]) const |
| Normalize fourvelvel to -1. More... | |
| virtual double | ScalarProd (const double pos[4], const double u1[4], const double u2[4]) const |
| Scalar product. More... | |
| double | norm (const double pos[4], const double u1[4]) const |
| Scalar product. More... | |
| void | multiplyFourVect (double vect[4], double a) const |
| multiply vector by scalar | |
| void | addFourVect (double u1[4], double const u2[4]) const |
| add second vector to first one | |
| void | projectFourVect (double const pos[4], double u1[4], double const u2[4]) const |
| project u1 orthogonally to u2 at pos | |
| void | dualOneForm (double const IN_ARRAY1_1[4], double const IN_ARRAY1_2[4], double ARGOUT_ARRAY1[4]) const |
| Computes dual 1-form Compute the dual 1-form of 4-vector. More... | |
| virtual void | observerTetrad (obskind_t 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 void | observerTetrad (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... | |
| void | GramSchmidt (double const pos[4], double u0[4], double u1[4], double u2[4], double u3[4]) const |
| Apply Gram-Schmidt orthonormalization to a basis. More... | |
| virtual double | gmunu (double const x[4], int mu, int nu) const |
| Metric coefficients. More... | |
| virtual void | gmunu (double ARGOUT_ARRAY2[4][4], double const IN_ARRAY1[4]) const |
| Metric coefficients. More... | |
| virtual double | gmunu_up (double const x[4], int mu, int nu) const |
| Metric contravariant coefficients. More... | |
| virtual void | gmunu_up (double ARGOUT_ARRAY2[4][4], const double IN_ARRAY1[4]) const |
| Metric contravariant coefficients. More... | |
| virtual void | jacobian (double ARGOUT_ARRAY3[4][4][4], const double IN_ARRAY1[4]) const |
| Derivatives of the metric covariant coefficients. More... | |
| virtual void | gmunu_up_and_jacobian (double ARGOUT_ARRAY2[4][4], double ARGOUT_ARRAY3[4][4][4], const double IN_ARRAY1[4]) const |
| gmunu_up() and jacobian() in one go | |
| virtual void | computeNBeta (const double coord[4], double &NN, double beta[3]) const |
| Computes lapse scalar and shift vector at coord. | |
| 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, state_t const &coord, double h, state_t &res) const |
| RK4 integrator. | |
| virtual int | myrk4 (Worldline *line, const double coord[8], double h, double res[8]) const =delete |
| Obsolete, update your code. | |
| virtual int | myrk4_adaptive (Gyoto::Worldline *line, state_t const &coord, double lastnorm, double normref, state_t &coordnew, double h0, double &h1, double deltamax=GYOTO_DEFAULT_DELTA_MAX) const |
| RK4 integrator with adaptive step. | |
| 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 =delete |
| Obsolete, update your code. | |
| virtual int | diff (state_t const &x, state_t &dxdt, double mass) const |
| F function such as dx/dt=F(x,cst) | |
| virtual int | diff (state_t const &x, state_t &dxdt) const =delete |
| Obsolete, update your code. | |
| virtual int | diff (const double y[8], double res[8]) const =delete |
| virtual int | diff31 (state_t const &x, state_t &dxdt, double mass) const |
| F function such as dx/dt=F(x,cst) for 3+1 case. | |
| 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. | |
| virtual bool | isThreadSafe () const |
| Whether this class is thread-safe. More... | |
| Property const * | property (std::string const pname) const |
| Find property by 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 std::string | kind () const |
| Get kind_. | |
| virtual void | hook (Listener *listener) |
| Start listening. More... | |
| virtual void | unhook (Listener *listener) |
| Stop listening. More... | |
| virtual void | instance (PyObject *pinstance) |
| Set pInstance_. More... | |
| virtual bool | hasPythonProperty (std::string const &key) const |
| virtual void | setPythonProperty (std::string const &key, Value val) |
| virtual void | setPythonProperty (std::string const &key, Value val, std::string const &unit) |
| virtual Value | getPythonProperty (std::string const &key) const |
| virtual Value | getPythonProperty (std::string const &key, std::string const &unit) const |
| virtual Gyoto::Property::type_e | pythonPropertyType (std::string const &key) const |
| void | checkModuleForSingleClass () |
| Look for single class in pModule_. More... | |
| PyObject * | instantiateClass (std::string &klass) const |
Creates an instance of class klass in module module_. More... | |
Public Attributes | |
| GYOTO_OBJECT_THREAD_SAFETY | |
Static Public Attributes | |
| static GYOTO_OBJECT Property const | properties [] |
Protected Member Functions | |
| void | coordKind (int coordkind) |
| Set coordkind_. More... | |
| virtual void | kind (const std::string) |
| Set kind_. 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... | |
| std::vector< std::string > | plugins_ |
| The plug-ins that needs to be loaded to access this instance's class. More... | |
| std::string | module_ |
| Name of the Python module that holds the class. More... | |
| std::string | inline_module_ |
| Python source code for module that holds the class. | |
| std::string | class_ |
| Name of the Python class that we want to expose. More... | |
| std::vector< double > | parameters_ |
| Parameters that this class needs. More... | |
| PyObject * | pModule_ |
| Reference to the python module once it has been loaded. | |
| PyObject * | pInstance_ |
| Reference to the python instance once it has been instantiated. | |
| PyObject * | pProperties_ |
| Reference to the properties member. | |
| PyObject * | pSet_ |
| Reference to the (optional) Set method. | |
| PyObject * | pGet_ |
| Reference to the (optional) Get method. | |
Private Attributes | |
| PyObject * | pGmunu_ |
| Reference to the gmunu method. | |
| PyObject * | pChristoffel_ |
| Reference to the christoffel method. | |
| PyObject * | pGetRmb_ |
| Reference to the getRmb method. | |
| PyObject * | pGetRms_ |
| Reference to the getRms method. | |
| PyObject * | pGetSpecificAngularMomentum_ |
| Reference to the method getSpecificAngularMomentum. | |
| PyObject * | pGetPotential_ |
| Reference to the getPotential method. | |
| PyObject * | pIsStopCondition_ |
| Reference to the isStopCondition method. | |
| PyObject * | pCircularVelocity_ |
| Reference to the circularVelocity method. | |
Friends | |
| class | Gyoto::SmartPointer< Gyoto::Metric::Python > |
Detailed Description
Loader for Python Metric classes. It interfaces with a Python class which must implement at least the gmunu and christoffel methods.
Other methods are optional: getRmb, getRms, getSpecificAngularMomentum, getPotential.
Use <Cartesian> or </Spherical> to select the coordinate system kind.
Sample XML file:
Sample Python module:
Member Typedef Documentation
◆ Subcontractor_t
|
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().
Member Function Documentation
◆ attachInstance()
|
virtual |
Attach pInstance_ and cached method pointers.
Attaches pInstance_, #pProperties, pSet_ and pGet_. Increments their reference counters.
Derived classes should call Base::attachInstance and attach the other pointers.
Reimplemented from Gyoto::Python::Base.
◆ checkModuleForSingleClass()
|
inherited |
◆ christoffel() [1/2]
|
virtualinherited |
Chistoffel symbol.
Value of Christoffel symbol Γαμν at point (x1, x2, x3).
Reimplemented in Gyoto::Metric::NumericalMetricLorene, Gyoto::Metric::Minkowski, and Gyoto::Metric::ChernSimons.
◆ christoffel() [2/2]
|
virtualinherited |
Chistoffel symbol.
Value of Christoffel symbol Γαμν at point (x1, x2, x3).
- Returns
- 1 on error, 0 otherwise
Reimplemented in Gyoto::Metric::NumericalMetricLorene, Gyoto::Metric::KerrBL, Gyoto::Metric::Hayward, Gyoto::Metric::BalasinGrumiller, and Gyoto::Metric::Minkowski.
◆ circularVelocity()
|
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.
- Parameters
-
pos input: position, vel output: velocity, dir 1 for corotating, -1 for counterrotating.
Reimplemented from Gyoto::Metric::Generic.
◆ coordKind()
|
protectedinherited |
Set coordkind_.
coordkind(int coordkind) is protected because, for most Metrics, it should not be changed in runtime.Set coordinate kind
◆ deltaMax() [1/3]
|
inherited |
Get delta_max_
◆ deltaMax() [2/3]
|
virtualinherited |
Get delta max at a given position
- Parameters
-
pos 4-position [optional] delta_max_external external constraint on delta_max
- Returns
- the smallest value between delta_max_, delta_max_external, and R*delta_max_over_r_ where R is pos[1] in spherical coordinates and max(x1, x2, x3) in Cartesian coordinates.
◆ deltaMax() [3/3]
|
inherited |
Set delta_max_
◆ deltaMin() [1/2]
|
inherited |
Get delta_min_
◆ deltaMin() [2/2]
|
inherited |
Set delta_min_
◆ describeProperty()
|
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.
◆ detachInstance()
|
virtual |
Detach pInstance_ and cached method pointers.
Detaches (=calls Py_XDECREF and sets to NULL) #pProperties, pSet_ and pGet_.
Derived classes should detach the other pointers and call Base::detachInstance().
Reimplemented from Gyoto::Python::Base.
◆ dualOneForm()
|
inherited |
Computes dual 1-form Compute the dual 1-form of 4-vector.
- Parameters
-
IN_ARRAY1_1 4-position; IN_ARRAY1_2 quadrivector; [out] ARGOUT_ARRAY1 output 1-form
◆ getPotential()
|
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 from Gyoto::Metric::Generic.
◆ getProperties()
|
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::Metric::Generic.
◆ getRmb()
|
virtual |
Returns the marginally bound radius Should be implemented in derived classes if useful If called on the base class, returns an error
Reimplemented from Gyoto::Metric::Generic.
◆ getRms()
|
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 from Gyoto::Metric::Generic.
◆ getSpecificAngularMomentum()
|
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 from Gyoto::Metric::Generic.
◆ gmunu() [1/2]
|
virtualinherited |
Metric coefficients.
The default implementation calls Metric:: gmunu(double g[4][4], const double * pos) const
- Parameters
-
x 4-position at which to compute the coefficient; mu 1st index of coefficient, 0≤μ≤3; nu 2nd index of coefficient, 0≤ν≤3;
- Returns
- Metric coefficient gμ,ν at point x
Reimplemented in Gyoto::Metric::RotStar3_1, Gyoto::Metric::Hayward, Gyoto::Metric::KerrBL, Gyoto::Metric::KerrKS, Gyoto::Metric::KonoplyaRezzollaZhidenko, Gyoto::Metric::RezzollaZhidenko, Gyoto::Metric::ChernSimons, and Gyoto::Metric::SchwarzschildHarmonic.
◆ gmunu() [2/2]
|
virtualinherited |
Metric coefficients.
The default implementation calls double gmunu(const double * x, int mu, int nu) const.
- Parameters
-
[out] ARGOUT_ARRAY2 (g) 4x4 array to store the coeefficients [in] IN_ARRAY1 (x) 4-position at which to compute the coefficients;
- Returns
- Metric coefficient gμ,ν at point x
Reimplemented in Gyoto::Metric::ChernSimons.
◆ gmunu_up() [1/2]
|
virtualinherited |
Metric contravariant coefficients.
The default implementation calls Metric:: gmunu_up(double g[4][4], const double * pos) const
- Parameters
-
x 4-position at which to compute the coefficient; mu 1st index of coefficient, 0≤μ≤3; nu 2nd index of coefficient, 0≤ν≤3;
- Returns
- Metric coefficient gμ,ν at point x
Reimplemented in Gyoto::Metric::Hayward, Gyoto::Metric::KerrBL, Gyoto::Metric::KonoplyaRezzollaZhidenko, and Gyoto::Metric::ChernSimons.
◆ gmunu_up() [2/2]
|
virtualinherited |
Metric contravariant coefficients.
The default implementation inverts the covariant coefficients matrix.
Reimplemented in Gyoto::Metric::NumericalMetricLorene, Gyoto::Metric::Hayward, Gyoto::Metric::KerrBL, Gyoto::Metric::KerrKS, Gyoto::Metric::KonoplyaRezzollaZhidenko, and Gyoto::Metric::Shift.
◆ GramSchmidt()
|
inherited |
Apply Gram-Schmidt orthonormalization to a basis.
On input, u0 to u3 must be four non-zero norm, independent 4-vectors. On output, they will form an orthonormal basis.
- Parameters
-
[in] pos position, [in,out] u0 basis vector [in,out] u1 basis vector [in,out] u2 basis vector [in,out] u3 basis vector
◆ help()
|
inherited |
Print (to stdout) some help on this class.
Describe all properties that this instance supports.
◆ hook()
|
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.
- Parameters
-
listener pointer to the new listener
◆ inlineModule()
|
virtual |
Set inline_module_ and import the Python module.
Side effects:
- sets module_ to "";
- calls klass(class_) if class_ is already known, so module_ can be set (or reset) after class_.
Reimplemented from Gyoto::Python::Base.
◆ instance() [1/2]
|
virtualinherited |
Set pInstance_.
Detach the previously set instance, sets pModule_ to nullptr and class_ to "", then calls attachInstance() if instance is not null.
◆ instance() [2/2]
|
virtual |
Retrieve pInstance_.
Returns a borrowed reference to pInstance_, as an size_t integer.
◆ instantiateClass()
|
inherited |
Creates an instance of class klass in module module_.
Returns a new reference.
◆ isStopCondition()
|
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...
- Parameters
-
coord 8-coordinate vector to check.
Reimplemented from Gyoto::Metric::Generic.
◆ isThreadSafe()
|
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.
◆ jacobian()
|
virtualinherited |
Derivatives of the metric covariant coefficients.
The default implementation evaluates them numerically. The gmunu matrix is assumed to be symmetrical but no other assumptions are made at the moment.
Reimplemented in Gyoto::Metric::NumericalMetricLorene, Gyoto::Metric::Complex, Gyoto::Metric::KerrKS, and Gyoto::Metric::Shift.
◆ kind()
|
protectedvirtualinherited |
Set kind_.
kind(const std::string) is protected because, for most Objects, it should not be changed in runtime.Set kind_
◆ klass()
|
virtual |
Set class_ and instantiate the Python class.
Sets pInstance_.
This generic implementation takes care of the common ground, but does not set 'this' or call parameters(parameters_). Therefore, all the derived classes should reimplement this method and at least call Python::Base::klass(c) and parameters(parameters_). Between the two is the right moment to check that the Python class implements the required API and to cache PyObject* pointers to class methods.
Reimplemented from Gyoto::Python::Base.
◆ module()
|
virtual |
Set module_ and import the Python module.
Side effects:
- sets inline_module_ to "";
- calls klass(class_) if class_ is already known, so module_ can be set (or reset) after class_.
Reimplemented from Gyoto::Python::Base.
◆ norm()
|
inherited |
Scalar product.
Compute the norm of the quadrivector u1 in this Metric, at point pos expressed in coordinate system sys.
- Parameters
-
[in] pos 4-position; [in] u1 quadrivector;
- Returns
- ||u1||
◆ normalizeFourVel() [1/2]
|
virtualinherited |
Normalize fourvelvel to -1.
First computes threevel as xiprime=xidot/x0dot for i in {1, 2, 3}, then computes x0dot using SyPrimeToTdot, then computes again xidot as xidot=xiprime*x0dot.
- Parameters
-
[in,out] coord 8-position, coord[4-7] will be set according to the other elements;
◆ normalizeFourVel() [2/2]
|
virtualinherited |
Normalize fourvelvel to -1.
First computes threevel as xiprime=xidot/x0dot for i in {1, 2, 3}, then computes x0dot using SyPrimeToTdot, then computes again xidot as xidot=xiprime*x0dot.
- Parameters
-
[in] pos 4-position; [in,out] fourvel 4-velocity, will be renormalized.
◆ nullifyCoord() [1/2]
|
virtualinherited |
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.
- Parameters
-
[in,out] coord 8-position, coord[4] will be set according to the other elements;
Reimplemented in Gyoto::Metric::KerrBL.
◆ nullifyCoord() [2/2]
|
virtualinherited |
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.
- Parameters
-
[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.
◆ observerTetrad() [1/2]
|
virtualinherited |
Computes the orthonormal local tetrad of the observer.
- Parameters
-
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::Minkowski.
◆ observerTetrad() [2/2]
|
virtualinherited |
Computes the orthonormal local tetrad of the observer.
- Parameters
-
[in] pos position, [in] fourvel observer 4-velocity (norm -1) [out] screen1 first vector in the screen plane [out] screen2 second vector in the screen plane [out] screen3 vector normal to the screen
Reimplemented in Gyoto::Metric::KerrBL.
◆ parameters()
|
virtual |
Set parameters_ and send them to pInstance_.
The parameters are sent to the class instance using the setitem method with numerical keys.
Reimplemented from Gyoto::Python::Base.
◆ property()
|
inherited |
◆ ScalarProd()
|
virtualinherited |
Scalar product.
Compute the scalarproduct of the two quadrivectors u1 and u2 in this Metric, at point pos expressed in coordinate system sys.
- Parameters
-
pos 4-position; u1 1st quadrivector; u2 2nd quadrivector;
- Returns
- u1*u2
Reimplemented in Gyoto::Metric::RotStar3_1, Gyoto::Metric::Hayward, and Gyoto::Metric::KerrBL.
◆ setParameter()
|
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:
- Parameters
-
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.
◆ SysPrimeToTdot()
|
virtualinherited |
Compute tdot as a function of dr/dt, dtheta/dt and dphi/dt. Everything is in geometrical units.
- Parameters
-
coord 4-position (geometrical units); v 3-velocity dx1/dx0, dx2/dx0, dx3/dx0;
- Returns
- tdot = dx0/dtau.
◆ tellListeners()
|
protectedvirtualinherited |
Call tell() on each hooked Listener.
Whenever a Teller mutates, it should warn any Listener hooked to it using tellListeners().
◆ unhook()
|
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.
- Parameters
-
listener pointer to the listener
◆ unitLength()
|
inherited |
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).
◆ zamoVelocity()
|
virtualinherited |
Yield ZAMO velocity at a given position.
Give the velocity of a zero angular momentul observer (whatever is closest to "at rest"). The default implementation simply projects (1, 0, 0, 0) othogonally along ephi and normalizes it, thus ensuring that vel is orthogonal to ephi.
- Parameters
-
pos input: position, vel output: velocity,
Reimplemented in Gyoto::Metric::KerrBL.
Member Data Documentation
◆ class_
|
protectedinherited |
◆ delta_max_over_r_
|
protectedinherited |
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.
◆ kind_
|
protectedinherited |
◆ module_
|
protectedinherited |
◆ parameters_
|
protectedinherited |
◆ plugins_
|
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.
The documentation for this class was generated from the following file:
