/usr/include/lorene/C++/Include/compobj.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 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 | /*
* Definition of Lorene class Compobj, Compobj_QI, Star_QI, Kerr_QI, AltBH_QI, HiggsMonopole, ScalarBH
*
*/
/*
* Copyright (c) 2012, 2013 Claire Some, Eric Gourgoulhon
*
* 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 __COMPOBJ_H_
#define __COMPOBJ_H_
/*
* $Id: compobj.h,v 1.20 2015/11/05 17:31:21 f_vincent Exp $
* $Log: compobj.h,v $
* Revision 1.20 2015/11/05 17:31:21 f_vincent
* Updated class scalarBH.
*
* Revision 1.19 2015/10/22 09:18:35 f_vincent
* New class ScalarBH
*
* Revision 1.18 2014/10/13 08:52:33 j_novak
* Lorene classes and functions now belong to the namespace Lorene.
*
* Revision 1.17 2014/05/16 11:55:19 o_straub
* fixed: GYOTO output from compobj & compobj_QI
*
* Revision 1.16 2014/01/31 15:34:54 e_gourgoulhon
* Added members to class HiggsMonopole
*
* Revision 1.15 2014/01/29 16:29:16 e_gourgoulhon
* Added new class HiggsMonopole
*
* Revision 1.14 2014/01/14 20:53:39 e_gourgoulhon
* Updated documentation of r_isco
*
* Revision 1.13 2013/07/25 19:44:45 o_straub
* calculation of the marginally bound radius
*
* Revision 1.12 2013/04/17 13:01:50 e_gourgoulhon
* Some modifications in the class AltBH_QI
*
* Revision 1.11 2013/04/16 15:26:45 e_gourgoulhon
* Added class AltBH_QI
*
* Revision 1.10 2013/04/04 15:31:34 e_gourgoulhon
* r_isco returns now the coordinate r, not the areal r
*
* Revision 1.9 2013/04/03 12:08:57 e_gourgoulhon
* Added member kk to Compobj; suppressed tkij
*
* Revision 1.8 2013/04/02 23:17:18 e_gourgoulhon
* New class Kerr_QI
*
* Revision 1.7 2012/12/03 15:26:14 c_some
* Added data member m2
*
* Revision 1.6 2012/11/22 16:02:18 c_some
* *** empty log message ***
*
* Revision 1.5 2012/11/21 14:52:13 c_some
* Documentation corrected
*
* Revision 1.4 2012/11/20 16:21:16 c_some
* Added new class Star_QI
*
* Revision 1.3 2012/11/16 16:13:12 c_some
* Added new class Compobj_QI
*
* Revision 1.2 2012/11/15 20:50:41 e_gourgoulhon
* Corrected the documentation
*
* Revision 1.1 2012/11/15 16:20:51 c_some
* New class Compobj
*
*
* $Header: /cvsroot/Lorene/C++/Include/compobj.h,v 1.20 2015/11/05 17:31:21 f_vincent Exp $
*
*/
// Headers Lorene
#include "tensor.h"
#include "metric.h"
//---------------------------//
// base class Compobj //
//---------------------------//
namespace Lorene {
/**
* Base class for stationary compact objects (***under development***).
* \ingroup(compactobjects)
*
* A \c Compobj describes a single compact object (star or black hole), in a stationary state.
*
* The spacetime metric is written according to the 3+1 formalism :
* \f[
* ds^2 = - N^2 dt^2 + \gamma_{ij} ( dx^i + \beta^i dt )
* (dx^j + \beta^j dt )
* \f]
* where \f$\gamma_{ij}\f$ is the 3-metric, described by a Lorene object of class \c Metric.
*
* The total energy-momentum tensor is orthogonally split with respect to the Eulerian observer as follows:
* \f[
* T_{\alpha\beta} = E n_\alpha n_\beta + P_\alpha n_\beta + n_\alpha P_\beta + S_{\alpha\beta}
* \f]
*/
class Compobj {
// Data :
// -----
protected:
/// Mapping describing the coordinate system (r,theta,phi)
Map& mp ;
/// Lapse function \e N .
Scalar nn ;
/// Shift vector \f$\beta^i\f$
Vector beta ;
/// 3-metric \f$\gamma_{ij}\f$
Metric gamma ;
/// Total energy density \e E in the Eulerian frame
Scalar ener_euler ;
/// Total 3-momentum density \f$P^i\f$ in the Eulerian frame
Vector mom_euler ;
/// Stress tensor \f$S_{ij}\f$ with respect to the Eulerian observer
Sym_tensor stress_euler ;
/// Extrinsic curvature tensor \f$K_{ij}\f$
Sym_tensor kk ;
// Derived data :
// ------------
protected:
mutable double* p_adm_mass ; ///< ADM mass
// Constructors - Destructor
// -------------------------
public:
/** Standard constructor.
*
* @param mp_i Mapping on which the object is defined
*
*/
Compobj(Map& map_i) ;
Compobj(const Compobj& ) ; ///< Copy constructor
/** Constructor from a file (see \c sauve(FILE* )).
*
* @param mp_i Mapping on which the object is defined
* @param fich input file (must have been created by the function
* \c sauve)
*/
Compobj(Map& map_i, FILE* ) ;
virtual ~Compobj() ; ///< Destructor
// Memory management
// -----------------
protected:
/// Deletes all the derived quantities
virtual 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 Compobj
void operator=(const Compobj&) ;
/// Read/write of the mapping
Map& set_mp() {return mp; } ;
// Accessors
// ---------
public:
/// Returns the mapping
const Map& get_mp() const {return mp; } ;
/// Returns the lapse function \e N .
const Scalar& get_nn() const {return nn;} ;
/// Returns the shift vector \f$\beta^i\f$.
const Vector& get_beta() const {return beta;} ;
/// Returns the 3-metric \f$\gamma_{ij}\f$.
const Metric& get_gamma() const {return gamma;} ;
/// Returns the total energy density \e E in the Eulerian frame
const Scalar& get_ener_euler() const {return ener_euler;} ;
/// Returns the total 3-momentum density \f$P^i\f$ in the Eulerian frame
const Vector& get_mom_euler() const {return mom_euler;} ;
/// Returns the stress tensor \f$S_{ij}\f$ with respect to the Eulerian observer
const Sym_tensor& get_stress_euler() const {return stress_euler;} ;
/// Returns the extrinsic curvature tensor \f$K_{ij}\f$
const Sym_tensor& get_kk() const {return kk;} ;
// Outputs
// -------
public:
virtual void sauve(FILE *) const ; ///< Save in a file
void gyoto_data(const char* file_name) const ; ///< Save in a file for GYOTO
/// Display
friend ostream& operator<<(ostream& , const Compobj& ) ;
protected:
/// Operator >> (virtual function called by the operator <<).
virtual ostream& operator>>(ostream& ) const ;
// Computational methods
// ---------------------
public:
/// Computation of the extrinsic curvature
virtual void extrinsic_curvature() ;
// Global quantities
// -----------------
public:
/// ADM mass (computed as a surface integral at spatial infinity)
virtual double adm_mass() const ;
};
//---------------------------//
// base class Compobj_QI //
//---------------------------//
/**
* Base class for axisymmetric stationary compact objects in Quasi-Isotropic coordinates (***under development***).
* \ingroup(compactobjects)
*
* The metric is expressed in Quasi-Isotropic (QI) coordinates :
* \f[
* ds^2 = - N^2 dt^2 + A^2 (dr^2 + r^2 d\theta^2)
* + B^2 r^2 \sin^2\theta (d\varphi - N^\varphi dt)^2
* \f]
*
*
*/
class Compobj_QI : public Compobj {
// Data :
// -----
protected:
/// Square of the metric factor \e A
Scalar a_car ;
/// Metric factor \e B
Scalar bbb ;
/// Square of the metric factor \e B
Scalar b_car ;
/// Metric coefficient \f$N^\varphi\f$
Scalar nphi ;
/** Scalar \f$A^2 K_{ij} K^{ij}\f$.
* For axisymmetric stars, this quantity is related to the
* derivatives of \f$N^\varphi\f$ by
* \f[
* A^2 K_{ij} K^{ij} = {B^2 \over 2 N^2} \, r^2\sin^2\theta \,
* \left[ \left( {\partial N^\varphi \over \partial r} \right) ^2
* + {1\over r^2} \left( {\partial N^\varphi \over
* \partial \theta} \right) ^2 \right] \ .
* \f]
* In particular it is related to the quantities \f$k_1\f$ and \f$k_2\f$
* introduced by Eqs.~(3.7) and (3.8) of
* Bonazzola et al. \a Astron. \a Astrophys. \b 278 , 421 (1993)
* by
* \f[
* A^2 K_{ij} K^{ij} = 2 A^2 (k_1^2 + k_2^2) \ .
* \f]
*/
Scalar ak_car ;
// Derived data :
// ------------
protected:
mutable double* p_angu_mom ; ///< Angular momentum
mutable double* p_r_isco ; ///< Coordinate r of the ISCO
mutable double* p_f_isco ; ///< Orbital frequency of the ISCO
/// Specific energy of a particle at the ISCO
mutable double* p_espec_isco ;
/// Specific angular momentum of a particle at the ISCO
mutable double* p_lspec_isco ;
mutable double* p_r_mb ; ///< Coordinate r of the marginally bound orbit
// Constructors - Destructor
// -------------------------
public:
/** Standard constructor.
*
* @param mp_i Mapping on which the object is defined
*
*/
Compobj_QI(Map& map_i) ;
Compobj_QI(const Compobj_QI& ) ; ///< Copy constructor
/** Constructor from a file (see \c sauve(FILE* )).
*
* @param mp_i Mapping on which the object is defined
* @param fich input file (must have been created by the function
* \c sauve)
*/
Compobj_QI(Map& map_i, FILE* ) ;
virtual ~Compobj_QI() ; ///< Destructor
// Memory management
// -----------------
protected:
/// Deletes all the derived quantities
virtual 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 Compobj_QI
void operator=(const Compobj_QI&) ;
// Accessors
// ---------
public:
/// Returns the metric factor \e B
const Scalar& get_bbb() const {return bbb;} ;
/// Returns the square of the metric factor \e A
const Scalar& get_a_car() const {return a_car;} ;
/// Returns the square of the metric factor \e B
const Scalar& get_b_car() const {return b_car;} ;
/// Returns the metric coefficient \f$N^\varphi\f$
const Scalar& get_nphi() const {return nphi;} ;
/** Returns the scalar \f$A^2 K_{ij} K^{ij}\f$.
* For axisymmetric stars, this quantity is related to the
* derivatives of \f$N^\varphi\f$ by
* \f[
* A^2 K_{ij} K^{ij} = {B^2 \over 2 N^2} \, r^2\sin^2\theta \,
* \left[ \left( {\partial N^\varphi \over \partial r} \right) ^2
* + {1\over r^2} \left( {\partial N^\varphi \over
* \partial \theta} \right) ^2 \right] \ .
* \f]
* In particular it is related to the quantities \f$k_1\f$ and \f$k_2\f$
* introduced by Eqs. (3.7) and (3.8) of
* Bonazzola et al. \a Astron. \a Astrophys. \b 278 , 421 (1993)
* by
* \f[
* A^2 K_{ij} K^{ij} = 2 A^2 (k_1^2 + k_2^2) \ .
* \f]
*/
const Scalar& get_ak_car() const {return ak_car;} ;
// Outputs
// -------
public:
virtual void sauve(FILE *) const ; ///< Save in a file
void gyoto_data(const char* file_name) const ; ///< Save in a file for GYOTO
protected:
/// Operator >> (virtual function called by the operator <<).
virtual ostream& operator>>(ostream& ) const ;
// Global quantities
// -----------------
public:
virtual double angu_mom() const ; ///< Angular momentum
/** Coordinate r of the innermost stable circular orbit (ISCO).
*
* @param lmin index of the innermost domain in which the ISCO is searched:
* the ISCO is searched inwards from the last but one domain to
* the domain of index lmin.
* @param ost output stream to give details of the computation;
* if set to 0x0 [default value], no details will be
* given.
*
*/
virtual double r_isco(int lmin, ostream* ost = 0x0) const ;
/// Orbital frequency at the innermost stable circular orbit (ISCO).
virtual double f_isco(int lmin) const ;
/// Energy of a particle at the ISCO
virtual double espec_isco(int lmin) const ;
/// Angular momentum of a particle at the ISCO
virtual double lspec_isco(int lmin) const ;
/// Coordinate r of the marginally bound circular orbit (R_mb).
virtual double r_mb(int lmin, ostream* ost = 0x0) const ;
// Computational routines
// ----------------------
/** Updates the 3-metric \f$\gamma_{ij}\f$ from \e A and \e B
* and the shift vector \f$\beta^i\f$ from \f$N^\phi\f$.
*
*/
virtual void update_metric() ;
/** Computes the extrinsic curvature and \c ak_car from
* \c nphi , \c nn and \c b_car .
*/
virtual void extrinsic_curvature() ;
};
//--------------------------//
// base class Star_QI //
//--------------------------//
/**
*Base class for axisymmetric stationary compact stars in Quasi-Isotropic coordinates (***under development***).
* \ingroup(compactobjects)
*
* The time slice \f$t=\mathrm{const}\f$ has the topology of \f$R^3\f$
* and the metric is expressed in Quasi-Isotropic (QI) coordinates :
* \f[
* ds^2 = - N^2 dt^2 + A^2 (dr^2 + r^2 d\theta^2)
* + B^2 r^2 \sin^2\theta (d\varphi - N^\varphi dt)^2
* \f]
*
*
*/
class Star_QI : public Compobj_QI {
// Data :
// -----
protected:
/** Logarithm of the lapse \e N .
*/
Scalar logn ;
/** Component \f$\tilde N^\varphi = N^\varphi r\sin\theta\f$ of the
* shift vector
*/
Scalar tnphi ;
/** Part of the Metric potential \f$\nu = \ln N\f$ = \c logn
* generated by the matter terms
*/
Scalar nuf ;
/** Part of the Metric potential \f$\nu = \ln N\f$ = \c logn
* generated by the quadratic terms
*/
Scalar nuq ;
/// Metric potential \f$\zeta = \ln(AN)\f$
Scalar dzeta ;
/// Metric potential \f$\tilde G = (NB-1) r\sin\theta\f$
Scalar tggg ;
/** Vector \f$W^i\f$ used in the decomposition of \c shift ,
* following Shibata's prescription
* [\a Prog. \a Theor. \a Phys. \b 101 , 1199 (1999)] :
* \f[
* N^i = {7\over 8} W^i - {1\over 8}
* \left(\nabla^i\chi+\nabla^iW^kx_k\right)
* \f]
* NB: \c w_shift contains the components of \f$W^i\f$
* with respect to the Cartesian triad associated with the
* mapping \c mp .
*/
Vector w_shift ;
/** Scalar \f$\chi\f$ used in the decomposition of \c shift ,
* following Shibata's prescription
* [\a Prog. \a Theor. \a Phys. \b 101 , 1199 (1999)] :
* \f[
* N^i = {7\over 8} W^i - {1\over 8}
* \left(\nabla^i\chi+\nabla^iW^kx_k\right)
* \f]
*/
Scalar khi_shift ;
/** Effective source at the previous step for the resolution of
* the Poisson equation for \c nuf by means of
* \c Map_et::poisson .
*/
Scalar ssjm1_nuf ;
/** Effective source at the previous step for the resolution of
* the Poisson equation for \c nuq by means of
* \c Map_et::poisson .
*/
Scalar ssjm1_nuq ;
/** Effective source at the previous step for the resolution of
* the Poisson equation for \c dzeta .
*/
Scalar ssjm1_dzeta ;
/** Effective source at the previous step for the resolution of
* the Poisson equation for \c tggg .
*/
Scalar ssjm1_tggg ;
/** Effective source at the previous step for the resolution of
* the Poisson equation for the scalar \f$\chi\f$ by means of
* \c Map_et::poisson .
* \f$\chi\f$ is an intermediate quantity for the resolution of the
* elliptic equation for the shift vector \f$N^i\f$
*/
Scalar ssjm1_khi ;
/** Effective source at the previous step for the resolution of
* the vector Poisson equation for \f$W^i\f$.
* \f$W^i\f$ is an intermediate quantity for the resolution of the
* elliptic equation for the shift vector \f$N^i\f$
* (Components with respect to the Cartesian triad associated with
* the mapping \c mp )
*/
Vector ssjm1_wshift ;
// Derived data :
// ------------
protected:
mutable double* p_grv2 ; ///< Error on the virial identity GRV2
mutable double* p_grv3 ; ///< Error on the virial identity GRV3
mutable double* p_mom_quad ; ///< Quadrupole moment
mutable double* p_mass_g ; ///< Gravitational mass (ADM mass as a volume integral)
// Constructors - Destructor
// -------------------------
public:
/** Standard constructor.
*
* @param mp_i Mapping on which the star is contructed
*
*/
Star_QI(Map& mp_i) ;
Star_QI(const Star_QI& ) ; ///< Copy constructor
/** Constructor from a file (see \c sauve(FILE*) ).
*
* @param mp_i Mapping on which the star is constructed
* @param fich input file (must have been created by the function
* \c Star_QI::sauve )
*/
Star_QI(Map& mp_i, FILE* fich) ;
virtual ~Star_QI() ; ///< Destructor
// Memory management
// -----------------
protected:
/// Deletes all the derived quantities
virtual void del_deriv() const ;
/// Sets to \c 0x0 all the pointers on derived quantities
virtual void set_der_0x0() const ;
// Mutators / assignment
// ---------------------
public:
/// Assignment to another \c Star_QI
void operator=(const Star_QI& ) ;
// Accessors
// ---------
public:
/** Returns the logarithm of the lapse \e N.
*/
const Scalar& get_logn() const {return logn;} ;
/** Returns the component \f$\tilde N^\varphi = N^\varphi r\sin\theta\f$
* of the shift vector
*/
const Scalar& get_tnphi() const {return tnphi;} ;
/** Returns the part of the Metric potential \f$\nu = \ln N\f$ = \c logn
* generated by the matter terms
*/
const Scalar& get_nuf() const {return nuf;} ;
/** Returns the Part of the Metric potential \f$\nu = \ln N\f$ = \c logn
* generated by the quadratic terms
*/
const Scalar& get_nuq() const {return nuq;} ;
/// Returns the Metric potential \f$\zeta = \ln(AN)\f$
const Scalar& get_dzeta() const {return dzeta;} ;
/// Returns the Metric potential \f$\tilde G = (NB-1) r\sin\theta\f$
const Scalar& get_tggg() const {return tggg;} ;
/** Returns the vector \f$W^i\f$ used in the decomposition of
* \c shift ,
* following Shibata's prescription
* [\a Prog. \a Theor. \a Phys. \b 101 , 1199 (1999)] :
* \f[
* N^i = {7\over 8} W^i - {1\over 8}
* \left(\nabla^i\chi+\nabla^iW^kx_k\right)
* \f]
* NB: \c w_shift contains the components of \f$W^i\f$
* with respect to the Cartesian triad associated with the
* mapping \c mp .
*/
const Vector& get_w_shift() const {return w_shift;} ;
/** Returns the scalar \f$\chi\f$ used in the decomposition of
* \c shift
* following Shibata's prescription
* [\a Prog. \a Theor. \a Phys. \b 101 , 1199 (1999)] :
* \f[
* N^i = {7\over 8} W^i - {1\over 8}
* \left(\nabla^i\chi+\nabla^iW^kx_k\right)
* \f]
* NB: \c w_shift contains the components of \f$W^i\f$
* with respect to the Cartesian triad associated with the
* mapping \c mp .
*/
const Scalar& get_khi_shift() const {return khi_shift;} ;
// Outputs
// -------
public:
virtual void sauve(FILE* ) const ; ///< Save in a file
protected:
/// Operator >> (virtual function called by the operator <<).
virtual ostream& operator>>(ostream& ) const ;
// Global quantities
// -----------------
public:
virtual double mass_g() const ; ///< Gravitational mass
virtual double angu_mom() const ; ///< Angular momentum
/** Error on the virial identity GRV2.
* This indicator is only valid for relativistic computations.
*/
virtual double grv2() const ;
/** Error on the virial identity GRV3.
* The error is computed as the integral defined
* by Eq. (43) of [Gourgoulhon and Bonazzola,
* \a Class. \a Quantum \a Grav. \b 11, 443 (1994)] divided by
* the integral of the matter terms.
*
* @param ost output stream to give details of the computation;
* if set to 0x0 [default value], no details will be
* given.
*
*/
virtual double grv3(ostream* ost = 0x0) const ;
/** Quadrupole moment.
* The quadrupole moment \e Q is defined according to Eq. (7) of
* [Salgado, Bonazzola, Gourgoulhon and Haensel, \a Astron. \a Astrophys.
* \b 291 , 155 (1994)]. At the Newtonian limit it is related to
* the component \f${\bar I}_{zz}\f$ of the MTW (1973) reduced quadrupole
* moment \f${\bar I}_{ij}\f$ by: \f$Q = -3/2 {\bar I}_{zz}\f$.
* Note that \e Q is the negative of the quadrupole moment defined
* by Laarakkers and Poisson, \a Astrophys. \a J. \b 512 , 282 (1999).
*/
virtual double mom_quad() const ;
// Computational routines
// ----------------------
public:
/** Computes metric coefficients from known potentials.
*
* The calculation is performed starting from the quantities
* \c logn , \c dzeta , \c tggg and \c shift ,
* which are supposed to be up to date.
* From these, the following fields are updated:
* \c nnn , \c a_car , \c bbb and \c b_car, as well as
* the 3-metric \c gamma.
*
*/
void update_metric() ;
/** Computes \c shift from \c w_shift and \c khi_shift
* according to Shibata's prescription
* [\a Prog. \a Theor. \a Phys. \b 101 , 1199 (1999)] :
* \f[
* N^i = {7\over 8} W^i - {1\over 8}
* \left(\nabla^i\chi+\nabla^iW^kx_k\right)
* \f]
*/
void fait_shift() ;
/** Computes \c tnphi and \c nphi from the Cartesian
* components of the shift, stored in \c shift .
*/
void fait_nphi() ;
/** Computes the coefficient \f$\lambda\f$ which ensures that the
* GRV2 virial identity is satisfied.
* \f$\lambda\f$ is the coefficient by which one must multiply
* the quadratic source term \f$\sigma_q\f$ of the 2-D Poisson equation
* \f[
* \Delta_2 u = \sigma_m + \sigma_q
* \f]
* in order that the total source does not contain any monopolar term,
* i.e. in order that
* \f[
* \int_0^{2\pi} \int_0^{+\infty} \sigma(r, \theta)
* \, r \, dr \, d\theta = 0 \ ,
* \f]
* where \f$\sigma = \sigma_m + \sigma_q\f$.
* \f$\lambda\f$ is computed according to the formula
* \f[
* \lambda = - { \int_0^{2\pi} \int_0^{+\infty} \sigma_m(r, \theta)
* \, r \, dr \, d\theta \over
* \int_0^{2\pi} \int_0^{+\infty} \sigma_q(r, \theta)
* \, r \, dr \, d\theta } \ .
* \f]
* Then, by construction, the new source
* \f$\sigma' = \sigma_m + \lambda \sigma_q\f$ has a vanishing monopolar
* term.
*
* @param sou_m [input] matter source term \f$\sigma_m\f$
* @param sou_q [input] quadratic source term \f$\sigma_q\f$
* @return value of \f$\lambda\f$
*/
static double lambda_grv2(const Scalar& sou_m, const Scalar& sou_q) ;
};
//---------------------//
// class Kerr_QI //
//---------------------//
/**
* Kerr spacetime in Quasi-Isotropic coordinates (***under development***).
* \ingroup(compactobjects)
*
* The metric is expressed in Quasi-Isotropic (QI) coordinates :
* \f[
* ds^2 = - N^2 dt^2 + A^2 (dr^2 + r^2 d\theta^2)
* + B^2 r^2 \sin^2\theta (d\varphi - N^\varphi dt)^2
* \f]
*
*
*/
class Kerr_QI : public Compobj_QI {
// Data :
// -----
protected:
/** mass parameter \f$M\f$
*/
double mm ;
/** angular momentum parameter \f$a\f$
*/
double aa ;
// Derived data :
// ------------
protected:
// Constructors - Destructor
// -------------------------
public:
/** Standard constructor.
*
* @param mp_i Mapping on which the star is contructed
* @param mass Black hole mass M
* @param a_over_m Black hole reduced angular momentum a/M (dimensionless)
*
*/
Kerr_QI(Map& mp_i, double mass, double a_over_m) ;
Kerr_QI(const Kerr_QI& ) ; ///< Copy constructor
/** Constructor from a file (see \c sauve(FILE*) ).
*
* @param mp_i Mapping on which the star is constructed
* @param fich input file (must have been created by the function
* \c Kerr_QI::sauve )
*/
Kerr_QI(Map& mp_i, FILE* fich) ;
virtual ~Kerr_QI() ; ///< Destructor
// Memory management
// -----------------
protected:
/// Deletes all the derived quantities
virtual void del_deriv() const ;
/// Sets to \c 0x0 all the pointers on derived quantities
virtual void set_der_0x0() const ;
// Mutators / assignment
// ---------------------
public:
/// Assignment to another \c Kerr_QI
void operator=(const Kerr_QI& ) ;
// Accessors
// ---------
public:
// Outputs
// -------
public:
virtual void sauve(FILE* ) const ; ///< Save in a file
protected:
/// Operator >> (virtual function called by the operator <<).
virtual ostream& operator>>(ostream& ) const ;
// Global quantities
// -----------------
public:
// Computational routines
// ----------------------
public:
};
//-------------------//
// class AltBH_QI //
//-------------------//
/**
* Alternative black hole spacetime in Quasi-Isotropic coordinates (***under development***).
* \ingroup(compactobjects)
*
* The metric is expressed in Quasi-Isotropic (QI) coordinates :
* \f[
* ds^2 = - N^2 dt^2 + A^2 (dr^2 + r^2 d\theta^2)
* + B^2 r^2 \sin^2\theta (d\varphi - N^\varphi dt)^2
* \f]
*
*
*/
class AltBH_QI : public Compobj_QI {
// Data :
// -----
protected:
char description1[256] ; ///< String describing the model
char description2[256] ; ///< String describing the model
double a_spin ; ///< Spin parameter of the model
Scalar krphi ; ///< K_{(r)(phi)} read in the file
// Derived data :
// ------------
protected:
// Constructors - Destructor
// -------------------------
public:
/** Standard constructor.
*
* @param mp_i Mapping on which the star is contructed
* @param file_name Name of the file containing the metric data
* @param a_spin_i Spin parameter of the model
*
*/
AltBH_QI(Map& mp_i, const char* file_name, double a_spin_i) ;
AltBH_QI(const AltBH_QI& ) ; ///< Copy constructor
/** Constructor from a file (see \c sauve(FILE*) ).
*
* @param mp_i Mapping on which the star is constructed
* @param fich input file (must have been created by the function
* \c AltBH_QI::sauve )
*/
AltBH_QI(Map& mp_i, FILE* fich) ;
virtual ~AltBH_QI() ; ///< Destructor
// Memory management
// -----------------
protected:
/// Deletes all the derived quantities
virtual void del_deriv() const ;
/// Sets to \c 0x0 all the pointers on derived quantities
virtual void set_der_0x0() const ;
// Mutators / assignment
// ---------------------
public:
/// Assignment to another \c AltBH_QI
void operator=(const AltBH_QI& ) ;
// Accessors
// ---------
public:
/// Returns K_{(r)(phi)}/sin(theta).
const Scalar& get_krphi() const {return krphi;} ;
// Outputs
// -------
public:
virtual void sauve(FILE* ) const ; ///< Save in a file
protected:
/// Operator >> (virtual function called by the operator <<).
virtual ostream& operator>>(ostream& ) const ;
// Global quantities
// -----------------
public:
// Computational routines
// ----------------------
public:
/// Computation of the extrinsic curvature
virtual void extrinsic_curvature() ;
};
//-------------------//
// class ScalarBH //
//-------------------//
/**
* Black hole with scalar hair spacetime (***under development***).
* \ingroup(compactobjects)
*
* The metric is expressed:
* \f[
* ds^2 = copy Carlos metric
* \f]
*
*
*/
class ScalarBH : public Compobj {
// Data :
// -----
protected:
//char description1[256] ; ///< String describing the model
// char description2[256] ; ///< String describing the model
Scalar ff0 ; ///< Metric field F_0 of Herdeiro \& Radu (2015)
Scalar ff1 ; ///< Metric field F_1 of Herdeiro \& Radu (2015)
Scalar ff2 ; ///< Metric field F_2 of Herdeiro \& Radu (2015)
Scalar ww ; ///< Metric field W of Herdeiro \& Radu (2015)
Scalar sfield ; ///< Scalar field (modulus of Phi)
double rHor ; ///< Event horizon coordinate radius
// Constructors - Destructor
// -------------------------
public:
/** Standard constructor.
*
* @param mp_i Mapping on which the star is contructed
* @param file_name Name of the file containing the metric data
* @param a_spin_i Spin parameter of the model
*
*/
ScalarBH(Map& mp_i, const char* file_name) ;
ScalarBH(const ScalarBH& ) ; ///< Copy constructor
/** Constructor from a file (see \c sauve(FILE*) ).
*
* @param mp_i Mapping on which the star is constructed
* @param fich input file (must have been created by the function
* \c ScalarBH::sauve )
*/
ScalarBH(Map& mp_i, FILE* fich) ;
virtual ~ScalarBH() ; ///< Destructor
// Memory management
// -----------------
protected:
/// Deletes all the derived quantities
virtual void del_deriv() const ;
/// Sets to \c 0x0 all the pointers on derived quantities
virtual void set_der_0x0() const ;
// Mutators / assignment
// ---------------------
public:
/// Assignment to another \c ScalarBH
void operator=(const ScalarBH& ) ;
// Accessors
// ---------
public:
/// Returns f0
const Scalar& get_ff0() const {return ff0; } ;
const Scalar& get_ff1() const {return ff1; } ;
const Scalar& get_ff2() const {return ff2; } ;
const Scalar& get_ww() const {return ww; } ;
const Scalar& get_sfield() const {return sfield; } ;
const double get_rHor() const {return rHor; } ;
// Outputs
// -------
public:
virtual void sauve(FILE* ) const ; ///< Save in a file
protected:
/// Operator >> (virtual function called by the operator <<).
virtual ostream& operator>>(ostream& ) const ;
// Global quantities
// -----------------
public:
// Computational routines
// ----------------------
public:
virtual void update_metric();
};
//------------------------//
// class HiggsMonopole //
//------------------------//
/**
* Higgs monopole (***under development***).
* \ingroup(compactobjects)
*
*
*/
class HiggsMonopole : public Compobj {
// Data :
// -----
protected:
char description1[256] ; ///< String describing the model
char description2[256] ; ///< String describing the model
Scalar hh ; ///< Higgs scalar field
Scalar grr ; ///< Metric coefficient g_rr
Scalar press ; ///< Fluid pressure
// Derived data :
// ------------
protected:
// Constructors - Destructor
// -------------------------
public:
/** Standard constructor.
*
* @param mp_i Mapping on which the Higgs monopole is contructed
* @param file_name Name of the file containing the data
*
*/
HiggsMonopole(Map& mp_i, const char* file_name) ;
HiggsMonopole(const HiggsMonopole& ) ; ///< Copy constructor
virtual ~HiggsMonopole() ; ///< Destructor
// Memory management
// -----------------
protected:
/// Deletes all the derived quantities
// virtual void del_deriv() const ;
/// Sets to \c 0x0 all the pointers on derived quantities
// virtual void set_der_0x0() const ;
// Mutators / assignment
// ---------------------
public:
/// Assignment to another \c AltBH_QI
// void operator=(const AltBH_QI& ) ;
// Accessors
// ---------
public:
/// Returns Higgs field
const Scalar& get_higgs() const {return hh;} ;
/// Returns the metric coefficient g_rr
const Scalar& get_grr() const {return grr;} ;
/// Returns the fluid pressure
const Scalar& get_press() const {return press;} ;
// Outputs
// -------
public:
// virtual void sauve(FILE* ) const ; ///< Save in a file
protected:
/// Operator >> (virtual function called by the operator <<).
virtual ostream& operator>>(ostream& ) const ;
// Global quantities
// -----------------
public:
// Computational routines
// ----------------------
public:
/// Computation of the extrinsic curvature
// virtual void extrinsic_curvature() ;
};
}
#endif
|