SpECTRE  v2022.06.14
SpinWeighted< T, Spin, is_vector > Struct Template Reference

Make a spin-weighted type T with spin-weight Spin. Mathematical operators are restricted to addition, subtraction, multiplication and division, with spin-weights checked for validity. More...

## Detailed Description

template<typename T, int Spin, bool is_vector = is_derived_of_vector_impl_v<T>>
struct SpinWeighted< T, Spin, is_vector >

Make a spin-weighted type T with spin-weight Spin. Mathematical operators are restricted to addition, subtraction, multiplication and division, with spin-weights checked for validity.

### Details

For a spin-weighted object, we limit operations to those valid for a pair of spin-weighted quantities - i.e. addition only makes sense when the two summands possess the same spin weight, and multiplication (or division) result in a summed (or subtracted) spin weight.

The documentation for this struct was generated from the following file:
• src/DataStructures/SpinWeighted.hpp