Gyoto
|
Metric around a Kerr black-hole in Kerr-Schild coordinates. More...
#include <GyotoKerrKS.h>
Public Member Functions | |
KerrKS () | |
Default constructor. | |
KerrKS (double spin, double mass) | |
Constructor with spin and mass specification. | |
virtual KerrKS * | clone () const |
Copy constructor. | |
virtual | ~KerrKS () |
Destructor. | |
void | setSpin (const double spin) |
Set spin. | |
double | getSpin () const |
Returns spin. | |
double | gmunu (const double *x, int alpha, int beta) const |
double | christoffel (const double[8], const int, const int, const int) const |
void | nullifyCoord (double coord[8], double &tdot2) const |
Set tdot (coord[4]) such that coord is light-like and return other possible tdot. | |
void | nullifyCoord (double coord[8]) const |
Set tdot (coord[4]) such that coord is light-like. Everything is in geometrical units. | |
virtual void | circularVelocity (double const pos[4], double vel[4], double dir=1.) const |
Yield circular valocity at a given position (projected on equatorial plane. | |
virtual void | fillElement (FactoryMessenger *fmp) |
called from Factory | |
void | MakeCst (const double *coord, double *cst) const |
In Kerr-Schild coordinates [T,x,y,z,Tdot,xdot,ydot,zdot], computes the four constants of the movement : particule mass, energy, angular momentum and Carter's constant. | |
const std::string | getKind () const |
void | setKind (const std::string) |
int | getRefCount () |
Get the current number of references. | |
void | setMass (const double) |
Set mass used in unitLength() | |
void | setMass (const double, std::string unit) |
Set mass used in unitLength() | |
int | getCoordKind () const |
Get coordinate kind. | |
void | setCoordKind (int coordkind) |
Set coordinate kind. | |
double | getMass () const |
Get mass used in unitLength() | |
double | unitLength () const |
M * G / c^2, M is in kg, unitLength in meters. | |
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. | |
virtual double | ScalarProd (const double pos[4], const double u1[4], const double u2[4]) const |
Scalar product. | |
virtual double | Norm3D (double *pos) const |
not clear | |
void | processGenericParameters (Gyoto::FactoryMessenger *fmp) |
virtual int | myrk4_adaptive (Gyoto::Worldline *line, const double coord[8], double lastnorm, double normref, double coordnew[8], double h0, double &h1) const |
Static Public Member Functions | |
static void | Init () |
Static Public Attributes | |
static Metric::Subcontractor_t | Subcontractor |
Protected Types | |
typedef Gyoto::SmartPointer < Gyoto::SmartPointee > | Subcontractor_t (Gyoto::FactoryMessenger *) |
A subcontractor builds an object upon order from the Factory. |
Protected Member Functions | |
int | myrk4 (Worldline *line, const double coord[8], double h, double res[8]) const |
int | myrk4 (const double *coord, const double *cst, double h, double *res) const |
int | myrk4_adaptive (Gyoto::Worldline *line, const double *coord, double lastnorm, double normref, double *coord1, double h0, double &h1) const |
int | diff (const double *coord, const double *cst, double *res) const |
int | diff (const double y[8], double res[8]) const |
virtual int | isStopCondition (double const *const coord) const |
void | setParticleProperties (Worldline *line, const double *coord) const |
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. |
Protected Attributes | |
double | spin_ |
Angular momentum parameter. |
Friends | |
class | Gyoto::SmartPointer< Gyoto::Metric::KerrKS > |
Metric around a Kerr black-hole in Kerr-Schild coordinates.
|
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 |
Value of Christoffel symbol $^{}_{}$ at point $(x_{1},x_{2},x_{3})$
Implements Gyoto::Metric::Generic.
|
virtual |
Yield circular valocity at a given position (projected on equatorial plane.
pos | input: position, |
vel | output: velocity, |
dir | 1 for corotating, -1 for counterrotating. |
Reimplemented from Gyoto::Metric::Generic.
|
protected |
F function such as dy/dtau=F(y,cst)
|
protectedvirtual |
F function such as dy/dtau=F(y,cst)
Reimplemented from Gyoto::Metric::Generic.
|
virtual |
Value of metric coefficient $g_{}$ at point $(x_{1},x_{2},x_{3})$ in Kerr-Schild coordinates
Implements Gyoto::Metric::Generic.
|
protectedvirtual |
The integrating loop will ask this the Metric through this method whether or not it is happy to conitnue 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] | coordinates to check. |
Reimplemented from Gyoto::Metric::Generic.
|
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.
coord[4] | 8-position, coord[4] will be set according to the other elements; |
tdot2 | will be set to the smallest solution |
Reimplemented from Gyoto::Metric::Generic.
|
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 in tdot2. Everything is expressed in geometrical units.
coord[4] | 8-position, coord[4] will be set according to the other elements; |
Reimplemented from Gyoto::Metric::Generic.
|
virtualinherited |
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] | 4-position; |
u1[4] | 1st quadrivector; |
u2[4] | 2nd quadrivector; |
Reimplemented in Gyoto::Metric::RotStar3_1.
|
protectedvirtual |
Set Metric-specific constants of motion. Used e.g. in KerrBL.
Reimplemented from Gyoto::Metric::Generic.
|
virtualinherited |
Compute tdot as a function of dr/dt, dtheta/dt and dphi/dt. Everything is in geometrical units.
coord[4] | 4-position (geometrical units); |
v[3] | 3-velocity dx1/dx0, dx2/dx0, dx3/dx0; |
|
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).