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

Compute item for the local Mach number, \(\text{Ma}\). More...

#include <MachNumber.hpp>

Public Types

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

Static Public Attributes

static constexpr auto function

Detailed Description

template<typename DataType, size_t Dim, typename Fr = Frame::Inertial>
struct NewtonianEuler::Tags::MachNumberCompute< DataType, Dim, Fr >

Compute item for the local Mach number, \(\text{Ma}\).

See also
NewtonianEuler::mach_number

Can be retrieved using NewtonianEuler::Tags::MachNumber

Member Typedef Documentation

◆ argument_tags

template<typename DataType, size_t Dim, typename Fr = Frame::Inertial>
using NewtonianEuler::Tags::MachNumberCompute< DataType, Dim, Fr >::argument_tags
Initial value:
tmpl::list<hydro::Tags::SpatialVelocity<DataType, Dim, Fr>,
The sound speed.
Definition Tags.hpp:52

Member Data Documentation

◆ function

template<typename DataType, size_t Dim, typename Fr = Frame::Inertial>
auto NewtonianEuler::Tags::MachNumberCompute< DataType, Dim, Fr >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
const gsl::not_null<Scalar<DataType>*>, const tnsr::I<DataType, Dim, Fr>&,
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 mach_number(gsl::not_null< Scalar< DataType > * > result, const tnsr::I< DataType, Dim, Fr > &velocity, const Scalar< DataType > &sound_speed)

The documentation for this struct was generated from the following file:
  • src/Evolution/Systems/NewtonianEuler/MachNumber.hpp