domain::creators::time_dependent_options::KerrSchildFromBoyerLindquist Struct Reference

Mass and spin necessary for calculating the \( Y_{lm} \) coefficients of a Kerr horizon of certain Boyer-Lindquist radius for the shape map of the Sphere domain creator. More...

#include <ShapeMap.hpp>

Classes
struct	Mass
	The mass of the Kerr black hole. More...
struct	Spin
	The dimensionless spin of the Kerr black hole. More...

Public Types
using	options = tmpl::list< Mass, Spin >

Public Member Functions
	KerrSchildFromBoyerLindquist (double mass_in, std::array< double, 3 > spin_in)

Public Attributes
double	mass {std::numeric_limits<double>::signaling_NaN()}
std::array< double, 3 >	spin

Static Public Attributes
static constexpr Options::String	help

Detailed Description

Mass and spin necessary for calculating the \( Y_{lm} \) coefficients of a Kerr horizon of certain Boyer-Lindquist radius for the shape map of the Sphere domain creator.

Member Data Documentation

help

constexpr Options::String domain::creators::time_dependent_options::KerrSchildFromBoyerLindquist::help

staticconstexpr

Initial value:

= {
      "Conform to an ellipsoid of constant Boyer-Lindquist radius in "
      "Kerr-Schild coordinates. This Boyer-Lindquist radius is chosen as the "
      "value of the 'InnerRadius'. To conform to the outer Kerr horizon, "
      "choose an 'InnerRadius' of r_+ = M + sqrt(M^2-a^2)."}

spin

std::array<double, 3> domain::creators::time_dependent_options::KerrSchildFromBoyerLindquist::spin

Initial value:

{std::numeric_limits<double>::signaling_NaN(),
                             std::numeric_limits<double>::signaling_NaN(),
                             std::numeric_limits<double>::signaling_NaN()}

---

The documentation for this struct was generated from the following file:

• src/Domain/Creators/TimeDependentOptions/ShapeMap.hpp