SpECTRE  v2024.05.11
gr::surfaces::Tags::DimensionlessSpinMagnitudeCompute< Frame > Struct Template Reference

Computes the dimensionless spin magnitude \(\chi = \frac{S}{M^2}\) from the dimensionful spin magnitude \(S\) and the christodoulou mass \(M\) of a black hole. More...

#include <Tags.hpp>

Public Types

using base = DimensionlessSpinMagnitude< Frame >
 
using return_type = double
 
using argument_tags = tmpl::list< DimensionfulSpinMagnitude, ChristodoulouMass >
 
- Public Types inherited from gr::surfaces::Tags::DimensionlessSpinMagnitude< Frame >
using type = double
 

Static Public Attributes

static constexpr auto function
 

Detailed Description

template<typename Frame>
struct gr::surfaces::Tags::DimensionlessSpinMagnitudeCompute< Frame >

Computes the dimensionless spin magnitude \(\chi = \frac{S}{M^2}\) from the dimensionful spin magnitude \(S\) and the christodoulou mass \(M\) of a black hole.

Member Data Documentation

◆ function

template<typename Frame >
constexpr auto gr::surfaces::Tags::DimensionlessSpinMagnitudeCompute< Frame >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
const gsl::not_null<double*>, const double, const double)>(
Require a pointer to not be a nullptr
Definition: Gsl.hpp:183
void dimensionless_spin_magnitude(const gsl::not_null< double * > result, const double dimensionful_spin_magnitude, const double christodoulou_mass)
Dimensionless spin magnitude of a Strahlkorper.

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