intrp::OptionHolders::KerrHorizon Struct Reference

A surface that conforms to the horizon of a Kerr black hole in Kerr-Schild coordinates. More...

#include <KerrHorizon.hpp>

Classes
struct	AngularOrdering
struct	Center
struct	DimensionlessSpin
struct	LMax
struct	Mass

Public Types
using	options = implementation defined

Public Member Functions
	KerrHorizon (size_t l_max_in, std::array< double, 3 > center_in, double mass_in, std::array< double, 3 > dimensionless_spin_in, ylm::AngularOrdering angular_ordering_in, const Options::Context &context={})
	KerrHorizon (const KerrHorizon &)=default
KerrHorizon &	operator= (const KerrHorizon &)=delete
	KerrHorizon (KerrHorizon &&)=default
KerrHorizon &	operator= (KerrHorizon &&)=default
void	pup (PUP::er &p)

Public Attributes
size_t	l_max {}
std::array< double, 3 >	center {}
double	mass {}
std::array< double, 3 >	dimensionless_spin {}
ylm::AngularOrdering	angular_ordering

Static Public Attributes
static constexpr Options::String	help

Detailed Description

A surface that conforms to the horizon of a Kerr black hole in Kerr-Schild coordinates.

Details

In addition to the parameters for the Kerr black hole, this holder contains the LMax which encodes the angular resolution of the spherical harmonic basis and AngularOrdering which encodes the collocation ordering.

Member Data Documentation

help

constexpr Options::String intrp::OptionHolders::KerrHorizon::help

staticconstexpr

Initial value:

= {
      "A Strahlkorper conforming to the horizon (in Kerr-Schild coordinates)"
      " of a Kerr black hole with a specified center, mass, and spin."}

---

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

• src/ParallelAlgorithms/Interpolation/Targets/KerrHorizon.hpp