SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
gh::Tags::PhiCompute< SpatialDim, Frame > Struct Template Reference

Compute item for the auxiliary variable \(\Phi_{iab}\) used by the generalized harmonic formulation of Einstein's equations. More...

#include <Phi.hpp>

Public Types

using argument_tags
using return_type = tnsr::iaa<DataVector, SpatialDim, Frame>
using base = Phi<DataVector, SpatialDim, Frame>
Public Types inherited from gh::Tags::Phi< DataVector, SpatialDim, Frame >
using type

Static Public Attributes

static constexpr auto function

Detailed Description

template<size_t SpatialDim, typename Frame>
struct gh::Tags::PhiCompute< SpatialDim, Frame >

Compute item for the auxiliary variable \(\Phi_{iab}\) used by the generalized harmonic formulation of Einstein's equations.

Details

See phi(). Can be retrieved using gh::Tags::Phi.

Member Typedef Documentation

◆ argument_tags

template<size_t SpatialDim, typename Frame>
using gh::Tags::PhiCompute< SpatialDim, Frame >::argument_tags
Initial value:
tmpl::list<
::Tags::deriv<gr::Tags::Lapse<DataVector>, tmpl::size_t<SpatialDim>,
tmpl::size_t<SpatialDim>, Frame>,
tmpl::size_t<SpatialDim>, Frame>>
Indicates the Frame that a TensorIndexType is in.
Definition IndexType.hpp:36
Prefix indicating spatial derivatives.
Definition Prefixes.hpp:46
Definition Tags.hpp:65
Definition Tags.hpp:61
Definition Tags.hpp:25

Member Data Documentation

◆ function

template<size_t SpatialDim, typename Frame>
auto gh::Tags::PhiCompute< SpatialDim, Frame >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
const Scalar<DataVector>&, const tnsr::i<DataVector, SpatialDim, Frame>&,
const tnsr::I<DataVector, SpatialDim, Frame>&,
const tnsr::iJ<DataVector, SpatialDim, Frame>&,
const tnsr::ii<DataVector, SpatialDim, Frame>&,
const tnsr::ijj<DataVector, SpatialDim, Frame>&)>(
Require a pointer to not be a nullptr
Definition Gsl.hpp:197
void phi(gsl::not_null< tnsr::iaa< DataType, SpatialDim, Frame > * > phi, const Scalar< DataType > &lapse, const tnsr::i< DataType, SpatialDim, Frame > &deriv_lapse, const tnsr::I< DataType, SpatialDim, Frame > &shift, const tnsr::iJ< DataType, SpatialDim, Frame > &deriv_shift, const tnsr::ii< DataType, SpatialDim, Frame > &spatial_metric, const tnsr::ijj< DataType, SpatialDim, Frame > &deriv_spatial_metric)
Computes the auxiliary variable used by the generalized harmonic formulation of Einstein's equations...
Tensor< T, Symmetry<>, index_list<> > Scalar
Scalar type.
Definition TypeAliases.hpp:21

The documentation for this struct was generated from the following file:
  • src/PointwiseFunctions/GeneralRelativity/GeneralizedHarmonic/Phi.hpp