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

Compute item for TildeD limited to unbound material (u_t<-1 criteria) More...

#include <MassWeightedFluidItems.hpp>

Public Types

using argument_tags
using return_type = Scalar<DataType>
using base = TildeDUnboundUtCriterion<DataType>
Public Types inherited from hydro::Tags::TildeDUnboundUtCriterion< 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 hydro::Tags::TildeDUnboundUtCriterionCompute< DataType, Dim, Fr >

Compute item for TildeD limited to unbound material (u_t<-1 criteria)

Can be retrieved using ‘hydro::Tags::TildeDUnboundUtCriterion’

Member Typedef Documentation

◆ argument_tags

template<typename DataType, size_t Dim, typename Fr = Frame::Inertial>
using hydro::Tags::TildeDUnboundUtCriterionCompute< DataType, Dim, Fr >::argument_tags
Initial value:
tmpl::list<grmhd::ValenciaDivClean::Tags::TildeD, LorentzFactor<DataType>,
SpatialVelocity<DataType, Dim, Fr>,
gr::Tags::SpatialMetric<DataType, Dim, Fr>,
gr::Tags::Lapse<DataType>, gr::Tags::Shift<DataType, Dim, Fr>>
gr::Tags::Lapse
Definition Tags.hpp:65
gr::Tags::Shift
Definition Tags.hpp:61
gr::Tags::SpatialMetric
Definition Tags.hpp:25
hydro::Tags::SpatialVelocity
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 Fr = Frame::Inertial>
auto hydro::Tags::TildeDUnboundUtCriterionCompute< DataType, Dim, Fr >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
const gsl::not_null<Scalar<DataType>*> result,
const Scalar<DataType>& tilde_d, const Scalar<DataType>& lorentz_factor,
const tnsr::I<DataType, Dim, Fr>& spatial_velocity,
const tnsr::ii<DataType, Dim, Fr>& spacial_metric,
const Scalar<DataType>& lapse, const tnsr::I<DataType, Dim, Fr>& shift)>(
&tilde_d_unbound_ut_criterion<DataType, Dim, Fr>)
gsl::not_null
Require a pointer to not be a nullptr
Definition Gsl.hpp:197
gr::shift
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.
gr::lapse
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.
Scalar
Tensor< T, Symmetry<>, index_list<> > Scalar
Scalar type.
Definition TypeAliases.hpp:21
hydro::tilde_d_unbound_ut_criterion
void tilde_d_unbound_ut_criterion(gsl::not_null< Scalar< DataType > * > result, const Scalar< DataType > &tilde_d, const Scalar< DataType > &lorentz_factor, const tnsr::I< DataType, Dim, Fr > &spatial_velocity, const tnsr::ii< DataType, Dim, Fr > &spatial_metric, const Scalar< DataType > &lapse, const tnsr::I< DataType, Dim, Fr > &shift)
Returns tilde_d in regions where u_t < -1 and 0 in regions where u_t > -1 (approximate criteria for u...
hydro::lorentz_factor
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 .
The documentation for this struct was generated from the following file:
  • src/PointwiseFunctions/Hydro/MassWeightedFluidItems.hpp