Gyoto
GyotoMetric.h
Go to the documentation of this file.
1 
12 /*
13  Copyright 2011-2016 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 
38 #include <GyotoSmartPointer.h>
39 #include <GyotoObject.h>
40 #include <GyotoAstrobj.h>
41 #include <GyotoRegister.h>
42 #include <GyotoHooks.h>
43 #include <GyotoDefs.h>
44 
45 namespace Gyoto {
46  namespace Metric {
47  class Generic;
48 
50 
58  typedef SmartPointer<Metric::Generic> Subcontractor_t(FactoryMessenger*, std::vector<std::string> const &);
59 
60 
69  template<typename T> SmartPointer<Metric::Generic> Subcontractor
70  (FactoryMessenger* fmp, std::vector<std::string> const &plugins) {
71  SmartPointer<T> gg = new T();
72  gg -> plugins(plugins);
73 #ifdef GYOTO_USE_XERCES
74  if (fmp) gg -> setParameters(fmp);
75 #endif
76  return gg;
77  }
78 
80 
98  std::vector<std::string> &plugin,
99  int errmode=0);
100 
102 
107  extern Register::Entry * Register_;
108 
110 
121  void Register(std::string kind, Gyoto::Metric::Subcontractor_t* scp);
122 
124 
128  void initRegister();
129 
130  }
131 
132  /* Documented elswhere */
133  class Worldline;
134 }
135 
157 : public Gyoto::SmartPointee,
158  public Gyoto::Object,
159  public Gyoto::Hook::Teller
160 {
161  friend class Gyoto::SmartPointer<Gyoto::Metric::Generic>;
162 
163  private:
164  double mass_;
166 
167  protected:
168  double delta_min_;
169  double delta_max_;
170 
184 
185  bool keplerian_;
186 
187  protected:
194  void kind(const std::string);
195 
202  void coordKind(int coordkind);
203 
204 
205  public:
206  GYOTO_OBJECT;
207 
208  const std::string kind() const;
209  int getRefCount();
210 
211  // Constructors - Destructor
212  // -------------------------
213  Generic(const int coordkind, const std::string &name);
214  Generic(Generic const &o);
215  virtual ~Generic() ;
216 
217  // Mutators / assignment
218  // ---------------------
219  virtual Generic * clone() const ;
220 
221  void mass(const double);
222  void mass(const double, const std::string &unit);
223 
224  // Accessors
225 
226  int coordKind() const;
227 
228  double mass() const;
229  double mass(const std::string &unit) const;
230 
236  double unitLength() const ;
237  double unitLength(const std::string &unit) const ;
238 
244  virtual double getRmb() const;
245 
251  virtual double getRms() const;
252 
258  virtual double getSpecificAngularMomentum(double rr) const;
259 
265  virtual double getPotential(double const pos[4], double l_cst) const;
266 
270  double deltaMin() const;
271 
275  void deltaMin(double h1);
276 
280  double deltaMax() const;
281 
292  virtual double deltaMax(double const pos[8], double delta_max_external) const;
293 
297  void deltaMax(double h1);
298 
299  double deltaMaxOverR() const;
300  void deltaMaxOverR(double t);
301 
302  bool keplerian() const;
303  void keplerian(bool);
304 
305  virtual void cartesianVelocity(double const coord[8], double vel[3]);
307 
313  virtual double SysPrimeToTdot(const double coord[4], const double v[3]) const;
315 
336  virtual void circularVelocity(double const pos[4], double vel[4],
337  double dir=1.) const ;
338 
349  virtual void nullifyCoord(double coord[8]) const;
351 
362  virtual void nullifyCoord(double coord[8], double& tdot2) const;
364 
365 
374  virtual double ScalarProd(const double pos[4],
375  const double u1[4], const double u2[4]) const;
376 
377 
388  virtual void observerTetrad(std::string const obskind,
389  double const pos[4], double fourvel[4],
390  double screen1[4], double screen2[4],
391  double screen3[4]) const ;
392 
393  // Outputs
394 
405  virtual double gmunu(double const x[4], int mu, int nu) const;
406 
416  virtual void gmunu(double g[4][4], double const pos[4]) const;
417 
418 
419 
427  virtual double christoffel(const double coord[4],
428  const int alpha, const int mu, const int nu) const;
429 
439  virtual int christoffel(double dst[4][4][4], const double coord[4]) const ;
440 
441 
442 
446  virtual int myrk4(Worldline * line, const double coord[8], double h, double res[8]) const;
447 
451  virtual int myrk4_adaptive(Gyoto::Worldline* line, const double coord[8],
452  double lastnorm, double normref,
453  double coordnew[8], double h0, double& h1,
454  double deltamax=GYOTO_DEFAULT_DELTA_MAX) const;
455 
466  virtual int isStopCondition(double const coord[8]) const;
467 
471  virtual int diff(const double y[8], double res[8]) const ;
472 
476  virtual void setParticleProperties(Gyoto::Worldline* line,
477  double const coord[8]) const;
478 
479 
480 };
481 
482 #endif
virtual Generic * clone() const
Virtual copy constructor.
#define GYOTO_OBJECT
Declare class::properties and class::getProperties()
Definition: GyotoObject.h:84
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:58
int coordkind_
Kind of coordinates (cartesian-like, spherical-like, unspecified)
Definition: GyotoMetric.h:165
Timelike or null geodesics.
Definition: GyotoWorldline.h:219
Gyoto registers.
double mass() const
Get mass used in unitLength()
Astronomical objects (light emitters)
virtual int diff(const double y[8], double res[8]) const
F function such as dy/dtau=F(y,cst)
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.
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:168
virtual int myrk4(Worldline *line, const double coord[8], double h, double res[8]) const
RK4 integrator.
Base class for metrics.
Definition: GyotoMetric.h:156
Reference-counting pointers.
bool keplerian() const
Get keplerian_.
int coordKind() const
Get coordinate kind.
double delta_max_
Maximum integration step for the adaptive integrator.
Definition: GyotoMetric.h:169
virtual void nullifyCoord(double coord[8]) const
Set tdot (coord[4]) such that coord is light-like. Everything is in geometrical units.
Factory / SmartPointee::Subcontractor_t interface.
Definition: GyotoFactoryMessenger.h:92
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 double getSpecificAngularMomentum(double rr) const
bool keplerian_
1 if circularVelocity should return the Newtonian Keplerian velocity, in r^-3/2
Definition: GyotoMetric.h:185
virtual double gmunu(double const x[4], int mu, int nu) const
Metric coefficients.
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:183
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.
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
const std::string kind() const
Get kind_.
double mass_
Mass yielding geometrical unit (in kg).
Definition: GyotoMetric.h:164
double unitLength() const
M * G / c^2, M is in kg, unitLength in meters.
Object with properties.
Definition: GyotoObject.h:151
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 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:70
double deltaMax() const
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:94