SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
hydro::Tags::MassWeightedKineticEnergyCompute< DataType > Struct Template Reference

Compute item for mass-weighted internal energy. More...

#include <MassWeightedFluidItems.hpp>

Public Types

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

Static Public Attributes

static constexpr auto function

Detailed Description

template<typename DataType>
struct hydro::Tags::MassWeightedKineticEnergyCompute< DataType >

Compute item for mass-weighted internal energy.

Can be retrieved using ‘hydro::Tags::MassWeightedKineticEnergy

Member Typedef Documentation

◆ argument_tags

template<typename DataType>
using hydro::Tags::MassWeightedKineticEnergyCompute< DataType >::argument_tags
Initial value:
The densitized rest-mass density .
Definition Tags.hpp:32
The Lorentz factor , where is the spatial velocity of the fluid.
Definition Tags.hpp:181

Member Data Documentation

◆ function

template<typename DataType>
auto hydro::Tags::MassWeightedKineticEnergyCompute< DataType >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
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 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 .
void mass_weighted_kinetic_energy(gsl::not_null< Scalar< DataType > * > result, const Scalar< DataType > &tilde_d, const Scalar< DataType > &lorentz_factor)
Compute tilde_d * (lorentz_factor - 1.0) Result of the calculation stored in result.

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