SpECTRE Documentation Coverage Report
Current view: top level - PointwiseFunctions/GeneralRelativity/Surfaces - Mass.hpp Hit Total Coverage
Commit: 965048f86d23c819715b3af1ca3f880c8145d4bb Lines: 2 3 66.7 %
Date: 2024-05-16 17:00:40
Legend: Lines: hit not hit

          Line data    Source code
       1           0 : // Distributed under the MIT License.
       2             : // See LICENSE.txt for details.
       3             : 
       4             : #pragma once
       5             : 
       6             : namespace gr::surfaces {
       7             : /*!
       8             :  * \ingroup SurfacesGroup
       9             :  * \brief Irreducible mass of a 2D `Strahlkorper`.
      10             :  *
      11             :  * \details See Eqs. (15.38) \cite Hartle2003gravity. This function computes the
      12             :  * irreducible mass from the area of a horizon. Specifically, computes
      13             :  * \f$M_\mathrm{irr}=\sqrt{\frac{A}{16\pi}}\f$.
      14             :  */
      15           1 : double irreducible_mass(double area);
      16             : 
      17             : /*!
      18             :  * \ingroup SurfacesGroup
      19             :  * \brief Christodoulou Mass of a 2D `Strahlkorper`.
      20             :  *
      21             :  * \details See e.g. Eq. (1) of \cite Lovelace2016uwp.
      22             :  * This function computes the Christodoulou mass from the dimensionful
      23             :  * spin angular momentum \f$S\f$ and the irreducible mass \f$M_{irr}\f$
      24             :  * of a black hole horizon. Specifically, computes
      25             :  *\f$M=\sqrt{M_{irr}^2+\frac{S^2}{4M_{irr}^2}}\f$
      26             :  */
      27           1 : double christodoulou_mass(double dimensionful_spin_magnitude,
      28             :                           double irreducible_mass);
      29             : }  // namespace gr::surfaces

Generated by: LCOV version 1.14