SpECTRE  v2026.06.09.01
Loading...
Searching...
No Matches
hydro::Tags::LorentzFactorCompute< DataType, Dim, Frame > Struct Template Reference

Compute item for Lorentz factor \(W\). More...

#include <LorentzFactor.hpp>

Public Types

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

Static Public Attributes

static constexpr auto function

Detailed Description

template<typename DataType, size_t Dim, typename Frame>
struct hydro::Tags::LorentzFactorCompute< DataType, Dim, Frame >

Compute item for Lorentz factor \(W\).

Can be retrieved using hydro::Tags::LorentzFactor

Member Typedef Documentation

◆ argument_tags

template<typename DataType, size_t Dim, typename Frame>
using hydro::Tags::LorentzFactorCompute< DataType, Dim, Frame >::argument_tags
Initial value:
tmpl::list<SpatialVelocity<DataType, Dim, Frame>,
The spatial velocity one-form , where is raised and lowered with the spatial metric.
Definition Tags.hpp:265

Member Data Documentation

◆ function

template<typename DataType, size_t Dim, typename Frame>
auto hydro::Tags::LorentzFactorCompute< DataType, Dim, Frame >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
gsl::not_null<Scalar<DataType>*>, const tnsr::I<DataType, Dim, Frame>&,
const tnsr::i<DataType, Dim, Frame>&)>(
Require a pointer to not be a nullptr
Definition Gsl.hpp:197
void lorentz_factor(gsl::not_null< Scalar< DataType > * > result, const tnsr::I< DataType, Dim, Frame > &spatial_velocity, const tnsr::i< DataType, Dim, Frame > &spatial_velocity_form)
Computes the Lorentz factor .

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