GyotoHayward.h

Go to the documentation of this file.

/*
    Copyright 2018 Frederic Lamy, Frederic Vincent, Thibaut Paumard

    This file is part of Gyoto.

    Gyoto is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    Gyoto is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with Gyoto.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __GyotoHayward_H_
#define __GyotoHayward_H_ 

namespace Gyoto {
  namespace Metric { class Hayward; }
}

#include <GyotoMetric.h>
#include <GyotoWorldline.h>

#ifdef GYOTO_USE_XERCES
#include <GyotoRegister.h>
#endif


class Gyoto::Metric::Hayward : public Metric::Generic {
  friend class Gyoto::SmartPointer<Gyoto::Metric::Hayward>;
  
  // Data : 
  // -----
 protected:
  double charge_; 
  double spin_ ;  
  double a2_ ; 
  double a3_ ; 
  double a4_ ; 
  double b2_; 
  
  // Constructors - Destructor
  // -------------------------
 public: 
  GYOTO_OBJECT;
  Hayward(); 
  virtual Hayward * clone () const ;

  // Accessors
  // ---------
  void spin(const double spin); 
  double spin() const ; 
  void charge(const double charge); 
  double charge() const ; 

  // Methods needed for PolishDoughnut
  virtual double getSpecificAngularMomentum(double rr) const;
  virtual double getPotential(double const pos[4], double l_cst) const;

  // Keplerian equatorial orbits angular velocity
  virtual void circularVelocity(double const coor[4], double vel[4],
                                  double dir) const;

  // Actual space-time API
  void gmunu(double ARGOUT_ARRAY2[4][4], const double IN_ARRAY1[4]) const ;
  double gmunu(double const x[4], int mu, int nu) const ;
  void gmunu_up(double ARGOUT_ARRAY2[4][4], const double IN_ARRAY1[4]) const ;
  double gmunu_up(double const x[4], int mu, int nu) const ;
  using Generic::christoffel;
  int christoffel(double dst[4][4][4], const double pos[4]) const ;
  
  // Optimized
  double ScalarProd(const double pos[4],
                    const double u1[4], const double u2[4]) const ;

};

#endif