/usr/include/Gyoto/GyotoKerrKS.h is in libgyoto1-dev 0.1.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 | /**
* \file GyotoKerrKS.h
* \brief KerrKS metric
*
*/
/*
Copyright 2011 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 __GyotoKerrKS_H_
#define __GyotoKerrKS_H_
namespace Gyoto {
namespace Metric { class KerrKS; }
}
#include <GyotoMetric.h>
#include <GyotoWorldline.h>
#ifdef GYOTO_USE_XERCES
#include <GyotoRegister.h>
#endif
/**
* \class Gyoto::Metric::KerrKS
* \brief Metric around a Kerr black-hole in Kerr-Schild coordinates
*/
class Gyoto::Metric::KerrKS : public Metric::Generic {
friend class Gyoto::SmartPointer<Gyoto::Metric::KerrKS>;
// Data :
// -----
protected:
double spin_ ; ///< Angular momentum parameter
// Constructors - Destructor
// -------------------------
public:
KerrKS(); ///< Default constructor
KerrKS(double spin, double mass) ; ///< Constructor with spin and mass specification
// Default is fine
// KerrKS(const KerrKS& ) ;
virtual KerrKS* clone () const; ///< Copy constructor
virtual ~KerrKS() ; ///< Destructor
// Mutators / assignment
// ---------------------
public:
// default operator= is fine
void setSpin(const double spin); ///< Set spin
// Accessors
// ---------
public:
double getSpin() const ; ///< Returns spin
double gmunu(const double * x,
int alpha, int beta) const ;
/*
it's necessary to define christoffel even if it's not used. KerrKS derives from Metric where christoffel is virtual pure. If the function is not defined in KerrKS, it's considered virtual pure here too. Then KerrKS is considered an abstract class, and it's forbidden to declare any object of type KerrKS....
See Delannoy C++ p.317-318
NB : and it's not necessary to declare "virtual" a function in a derived class if it has been declared "virtual" in the basis class.
*/
double christoffel(const double[8],
const int, const int, const int) const;
void nullifyCoord(double coord[8], double &tdot2) const;
void nullifyCoord(double coord[8]) const;
virtual void circularVelocity(double const pos[4], double vel [4],
double dir=1.) const ;
virtual void setParameter(std::string, std::string, std::string);
#ifdef GYOTO_USE_XERCES
virtual void fillElement(FactoryMessenger *fmp);
#endif
public:
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.
protected:
/**
* \brief RK4 integrator
*
* Wrapper around myrk4(const double * coord, const double* cst , double h, double* res) const
*
*
*/
int myrk4(Worldline * line, const double coord[8], double h, double res[8]) const;//NB non adaptive integration doesn't work for KS ; this function is not implemented
/**
* \brief RK4 integrator
* \param coord [r,theta,phi,t,pr,ptheta]
* \param cst [a,E,L,Q],dy/dtau=F(y,cst)
* \param h proper time step.
* \param res result
*/
int myrk4(const double * coord, const double* cst , double h, double* res) const;
/**
* \brief ?
*
* Is it ever called?
*/
int myrk4_adaptive(Gyoto::Worldline* line, const double * coord, double lastnorm, double normref, double* coord1, double h0, double& h1) const;
/** F function such as dy/dtau=F(y,cst)
*/
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;
};
#endif
|