SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
hydro::Tags::TransportVelocityCompute< DataType, Dim, Fr > Struct Template Reference

Compute tag for the transport velocity. More...

#include <TransportVelocity.hpp>

Public Types

using argument_tags
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

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 Typedef Documentation

◆ argument_tags

template<typename DataType, size_t Dim, typename Fr = Frame::Inertial>
using hydro::Tags::TransportVelocityCompute< DataType, Dim, Fr >::argument_tags
Initial value:
tmpl::list<SpatialVelocity<DataType, Dim, Fr>,
Definition Tags.hpp:65
Definition Tags.hpp:61

Member Data Documentation

◆ function

template<typename DataType, size_t Dim, typename Fr = Frame::Inertial>
auto hydro::Tags::TransportVelocityCompute< DataType, Dim, Fr >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
const tnsr::I<DataType, Dim, Fr>& spatial_velocity,
const Scalar<DataType>& lapse, const tnsr::I<DataType, Dim, Fr>& shift)>(
Require a pointer to not be a nullptr
Definition Gsl.hpp:197
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.
Tensor< T, Symmetry<>, index_list<> > Scalar
Scalar type.
Definition TypeAliases.hpp:21
void transport_velocity(gsl::not_null< tnsr::I< DataType, Dim, Fr > * > result, const tnsr::I< DataType, Dim, Fr > &spatial_velocity, const Scalar< DataType > &lapse, const tnsr::I< DataType, Dim, Fr > &shift)
Function computing the transport velocity.

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