SpECTRE  v2024.04.12
Tags::NonEuclideanMagnitude< Tag, MetricTag > Struct Template Reference

The magnitude of a (co)vector with respect to a specific metric. More...

#include <Magnitude.hpp>

Public Types

using base = Magnitude< Tag >
 
using return_type = typename base::type
 
using argument_tags = tmpl::list< Tag, MetricTag >
 
- Public Types inherited from Tags::Magnitude< Tag >
using tag = Tag
 
using type = Scalar< DataVector >
 

Static Public Attributes

static constexpr auto function
 

Detailed Description

template<typename Tag, typename MetricTag>
struct Tags::NonEuclideanMagnitude< Tag, MetricTag >

The magnitude of a (co)vector with respect to a specific metric.

This tag inherits from Tags::Magnitude<Tag>

Member Data Documentation

◆ function

template<typename Tag , typename MetricTag >
constexpr auto Tags::NonEuclideanMagnitude< Tag, MetricTag >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
const gsl::not_null<return_type*>, const typename Tag::type&,
const typename MetricTag::type&)>(&magnitude)
Require a pointer to not be a nullptr
Definition: Gsl.hpp:183
Scalar< DataType > magnitude(const Tensor< DataType, Symmetry< 1 >, index_list< Index > > &vector)
Compute the Euclidean magnitude of a rank-1 tensor.
Definition: Magnitude.hpp:27

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