SpECTRE  v2024.05.11
hydro::Tags::TransportVelocityCompute< DataType, Dim, Fr > Struct Template Reference

Compute tag for the transport velocity. More...

#include <TransportVelocity.hpp>

Public Types

using argument_tags = tmpl::list< SpatialVelocity< DataType, Dim, Fr >, ::gr::Tags::Lapse< DataType >, ::gr::Tags::Shift< DataType, Dim, Fr > >
 
using base = hydro::Tags::TransportVelocity< DataType, Dim, Fr >
 
using return_type = typename base::type
 
- Public Types inherited from hydro::Tags::TransportVelocity< DataType, Dim, Frame::Inertial >
using type = tnsr::I< DataType, Dim, Frame::Inertial >
 

Static Public Attributes

static constexpr auto function
 

Detailed Description

template<typename DataType, size_t Dim, typename Fr = Frame::Inertial>
struct hydro::Tags::TransportVelocityCompute< DataType, Dim, Fr >

Compute tag for the transport velocity.

Compute item for the transport velocity, using \(v_t^i=\alpha v^i-\beta^i\), with \(v^i\) being the spatial velocity, \(\alpha\) the lapse, and \(\beta^i\) the shift.

Member Data Documentation

◆ function

template<typename DataType , size_t Dim, typename Fr = Frame::Inertial>
constexpr auto hydro::Tags::TransportVelocityCompute< DataType, Dim, Fr >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
const tnsr::I<DataType, Dim, Fr>& spatial_velocity,
&hydro::transport_velocity<DataType, Dim, Fr>)
Definition: ContractFirstNIndices.hpp:16
Require a pointer to not be a nullptr
Definition: Gsl.hpp:183
tnsr::I< DataType, SpatialDim, Frame > shift(const tnsr::aa< DataType, SpatialDim, Frame > &spacetime_metric, const tnsr::II< DataType, SpatialDim, Frame > &inverse_spatial_metric)
Compute shift from spacetime metric and inverse spatial metric.
Scalar< DataType > lapse(const tnsr::I< DataType, SpatialDim, Frame > &shift, const tnsr::aa< DataType, SpatialDim, Frame > &spacetime_metric)
Compute lapse from shift and spacetime metric.

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