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 #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 
169  protected:
170  double delta_min_;
171  double delta_max_;
172 
186 
187  bool keplerian_;
188 
189  protected:
196  void kind(const std::string);
197 
204  void coordKind(int coordkind);
205 
206 
207  public:
208  GYOTO_OBJECT;
209 
210  const std::string kind() const;
211  int getRefCount();
212 
213  // Constructors - Destructor
214  // -------------------------
215  Generic(const int coordkind, const std::string &name);
216  Generic(Generic const &o);
217  virtual ~Generic() ;
218 
219  // Mutators / assignment
220  // ---------------------
221  virtual Generic * clone() const ;
222 
223  void mass(const double);
224  void mass(const double, const std::string &unit);
225 
226  // Accessors
227 
228  int coordKind() const;
229 
230  double mass() const;
231  double mass(const std::string &unit) const;
232 
238  double unitLength() const ;
239  double unitLength(const std::string &unit) const ;
240 
246  virtual double getRmb() const;
247 
253  virtual double getRms() const;
254 
260  virtual double getSpecificAngularMomentum(double rr) const;
261 
267  virtual double getPotential(double const pos[4], double l_cst) const;
268 
272  double deltaMin() const;
273 
277  void deltaMin(double h1);
278 
282  double deltaMax() const;
283 
294  virtual double deltaMax(double const pos[8], double delta_max_external) const;
295 
299  void deltaMax(double h1);
300 
301  double deltaMaxOverR() const;
302  void deltaMaxOverR(double t);
303 
304  bool keplerian() const;
305  void keplerian(bool);
306 
307  virtual void cartesianVelocity(double const coord[8], double vel[3]);
309 
315  virtual double SysPrimeToTdot(const double coord[4], const double v[3]) const;
317 
338  virtual void circularVelocity(double const pos[4], double vel[4],
339  double dir=1.) const ;
340 
352  virtual void zamoVelocity(double const pos[4], double vel[4]) const ;
353 
364  virtual void nullifyCoord(double coord[8]) const;
366 
377  virtual void nullifyCoord(double coord[8], double& tdot2) const;
379 
390  virtual void normalizeFourVel(double coord[8]) const;
391 
402  virtual void normalizeFourVel(double const pos[4], double fourvel[4]) const;
403 
404 
413  virtual double ScalarProd(const double pos[4],
414  const double u1[4], const double u2[4]) const;
415 
423  double norm(const double pos[4],
424  const double u1[4]) const;
425 
427  void multiplyFourVect(double vect[4], double a) const;
428 
430  void addFourVect(double u1[4], double const u2[4]) const;
431 
433  void projectFourVect(double const pos[4], double u1[4], double const u2[4]) const;
434 
442  void dualOneForm(double const IN_ARRAY1_1[4], double const IN_ARRAY1_2[4], double ARGOUT_ARRAY1[4]) const ;
443 
454  virtual void observerTetrad(obskind_t obskind,
455  double const pos[4], double fourvel[4],
456  double screen1[4], double screen2[4],
457  double screen3[4]) const ;
458 
468  virtual void observerTetrad(double const pos[4], double fourvel[4],
469  double screen1[4], double screen2[4],
470  double screen3[4]) const ;
471 
484  void GramSchmidt(double const pos[4], double u0[4],
485  double u1[4], double u2[4], double u3[4]) const;
486  // Outputs
487 
498  virtual double gmunu(double const x[4], int mu, int nu) const;
499 
509  virtual void gmunu(double g[4][4], double const pos[4]) const;
510 
511 
512 
520  virtual double christoffel(const double coord[4],
521  const int alpha, const int mu, const int nu) const;
522 
532  virtual int christoffel(double dst[4][4][4], const double coord[4]) const ;
533 
534 
535 
539  virtual int myrk4(Worldline * line, state_t const &coord, double h, state_t &res) const;
541  virtual int myrk4(Worldline * line, const double coord[8], double h, double res[8]) const = delete;
542 
546  virtual int myrk4_adaptive(Gyoto::Worldline* line, state_t const &coord,
547  double lastnorm, double normref,
548  state_t &coordnew, double h0, double& h1,
549  double deltamax=GYOTO_DEFAULT_DELTA_MAX) const;
551  virtual int myrk4_adaptive(Gyoto::Worldline* line, const double coord[8],
552  double lastnorm, double normref,
553  double coordnew[8], double h0, double& h1,
554  double deltamax=GYOTO_DEFAULT_DELTA_MAX) const = delete;
555 
556 
567  virtual int isStopCondition(double const coord[8]) const;
568 
572  virtual int diff(state_t const &x, state_t &dxdt) const ;
574  virtual int diff(const double y[8], double res[8]) const = delete ;
575 
579  virtual void setParticleProperties(Gyoto::Worldline* line,
580  double const coord[8]) const;
581 
582 
583 };
584 
585 #endif
GYOTO_OBJECT
#define GYOTO_OBJECT
Declare class::properties and class::getProperties()
Definition: GyotoObject.h:84
GyotoSmartPointer.h
Reference-counting pointers.
Gyoto::Metric::Generic::coordkind_
int coordkind_
Kind of coordinates (cartesian-like, spherical-like, unspecified)
Definition: GyotoMetric.h:167
Gyoto::Metric::initRegister
void initRegister()
Empty the Metric register.
Gyoto::Metric::Subcontractor
SmartPointer< Metric::Generic > Subcontractor(FactoryMessenger *fmp, std::vector< std::string > const &plugins)
Subcontractor template.
Definition: GyotoMetric.h:72
Gyoto::Metric::Generic::zamoVelocity
virtual void zamoVelocity(double const pos[4], double vel[4]) const
Yield ZAMO velocity at a given position.
Gyoto::Object
Object with properties.
Definition: GyotoObject.h:151
Gyoto::Metric::Generic::mass
double mass() const
Get mass used in unitLength()
Gyoto::Metric::Generic::delta_max_
double delta_max_
Maximum integration step for the adaptive integrator.
Definition: GyotoMetric.h:171
Gyoto::FactoryMessenger
Factory / SmartPointee::Subcontractor_t interface.
Definition: GyotoFactoryMessenger.h:92
Gyoto::Metric::Generic::projectFourVect
void projectFourVect(double const pos[4], double u1[4], double const u2[4]) const
project u1 orthogonally to u2 at pos
Gyoto::Metric::Generic::nullifyCoord
virtual void nullifyCoord(double coord[8]) const
Set tdot (coord[4]) such that coord is light-like. Everything is in geometrical units.
Gyoto::Metric::Generic::addFourVect
void addFourVect(double u1[4], double const u2[4]) const
add second vector to first one
GyotoRegister.h
Gyoto registers.
GyotoAstrobj.h
Astronomical objects (light emitters)
Gyoto::Metric::Generic::delta_min_
double delta_min_
Minimum integration step for the adaptive integrator.
Definition: GyotoMetric.h:170
Gyoto::Metric::Generic::keplerian
bool keplerian() const
Get keplerian_.
Gyoto::Metric::Register
void Register(std::string kind, Gyoto::Metric::Subcontractor_t *scp)
Make a Metric kind known to the Factory.
Gyoto::Metric::Generic::dualOneForm
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.
Gyoto::Metric::Generic::coordKind
int coordKind() const
Get coordinate kind.
Gyoto::Metric::Generic::isStopCondition
virtual int isStopCondition(double const coord[8]) const
Check whether integration should stop.
Gyoto::Metric::Generic::observerTetrad
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.
Gyoto::Metric::Generic::getSpecificAngularMomentum
virtual double getSpecificAngularMomentum(double rr) const
Gyoto::Metric::Subcontractor_t
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
Gyoto::Metric::Generic::keplerian_
bool keplerian_
1 if circularVelocity should return the Newtonian Keplerian velocity, in r^-3/2
Definition: GyotoMetric.h:187
Gyoto::Metric::Generic::normalizeFourVel
virtual void normalizeFourVel(double coord[8]) const
Normalize fourvelvel to -1.
Gyoto::Metric::Register_
Register::Entry * Register_
The Metric register.
Gyoto::Metric::Generic::gmunu
virtual double gmunu(double const x[4], int mu, int nu) const
Metric coefficients.
Gyoto::Metric::getSubcontractor
Gyoto::Metric::Subcontractor_t * getSubcontractor(std::string name, std::vector< std::string > &plugin, int errmode=0)
Query the Metric register.
Gyoto::Metric::Generic::christoffel
virtual double christoffel(const double coord[4], const int alpha, const int mu, const int nu) const
Chistoffel symbol.
GyotoDefs.h
Gyoto ubiquitous macros and typedefs.
Gyoto::Metric::Generic::deltaMaxOverR
double deltaMaxOverR() const
Get delta_max_over_r_.
GyotoObject.h
Introspectable objects.
Gyoto::Metric::Generic
Base class for metrics.
Definition: GyotoMetric.h:158
Gyoto::Metric::Generic::myrk4_adaptive
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.
Gyoto::Metric::Generic::delta_max_over_r_
double delta_max_over_r_
Numerical tuning parameter.
Definition: GyotoMetric.h:185
Gyoto::Metric::Generic::norm
double norm(const double pos[4], const double u1[4]) const
Scalar product.
Gyoto::Register::Entry
Entry in a register (or a full register)
Definition: GyotoRegister.h:117
Gyoto
Namespace for the Gyoto library.
Definition: GyotoAstrobj.h:43
Gyoto::Metric::Generic::deltaMin
double deltaMin() const
Gyoto::Metric::Generic::kind
const std::string kind() const
Get kind_.
Gyoto::Metric::Generic::SysPrimeToTdot
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.
Gyoto::SmartPointer
Pointers performing reference counting.
Definition: GyotoProperty.h:45
Gyoto::Metric::Generic::ScalarProd
virtual double ScalarProd(const double pos[4], const double u1[4], const double u2[4]) const
Scalar product.
Gyoto::Hook::Teller
Listen to me and I'll warn you when I change.
Definition: GyotoHooks.h:82
Gyoto::Metric::Generic::cartesianVelocity
virtual void cartesianVelocity(double const coord[8], double vel[3])
Compute xprime, yprime and zprime from 8-coordinates.
Gyoto::Metric::Generic::myrk4
virtual int myrk4(Worldline *line, state_t const &coord, double h, state_t &res) const
RK4 integrator.
GyotoHooks.h
Tellers tell Listeners when they mutate.
Gyoto::Metric::Generic::mass_
double mass_
Mass yielding geometrical unit (in kg).
Definition: GyotoMetric.h:166
Gyoto::Metric::Generic::unitLength
double unitLength() const
M * G / c^2, M is in kg, unitLength in meters.
Gyoto::Metric::Generic::getPotential
virtual double getPotential(double const pos[4], double l_cst) const
Gyoto::Metric::Generic::GramSchmidt
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.
Gyoto::Metric::Generic::diff
virtual int diff(state_t const &x, state_t &dxdt) const
F function such as dx/dt=F(x,cst)
Gyoto::Metric::Generic::getRms
virtual double getRms() const
Gyoto::Metric::Generic::setParticleProperties
virtual void setParticleProperties(Gyoto::Worldline *line, double const coord[8]) const
Set Metric-specific constants of motion. Used e.g. in KerrBL.
Gyoto::SmartPointee
Can be pointed to by a SmartPointer.
Definition: GyotoSmartPointer.h:80
Gyoto::Metric::Generic::getRmb
virtual double getRmb() const
Gyoto::Metric::Generic::multiplyFourVect
void multiplyFourVect(double vect[4], double a) const
multiply vector by scalar
Gyoto::Metric::Generic::deltaMax
double deltaMax() const
Gyoto::Metric::Generic::clone
virtual Generic * clone() const
Virtual copy constructor.
Gyoto::Metric::Generic::circularVelocity
virtual void circularVelocity(double const pos[4], double vel[4], double dir=1.) const
Yield circular velocity at a given position.