Gyoto
GyotoMetric.h
Go to the documentation of this file.
1 
12 /*
13  Copyright 2011-2016, 2018-2020 Frederic Vincent, Thibaut Paumard
14 
15  This file is part of Gyoto.
16 
17  Gyoto is free software: you can redistribute it and/or modify
18  it under the terms of the GNU General Public License as published by
19  the Free Software Foundation, either version 3 of the License, or
20  (at your option) any later version.
21 
22  Gyoto is distributed in the hope that it will be useful,
23  but WITHOUT ANY WARRANTY; without even the implied warranty of
24  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25  GNU General Public License for more details.
26 
27  You should have received a copy of the GNU General Public License
28  along with Gyoto. If not, see <http://www.gnu.org/licenses/>.
29  */
30 
31 #ifndef __GyotoMetric_H_
32 #define __GyotoMetric_H_
33 
34 #include <iostream>
35 #include <fstream>
36 #include <string>
37 #include <vector>
38 
39 #include <GyotoSmartPointer.h>
40 #include <GyotoObject.h>
41 #include <GyotoAstrobj.h>
42 #include <GyotoRegister.h>
43 #include <GyotoHooks.h>
44 #include <GyotoDefs.h>
45 
46 namespace Gyoto {
47  namespace Metric {
48 
49  class Generic;
50 
52 
60  typedef SmartPointer<Metric::Generic> Subcontractor_t(FactoryMessenger*, std::vector<std::string> const &);
61 
62 
71  template<typename T> SmartPointer<Metric::Generic> Subcontractor
72  (FactoryMessenger* fmp, std::vector<std::string> const &plugins) {
73  SmartPointer<T> gg = new T();
74  gg -> plugins(plugins);
75 #ifdef GYOTO_USE_XERCES
76  if (fmp) gg -> setParameters(fmp);
77 #endif
78  return gg;
79  }
80 
82 
100  std::vector<std::string> &plugin,
101  int errmode=0);
102 
104 
109  extern Register::Entry * Register_;
110 
112 
123  void Register(std::string kind, Gyoto::Metric::Subcontractor_t* scp);
124 
126 
130  void initRegister();
131 
132  }
133 
134  /* Documented elswhere */
135  class Worldline;
136 }
137 
159 : public Gyoto::SmartPointee,
160  public Gyoto::Object,
161  public Gyoto::Hook::Teller
162 {
164 
165  private:
166  double mass_;
168 
177 
178  protected:
179  double delta_min_;
180  double delta_max_;
181 
195 
196  bool keplerian_;
197 
198  protected:
205  void kind(const std::string);
206 
213  void coordKind(int coordkind);
214 
215 
216  public:
217  GYOTO_OBJECT;
218 
219  const std::string kind() const;
220  int getRefCount();
221 
222  // Constructors - Destructor
223  // -------------------------
224  Generic(const int coordkind, const std::string &name);
225  Generic(Generic const &o);
226  virtual ~Generic() ;
227 
228  // Mutators / assignment
229  // ---------------------
230  virtual Generic * clone() const ;
231 
232  virtual void mass(const double);
233  virtual void mass(const double, const std::string &unit);
234 
235  // Accessors
236 
237  int coordKind() const;
238 
239  double mass() const;
240  double mass(const std::string &unit) const;
241 
247  double unitLength() const ;
248  double unitLength(const std::string &unit) const ;
249 
255  virtual double getRmb() const;
256 
262  virtual double getRms() const;
263 
269  virtual double getSpecificAngularMomentum(double rr) const;
270 
276  virtual double getPotential(double const pos[4], double l_cst) const;
277 
281  double deltaMin() const;
282 
286  void deltaMin(double h1);
287 
291  double deltaMax() const;
292 
303  virtual double deltaMax(double const pos[8], double delta_max_external) const;
304 
308  void deltaMax(double h1);
309 
310  double deltaMaxOverR() const;
311  void deltaMaxOverR(double t);
312 
313  bool keplerian() const;
314  void keplerian(bool);
315 
316  virtual void cartesianVelocity(double const coord[8], double vel[3]);
318 
324  virtual double SysPrimeToTdot(const double coord[4], const double v[3]) const;
326 
347  virtual void circularVelocity(double const pos[4], double vel[4],
348  double dir=1.) const ;
349 
361  virtual void zamoVelocity(double const pos[4], double vel[4]) const ;
362 
373  virtual void nullifyCoord(double coord[8]) const;
375 
386  virtual void nullifyCoord(double coord[8], double& tdot2) const;
388 
399  virtual void normalizeFourVel(double coord[8]) const;
400 
411  virtual void normalizeFourVel(double const pos[4], double fourvel[4]) const;
412 
413 
422  virtual double ScalarProd(const double pos[4],
423  const double u1[4], const double u2[4]) const;
424 
432  double norm(const double pos[4],
433  const double u1[4]) const;
434 
436  void multiplyFourVect(double vect[4], double a) const;
437 
439  void addFourVect(double u1[4], double const u2[4]) const;
440 
442  void projectFourVect(double const pos[4], double u1[4], double const u2[4]) const;
443 
451  void dualOneForm(double const IN_ARRAY1_1[4], double const IN_ARRAY1_2[4], double ARGOUT_ARRAY1[4]) const ;
452 
463  virtual void observerTetrad(obskind_t obskind,
464  double const pos[4], double fourvel[4],
465  double screen1[4], double screen2[4],
466  double screen3[4]) const ;
467 
477  virtual void observerTetrad(double const pos[4], double fourvel[4],
478  double screen1[4], double screen2[4],
479  double screen3[4]) const ;
480 
493  void GramSchmidt(double const pos[4], double u0[4],
494  double u1[4], double u2[4], double u3[4]) const;
495  // Outputs
496 
507  virtual double gmunu(double const x[4], int mu, int nu) const;
508 
518  // Keep argument names for swig!
519  virtual void gmunu(double ARGOUT_ARRAY2[4][4], double const IN_ARRAY1[4]) const;
520 
531  virtual double gmunu_up(double const x[4], int mu, int nu) const;
532 
538  // Keep argument names for swig!
539  virtual void gmunu_up(double ARGOUT_ARRAY2[4][4], const double IN_ARRAY1[4]) const;
540 
548  // Keep argument names for swig!
549  virtual void jacobian(double ARGOUT_ARRAY3[4][4][4], const double IN_ARRAY1[4]) const;
550 
554  // Keep argument names for swig!
555  virtual void gmunu_up_and_jacobian(double ARGOUT_ARRAY2[4][4], double ARGOUT_ARRAY3[4][4][4], const double IN_ARRAY1[4]) const;
556 
564  virtual double christoffel(const double coord[4],
565  const int alpha, const int mu, const int nu) const;
566 
576  virtual int christoffel(double dst[4][4][4], const double coord[4]) const ;
577 
578 
579 
583  virtual int myrk4(Worldline * line, state_t const &coord, double h, state_t &res) const;
585  virtual int myrk4(Worldline * line, const double coord[8], double h, double res[8]) const = delete;
586 
590  virtual int myrk4_adaptive(Gyoto::Worldline* line, state_t const &coord,
591  double lastnorm, double normref,
592  state_t &coordnew, double h0, double& h1,
593  double deltamax=GYOTO_DEFAULT_DELTA_MAX) const;
595  virtual int myrk4_adaptive(Gyoto::Worldline* line, const double coord[8],
596  double lastnorm, double normref,
597  double coordnew[8], double h0, double& h1,
598  double deltamax=GYOTO_DEFAULT_DELTA_MAX) const = delete;
599 
600 
611  virtual int isStopCondition(double const coord[8]) const;
612 
616  virtual int diff(state_t const &x, state_t &dxdt, double mass) const ;
618  virtual int diff(state_t const &x, state_t &dxdt) const = delete;
619  virtual int diff(const double y[8], double res[8]) const = delete ;
620 
624  virtual void setParticleProperties(Gyoto::Worldline* line,
625  double const coord[8]) const;
626 
627 
628 };
629 
630 #endif
void multiplyFourVect(double vect[4], double a) const
multiply vector by scalar
virtual Generic * clone() const
Virtual copy constructor.
#define GYOTO_OBJECT
Declare class::properties and class::getProperties()
Definition: GyotoObject.h:84
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
SmartPointer< Metric::Generic > Subcontractor_t(FactoryMessenger *, std::vector< std::string > const &)
A function to build instances of a specific Metric::Generic sub-class.
Definition: GyotoMetric.h:60
int coordkind_
Kind of coordinates (cartesian-like, spherical-like, unspecified)
Definition: GyotoMetric.h:167
Gyoto registers.
double mass() const
Get mass used in unitLength()
Astronomical objects (light emitters)
Register::Entry * Register_
The Metric register.
Tellers tell Listeners when they mutate.
double delta_min_
Minimum integration step for the adaptive integrator.
Definition: GyotoMetric.h:179
virtual int diff(state_t const &x, state_t &dxdt, double mass) const
F function such as dx/dt=F(x,cst)
Base class for metrics.
Definition: GyotoMetric.h:158
Reference-counting pointers.
bool keplerian() const
Get keplerian_.
virtual void zamoVelocity(double const pos[4], double vel[4]) const
Yield ZAMO velocity at a given position.
int coordKind() const
Get coordinate kind.
double delta_max_
Maximum integration step for the adaptive integrator.
Definition: GyotoMetric.h:180
void projectFourVect(double const pos[4], double u1[4], double const u2[4]) const
project u1 orthogonally to u2 at pos
virtual void nullifyCoord(double coord[8]) const
Set tdot (coord[4]) such that coord is light-like. Everything is in geometrical units.
void addFourVect(double u1[4], double const u2[4]) const
add second vector to first one
Factory / SmartPointee::Subcontractor_t interface.
Definition: GyotoFactoryMessenger.h:92
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.
virtual int isStopCondition(double const coord[8]) const
Check whether integration should stop.
virtual double christoffel(const double coord[4], const int alpha, const int mu, const int nu) const
Chistoffel symbol.
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.
virtual double getSpecificAngularMomentum(double rr) const
bool keplerian_
1 if circularVelocity should return the Newtonian Keplerian velocity, in r^-3/2
Definition: GyotoMetric.h:196
virtual void normalizeFourVel(double coord[8]) const
Normalize fourvelvel to -1.
virtual double gmunu_up(double const x[4], int mu, int nu) const
Metric contravariant coefficients.
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 double gmunu(double const x[4], int mu, int nu) const
Metric coefficients.
double norm(const double pos[4], const double u1[4]) const
Scalar product.
Gyoto ubiquitous macros and typedefs.
double deltaMaxOverR() const
Get delta_max_over_r_.
void initRegister()
Empty the Metric register.
double delta_max_over_r_
Numerical tuning parameter.
Definition: GyotoMetric.h:194
double deltaMin() const
Introspectable objects.
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...
Namespace for the Gyoto library.
Definition: GyotoAstrobj.h:43
virtual double ScalarProd(const double pos[4], const double u1[4], const double u2[4]) const
Scalar product.
Gyoto::Metric::Subcontractor_t * getSubcontractor(std::string name, std::vector< std::string > &plugin, int errmode=0)
Query the Metric register.
int __defaultfeatures
Whether some virtual methods are implemented.
Definition: GyotoMetric.h:176
virtual void cartesianVelocity(double const coord[8], double vel[3])
Compute xprime, yprime and zprime from 8-coordinates.
Pointers performing reference counting.
Definition: GyotoProperty.h:45
Can be pointed to by a SmartPointer.
Definition: GyotoSmartPointer.h:80
virtual int myrk4(Worldline *line, state_t const &coord, double h, state_t &res) const
RK4 integrator.
const std::string kind() const
Get kind_.
double mass_
Mass yielding geometrical unit (in kg).
Definition: GyotoMetric.h:166
double unitLength() const
M * G / c^2, M is in kg, unitLength in meters.
Object with properties.
Definition: GyotoObject.h:151
virtual void setParticleProperties(Gyoto::Worldline *line, double const coord[8]) const
Set Metric-specific constants of motion. Used e.g. in KerrBL.
SmartPointer< Metric::Generic > Subcontractor(FactoryMessenger *fmp, std::vector< std::string > const &plugins)
Subcontractor template.
Definition: GyotoMetric.h:72
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.
double deltaMax() const
virtual void jacobian(double ARGOUT_ARRAY3[4][4][4], const double IN_ARRAY1[4]) const
Derivatives of the metric covariant coefficients.
virtual double getPotential(double const pos[4], double l_cst) const
Listen to me and I&#39;ll warn you when I change.
Definition: GyotoHooks.h:82
virtual void circularVelocity(double const pos[4], double vel[4], double dir=1.) const
Yield circular velocity at a given position.
virtual double getRms() const
virtual double getRmb() const
void Register(std::string kind, Gyoto::Metric::Subcontractor_t *scp)
Make a Metric kind known to the Factory.
Entry in a register (or a full register)
Definition: GyotoRegister.h:117