SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
ScalarWave::Tags::EnergyDensityCompute< SpatialDim > Struct Template Reference

Computes the energy density using ScalarWave::energy_density() More...

#include <EnergyDensity.hpp>

Public Types

using argument_tags = tmpl::list<Pi, Phi<SpatialDim>>
using return_type = Scalar<DataVector>
using base = EnergyDensity<SpatialDim>
Public Types inherited from ScalarWave::Tags::EnergyDensity< SpatialDim >
using type

Static Public Attributes

static constexpr auto function

Detailed Description

template<size_t SpatialDim>
struct ScalarWave::Tags::EnergyDensityCompute< SpatialDim >

Computes the energy density using ScalarWave::energy_density()

Member Data Documentation

◆ function

template<size_t SpatialDim>
auto ScalarWave::Tags::EnergyDensityCompute< SpatialDim >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
const tnsr::i<DataVector, SpatialDim, Frame::Inertial>&)>(
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 energy_density(gsl::not_null< Scalar< DataVector > * > result, const Scalar< DataVector > &pi, const tnsr::i< DataVector, SpatialDim, Frame::Inertial > &phi)
Computes the energy density of the scalar wave system.

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