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

Compute item to get the gauge constraint for the generalized harmonic evolution system. More...

#include <Constraints.hpp>

Public Types

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

Static Public Attributes

static constexpr auto function

Detailed Description

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

Compute item to get the gauge constraint for the generalized harmonic evolution system.

Details

See gauge_constraint(). Can be retrieved using gh::Tags::GaugeConstraint.

Member Typedef Documentation

◆ argument_tags

template<size_t SpatialDim, typename Frame>
using gh::Tags::GaugeConstraintCompute< SpatialDim, Frame >::argument_tags
Initial value:
tmpl::list<
GaugeH<DataVector, SpatialDim, Frame>,
gr::Tags::SpacetimeNormalOneForm<DataVector, SpatialDim, Frame>,
gr::Tags::SpacetimeNormalVector<DataVector, SpatialDim, Frame>,
gr::Tags::InverseSpatialMetric<DataVector, SpatialDim, Frame>,
gr::Tags::InverseSpacetimeMetric<DataVector, SpatialDim, Frame>,
Pi<DataVector, SpatialDim, Frame>, Phi<DataVector, SpatialDim, Frame>>
gh::Tags::GaugeH
Gauge source function for the generalized harmonic system.
Definition Tags.hpp:51
gh::Tags::Phi
Auxiliary variable which is analytically the spatial derivative of the spacetime metric.
Definition Tags.hpp:38
gh::Tags::Pi
Conjugate momentum to the spacetime metric.
Definition Tags.hpp:27
gr::Tags::InverseSpacetimeMetric
Definition Tags.hpp:20
gr::Tags::InverseSpatialMetric
Inverse of the spatial metric.
Definition Tags.hpp:32
gr::Tags::SpacetimeNormalOneForm
Definition Tags.hpp:96
gr::Tags::SpacetimeNormalVector
Definition Tags.hpp:100

Member Data Documentation

◆ function

template<size_t SpatialDim, typename Frame>
auto gh::Tags::GaugeConstraintCompute< SpatialDim, Frame >::function
staticconstexpr
Initial value:
= static_cast<void (*)(
gsl::not_null<tnsr::a<DataVector, SpatialDim, Frame>*>,
const tnsr::a<DataVector, SpatialDim, Frame>&,
const tnsr::a<DataVector, SpatialDim, Frame>&,
const tnsr::A<DataVector, SpatialDim, Frame>&,
const tnsr::II<DataVector, SpatialDim, Frame>&,
const tnsr::AA<DataVector, SpatialDim, Frame>&,
const tnsr::aa<DataVector, SpatialDim, Frame>&,
const tnsr::iaa<DataVector, SpatialDim, Frame>&)>(
&gauge_constraint<DataVector, SpatialDim, Frame>)
gsl::not_null
Require a pointer to not be a nullptr
Definition Gsl.hpp:197
gh::gauge_constraint
tnsr::a< DataType, SpatialDim, Frame > gauge_constraint(const tnsr::a< DataType, SpatialDim, Frame > &gauge_function, const tnsr::a< DataType, SpatialDim, Frame > &spacetime_normal_one_form, const tnsr::A< DataType, SpatialDim, Frame > &spacetime_normal_vector, const tnsr::II< DataType, SpatialDim, Frame > &inverse_spatial_metric, const tnsr::AA< DataType, SpatialDim, Frame > &inverse_spacetime_metric, const tnsr::aa< DataType, SpatialDim, Frame > &pi, const tnsr::iaa< DataType, SpatialDim, Frame > &phi)
Computes the generalized-harmonic gauge constraint.
The documentation for this struct was generated from the following file:
  • src/Evolution/Systems/GeneralizedHarmonic/Constraints.hpp