SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
gr::Tags::SpatialRicciScalarCompute< DataType, SpatialDim, Frame > Struct Template Reference

Computes the spatial Ricci scalar using the spatial Ricci tensor and the inverse spatial metric. More...

#include <Ricci.hpp>

Public Types

using argument_tags
using return_type = Scalar<DataType>
using base = SpatialRicciScalar<DataType>
Public Types inherited from gr::Tags::SpatialRicciScalar< DataType >
using type = Scalar<DataType>

Static Public Attributes

static constexpr auto function

Detailed Description

template<typename DataType, size_t SpatialDim, typename Frame>
struct gr::Tags::SpatialRicciScalarCompute< DataType, SpatialDim, Frame >

Computes the spatial Ricci scalar using the spatial Ricci tensor and the inverse spatial metric.

Can be retrieved using gr::Tags::SpatialRicciScalar

Member Typedef Documentation

◆ argument_tags

template<typename DataType, size_t SpatialDim, typename Frame>
using gr::Tags::SpatialRicciScalarCompute< DataType, SpatialDim, Frame >::argument_tags
Initial value:
tmpl::list<gr::Tags::SpatialRicci<DataType, SpatialDim, Frame>,
Inverse of the spatial metric.
Definition Tags.hpp:32

Member Data Documentation

◆ function

template<typename DataType, size_t SpatialDim, typename Frame>
auto gr::Tags::SpatialRicciScalarCompute< DataType, SpatialDim, Frame >::function
staticconstexpr
Initial value:
=
static_cast<void (*)(gsl::not_null<Scalar<DataType>*>,
const tnsr::ii<DataType, SpatialDim, Frame>&,
const tnsr::II<DataType, SpatialDim, Frame>&)>(
Require a pointer to not be a nullptr
Definition Gsl.hpp:197
void ricci_scalar(gsl::not_null< Scalar< DataType > * > ricci_scalar_result, const tnsr::aa< DataType, SpatialDim, Frame, Index > &ricci_tensor, const tnsr::AA< DataType, SpatialDim, Frame, Index > &inverse_metric)
Computes the Ricci Scalar from the (spatial or spacetime) Ricci Tensor and inverse metrics.

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