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

Compute item for TildeD * (coordinates in frame Fr). IntegralMask allows us to restrict the data to the x>0 or x<0 plane in grid coordinates (useful for NSNS). More...

#include <MassWeightedFluidItems.hpp>

Public Types

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

Static Public Attributes

static constexpr auto function

Additional Inherited Members

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

Detailed Description

template<typename DataType, size_t Dim, HalfPlaneIntegralMask IntegralMask, typename GridCoordsTag, typename OutputCoordsTag, typename Fr = Frame::Inertial>
struct hydro::Tags::MassWeightedCoordsCompute< DataType, Dim, IntegralMask, GridCoordsTag, OutputCoordsTag, Fr >

Compute item for TildeD * (coordinates in frame Fr). IntegralMask allows us to restrict the data to the x>0 or x<0 plane in grid coordinates (useful for NSNS).

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

Member Typedef Documentation

◆ argument_tags

template<typename DataType, size_t Dim, HalfPlaneIntegralMask IntegralMask, typename GridCoordsTag, typename OutputCoordsTag, typename Fr = Frame::Inertial>
using hydro::Tags::MassWeightedCoordsCompute< DataType, Dim, IntegralMask, GridCoordsTag, OutputCoordsTag, Fr >::argument_tags
Initial value:
GridCoordsTag, OutputCoordsTag>
The densitized rest-mass density .
Definition Tags.hpp:32

Member Data Documentation

◆ function

template<typename DataType, size_t Dim, HalfPlaneIntegralMask IntegralMask, typename GridCoordsTag, typename OutputCoordsTag, typename Fr = Frame::Inertial>
auto hydro::Tags::MassWeightedCoordsCompute< DataType, Dim, IntegralMask, GridCoordsTag, OutputCoordsTag, Fr >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
const Scalar<DataType>& tilde_d,
const tnsr::I<DataType, Dim, Frame::Grid>& grid_coords,
const tnsr::I<DataType, Dim, Fr>& compute_coords)>(
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_weighted_coords(gsl::not_null< tnsr::I< DataType, Dim, Fr > * > result, const Scalar< DataType > &tilde_d, const tnsr::I< DataType, Dim, Frame::Grid > &grid_coords, const tnsr::I< DataType, Dim, Fr > &compute_coords)
Returns tilde_d * compute_coords IntegralMask allows us to restrict the data to the x>0 or x<0 plane ...

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