/usr/include/lorene/C++/Include/binary.h is in liblorene-dev 0.0.0~cvs20161116+dfsg-1ubuntu4.
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 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 | /*
* Definition of Lorene class Binary
*
*/
/*
* Copyright (c) 2004 Limousin Francois
*
* This file is part of LORENE.
*
* LORENE is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 2
* as published by the Free Software Foundation.
*
* LORENE 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 LORENE; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
*/
#ifndef __BINARY_H_
#define __BINARY_H_
/*
* $Id: binary.h,v 1.10 2014/10/13 08:52:32 j_novak Exp $
* $Log: binary.h,v $
* Revision 1.10 2014/10/13 08:52:32 j_novak
* Lorene classes and functions now belong to the namespace Lorene.
*
* Revision 1.9 2006/04/11 14:26:12 f_limousin
* New version of the code : improvement of the computation of some
* critical sources, estimation of the dirac gauge, helical symmetry...
*
* Revision 1.8 2005/11/08 20:17:55 f_limousin
* Add function dirac_gauge() used to impose Dirac gauge during an iteration.
*
* Revision 1.7 2005/09/15 15:56:28 e_gourgoulhon
* Made the documentation compliant with Doxygen.
*
* Revision 1.6 2005/09/13 19:38:32 f_limousin
* Reintroduction of the resolution of the equations in cartesian coordinates.
*
* Revision 1.5 2004/07/21 11:45:20 f_limousin
* Add function mass_adm_vol() to compute the ADM mass of the system
* with a volume integral instead of a surface one.
*
* Revision 1.4 2004/05/25 14:50:06 f_limousin
* Add the virial theorem for conformally flat configurations.
*
* Revision 1.3 2004/01/20 15:25:39 f_limousin
* Nex class binary
*
*
* $Header: /cvsroot/Lorene/C++/Include/binary.h,v 1.10 2014/10/13 08:52:32 j_novak Exp $
*
*/
// Lorene headers
#include "star.h"
namespace Lorene {
/**
* Binary systems. *** UNDER DEVELOPMENT *** \ingroup (star)
*
* @version #$Id: binary.h,v 1.10 2014/10/13 08:52:32 j_novak Exp $#
*/
class Binary {
// Data :
// -----
protected:
/// First star of the system
Star_bin star1 ;
/// Second star of the system
Star_bin star2 ;
/** Array of the two stars (to perform loops on the stars):
* \c et[0] contains the address of \c star1 and \c et[1]
* that of \c star2.
*/
Star_bin* et[2] ;
/** Angular velocity with respect to an asymptotically inertial
* observer
*/
double omega ;
/** Absolute X coordinate of the rotation axis
*/
double x_axe ;
// Derived data :
// ------------
protected:
/// Total ADM mass of the system
mutable double* p_mass_adm ;
/// Total Komar mass of the system
mutable double* p_mass_kom ;
/// Total angular momentum of the system
mutable Tbl* p_angu_mom ;
/// Total energy of the system
mutable double* p_total_ener ;
/// Virial theorem error
mutable double* p_virial ;
/// Relative error on the Hamiltonian constraint
mutable double* p_ham_constr ;
/// Relative error on the momentum constraint
mutable Tbl* p_mom_constr ;
// Constructors - Destructor
// -------------------------
public:
/** Standard constructor.
*
* @param mp1 Mapping on which \c star1 will be defined
* @param nzet1 Number of domains occupied by \c star1
* @param eos1 Equation of state of \c star1
* @param irrot1 should be \c true if \c star1 is irrotational,
* \c false if \c star1 is corotating
* @param mp2 Mapping on which \c star2 will be defined
* @param nzet2 Number of domains occupied by \c star2
* @param eos2 Equation of state of \c star2
* @param irrot2 should be \c true if \c star2 is irrotational,
* \c false if \c star2 is corotating
* @param conf_flat should be \c true for a 3-metric conformally
* flat and \c false for a more general one.
*/
Binary(Map& mp1, int nzet1, const Eos& eos1, int irrot1,
Map& mp2, int nzet2, const Eos& eos2, int irrot2,
int conf_flat) ;
Binary(const Binary& ) ; ///< Copy constructor
/** Constructor from a file (see \c sauve(FILE* )).
*
* @param mp1 Mapping on which \c star1 will be defined
* @param eos1 Equation of state of \c star1
* @param mp2 Mapping on which \c star2 will be defined
* @param eos2 Equation of state of \c star2
* @param fich input file (must have been created by the function
* \c sauve)
*/
Binary(Map& mp1, const Eos& eos1, Map& mp2, const Eos& eos2,
FILE* fich) ;
~Binary() ; ///< Destructor
// Memory management
// -----------------
protected:
/// Deletes all the derived quantities
void del_deriv() const ;
/// Sets to \c 0x0 all the pointers on derived quantities
void set_der_0x0() const ;
// Mutators / assignment
// ---------------------
public:
/// Assignment to another \c Binary
void operator=(const Binary&) ;
/// Read/write of the star no. i
Star_bin& set(int i)
{ assert( (i==1) || (i==2) );
del_deriv() ;
return *et[i-1] ;} ;
/// Sets the orbital angular velocity [\c f_unit]
double& set_omega() {return omega; } ;
/// Sets the absolute coordinate X of the rotation axis [\c r_unit]
double& set_x_axe() {return x_axe; } ;
// Accessors
// ---------
public:
/// Returns a reference to the star no. i
const Star_bin& operator()(int i) const
{ assert( (i==1) || (i==2) );
return *et[i-1] ;} ;
/// Returns the orbital angular velocity [\c f_unit]
double get_omega() const {return omega; } ;
/// Returns the absolute coordinate X of the rotation axis [\c r_unit]
double get_x_axe() const {return x_axe; } ;
/** Returns the coordinate separation of the two stellar
* centers [\c r_unit]
*/
double separation() const ;
// Outputs
// -------
public:
void sauve(FILE *) const ; ///< Save in a file
/// Display
friend ostream& operator<<(ostream& , const Binary& ) ;
/// Display in polytropic units
void display_poly(ostream& ) const ;
/** Write global quantities in a formatted file.
* This file can be read by an external program.
*/
void write_global(ostream& ) const ;
private:
/// Operator >> (function called by the operator <<).
ostream& operator>>(ostream& ) const ;
// Computational routines
// ----------------------
public:
/// Total ADM mass
double mass_adm() const ;
/// Total ADM mass (computed by a volume integral)
double mass_adm_vol() const ;
/// Total Komar mass
double mass_kom() const ;
/// Total Komar mass (computed by a volume integral)
double mass_kom_vol() const ;
/** Total angular momentum.
*
* @return 1-D \c Tbl of size 3, according to
* \li \c angu_mom()(0) = \f$J^r\f$,
* \li \c angu_mom()(1) = \f$J^t\f$,
* \li \c angu_mom()(2) = \f$J^p\f$.
*/
const Tbl& angu_mom() const ;
/** Total energy (excluding the rest mass energy).
*
* In the Newtonian case, it is defined as the sum of kinetic,
* internal, and gravitational potential energies.
*
* In the relativistic case, it is defined as
* \f$M_{\rm ADM} - M_{\rm bar,1} - M_{\rm bar,2}\f$.
*/
double total_ener() const ;
/** Estimates the relative error on the virial theorem
*/
double virial() const ;
/** Estimates the relative error on the Hamiltonian constraint
*/
double ham_constr() const ;
/** Estimates the relative error on the momentum constraint
*/
const Tbl& mom_constr() const ;
/** Computes the orbital angular velocity \c omega and the
* position of the rotation axis \c x_axe.
*
* @param fact_omeg_min [input] : determines the lower bound of the
* interval \c [omega_min, omega_max] in which
* \c omega is searched by
* \c omega_min = fact_omeg_min * omega,
* where \c omega is the previous value of the
* angular velocity
* (typical value : \c fact_omeg_min = 0.5)
*
* @param fact_omeg_max [input] : determines the higher bound of the
* interval \c [omega_min, omega_max] in which
* \c omega is searched by
* \c omega_max = fact_omeg_max * omega,
* where \c omega is the previous value of the
* angular velocity.
* (typical value : \c fact_omeg_max = 1.5)
*
* @param xgg1 [output] : x coordinate (relative to star 1 mapping)
* of the ``center of mass'' of star 1
*
* @param xgg2 [output] : x coordinate (relative to star 2 mapping)
* of the ``center of mass'' of star 2
*
*/
void orbit(double fact_omeg_min, double fact_omeg_max, double& xgg1,
double& xgg2) ;
/** Sets the orbital angular velocity to some 2-PN analytical
* value (Keplerian value in the Newtonian case)
*/
void analytical_omega() ;
/** Sets some analytical template for the shift vector (via the
* members \c w_shift and \c khi_shift of the two
* \c Star_bin.
*/
void analytical_shift() ;
/**
* Calculates \c decouple which is used to obtain
* \c qq_auto by the formula :
* \c qq_auto = \c decouple * \c qq.
* (see the membre \c Scalar \c decouple for more
* precisions about its value).
*
*/
void fait_decouple () ;
/// Function used to impose Dirac gauge during an iteration
void dirac_gauge() ;
/// Function testing the helical symmetry
void helical() ;
};
ostream& operator<<(ostream& , const Binary& ) ;
}
#endif
|