SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
gr::surfaces::Tags::SpinFunctionCompute< Frame > Struct Template Reference

Calculates the spin function which is proportional to the imaginary part of the Strahlkorper’s complex scalar curvature. More...

#include <Tags.hpp>

Public Types

using base = SpinFunction
using argument_tags
using return_type = Scalar<DataVector>
Public Types inherited from gr::surfaces::Tags::SpinFunction
using type = Scalar<DataVector>

Static Public Attributes

static constexpr auto function

Detailed Description

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

Calculates the spin function which is proportional to the imaginary part of the Strahlkorper’s complex scalar curvature.

Member Typedef Documentation

◆ argument_tags

template<typename Frame>
using gr::surfaces::Tags::SpinFunctionCompute< Frame >::argument_tags
Initial value:
tmpl::list<ylm::Tags::Tangents<Frame>, ylm::Tags::Strahlkorper<Frame>,
Definition Tags.hpp:139
Computes the area element on a Strahlkorper. Useful for integrals.
Definition Tags.hpp:308
Tag referring to a ylm::Strahlkorper
Definition Tags.hpp:29
UnitNormalVector is defined as , where is the unit normal one form and is the inverse spatial metri...
Definition Tags.hpp:84

Member Data Documentation

◆ function

template<typename Frame>
auto gr::surfaces::Tags::SpinFunctionCompute< Frame >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
const ylm::Tags::aliases::Jacobian<Frame>&,
const ylm::Strahlkorper<Frame>&, const tnsr::I<DataVector, 3, Frame>&,
const Scalar<DataVector>&, const tnsr::ii<DataVector, 3, Frame>&)>(
Require a pointer to not be a nullptr
Definition Gsl.hpp:197
A star-shaped surface expanded in spherical harmonics.
Definition Strahlkorper.hpp:34
void spin_function(gsl::not_null< Scalar< DataVector > * > result, const ylm::Tags::aliases::Jacobian< Frame > &tangents, const ylm::Strahlkorper< Frame > &strahlkorper, const tnsr::I< DataVector, 3, Frame > &unit_normal_vector, const Scalar< DataVector > &area_element, const tnsr::ii< DataVector, 3, Frame > &extrinsic_curvature)
Spin function of a 2D Strahlkorper.
Tensor< T, Symmetry<>, index_list<> > Scalar
Scalar type.
Definition TypeAliases.hpp:21

The documentation for this struct was generated from the following file:
  • src/PointwiseFunctions/GeneralRelativity/Surfaces/Tags.hpp