SpECTRE  v2026.09.05
Loading...
Searching...
No Matches
gr::surfaces::Tags::DimensionfulSpinVectorCompute< MeasurementFrame, MetricDataFrame > Struct Template Reference

Computes the dimensionful spin angular momentum vector. More...

#include <Tags.hpp>

Public Types

using base = DimensionfulSpinVector<MeasurementFrame>
using return_type = std::array<double, 3>
using argument_tags
Public Types inherited from gr::surfaces::Tags::DimensionfulSpinVector< MeasurementFrame >
using type

Static Public Attributes

static constexpr auto function

Detailed Description

template<typename MeasurementFrame, typename MetricDataFrame>
struct gr::surfaces::Tags::DimensionfulSpinVectorCompute< MeasurementFrame, MetricDataFrame >

Computes the dimensionful spin angular momentum vector.

Member Typedef Documentation

◆ argument_tags

template<typename MeasurementFrame, typename MetricDataFrame>
using gr::surfaces::Tags::DimensionfulSpinVectorCompute< MeasurementFrame, MetricDataFrame >::argument_tags
Initial value:
tmpl::list<DimensionfulSpinMagnitude, AreaElement<MetricDataFrame>,
The spin function is proportional to the imaginary part of the Strahlkorper’s complex scalar curvatur...
Definition Tags.hpp:396
CartesianCoords(i) is , the vector of coordinates of each point on the surface.
Definition Tags.hpp:182
Ricci scalar is the two-dimensional intrinsic Ricci scalar curvature of a Strahlkorper.
Definition Tags.hpp:151
Tag referring to a ylm::Strahlkorper
Definition Tags.hpp:29

Member Data Documentation

◆ function

template<typename MeasurementFrame, typename MetricDataFrame>
auto gr::surfaces::Tags::DimensionfulSpinVectorCompute< MeasurementFrame, MetricDataFrame >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
const tnsr::I<DataVector, 3, MeasurementFrame>&)>(
Require a pointer to not be a nullptr
Definition Gsl.hpp:197
A star-shaped surface expanded in spherical harmonics.
Definition Strahlkorper.hpp:36
void spin_vector(const gsl::not_null< std::array< double, 3 > * > result, double spin_magnitude, const Scalar< DataVector > &area_element, const Scalar< DataVector > &ricci_scalar, const Scalar< DataVector > &spin_function, const ylm::Strahlkorper< MetricDataFrame > &strahlkorper, const tnsr::I< DataVector, 3, MeasurementFrame > &measurement_frame_coords)
Spin vector 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