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

Compute item for mass flux vector \(J^i\). More...

#include <MassFlux.hpp>

Public Types

using argument_tags
using return_type = tnsr::I<DataType, Dim, Frame>
using base = MassFlux<DataType, Dim, Frame>
Public Types inherited from hydro::Tags::MassFlux< DataType, Dim, Frame >
using type

Static Public Attributes

static constexpr auto function

Additional Inherited Members

Static Public Member Functions inherited from hydro::Tags::MassFlux< DataType, Dim, Frame >
static std::string name ()

Detailed Description

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

Compute item for mass flux vector \(J^i\).

Can be retrieved using hydro::Tags::MassFlux

Member Typedef Documentation

◆ argument_tags

template<typename DataType, size_t Dim, typename Frame>
using hydro::Tags::MassFluxCompute< DataType, Dim, Frame >::argument_tags
Initial value:
tmpl::list<hydro::Tags::RestMassDensity<DataType>,
Definition Tags.hpp:65
Definition Tags.hpp:61
Definition Tags.hpp:43
The Lorentz factor , where is the spatial velocity of the fluid.
Definition Tags.hpp:181
The spatial velocity of the fluid, where . Here is the spatial part of the 4-velocity of the fluid,...
Definition Tags.hpp:257

Member Data Documentation

◆ function

template<typename DataType, size_t Dim, typename Frame>
auto hydro::Tags::MassFluxCompute< DataType, Dim, Frame >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
const tnsr::I<DataType, Dim, Frame>&, const Scalar<DataType>&,
const Scalar<DataType>&, const tnsr::I<DataType, Dim, Frame>&,
Require a pointer to not be a nullptr
Definition Gsl.hpp:197
Tensor< T, Symmetry<>, index_list<> > Scalar
Scalar type.
Definition TypeAliases.hpp:21
void mass_flux(gsl::not_null< tnsr::I< DataType, Dim, Frame > * > result, const Scalar< DataType > &rest_mass_density, const tnsr::I< DataType, Dim, Frame > &spatial_velocity, const Scalar< DataType > &lorentz_factor, const Scalar< DataType > &lapse, const tnsr::I< DataType, Dim, Frame > &shift, const Scalar< DataType > &sqrt_det_spatial_metric)
Computes the vector in , representing the mass flux through a surface with normal .

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