SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
CurvedScalarWave::Worldtube::PunctureField::Kerr Struct Reference

Use the Kerr puncture field model. This option is currently parsed but not yet implemented at runtime. More...

#include <PunctureField.hpp>

Classes

struct  BlackHoleMass
 The mass of the central black hole. More...
struct  ExpansionOrder
 Puncture field expansion order. Currently orders 0 and 1 are implemented. More...
struct  SpinAlongZAxis
 The dimensionless z-component of the black-hole spin. More...

Public Types

using type = Kerr
using options = tmpl::list<ExpansionOrder, BlackHoleMass, SpinAlongZAxis>

Public Member Functions

 Kerr (size_t expansion_order_in, double black_hole_mass_in, double spin_along_z_axis_in, const Options::Context &context={})

Public Attributes

size_t expansion_order {}
double black_hole_mass {}
double spin_along_z_axis {}

Static Public Attributes

static constexpr Options::String help

Detailed Description

Use the Kerr puncture field model. This option is currently parsed but not yet implemented at runtime.

Member Data Documentation

◆ help

Options::String CurvedScalarWave::Worldtube::PunctureField::Kerr::help
staticconstexpr
Initial value:
= {
"Use the Kerr puncture field model. This option is currently parsed "
"but not yet implemented at runtime."}

The documentation for this struct was generated from the following file:
  • src/Evolution/Systems/CurvedScalarWave/Worldtube/PunctureField.hpp