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

Compute item to get the F-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 = FConstraint<DataVector, SpatialDim, Frame>
Public Types inherited from gh::Tags::FConstraint< DataVector, SpatialDim, Frame >
using type

Static Public Attributes

static constexpr auto function

Detailed Description

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

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

Details

See f_constraint(). Can be retrieved using gh::Tags::FConstraint.

Note
If the system contains matter, you will need to use a system-specific version of this compute tag that passes the appropriate stress-energy tensor to the F-constraint calculation.

Member Typedef Documentation

◆ argument_tags

template<size_t SpatialDim, typename Frame>
using gh::Tags::FConstraintCompute< SpatialDim, Frame >::argument_tags
Initial value:
tmpl::list<
GaugeH<DataVector, SpatialDim, Frame>,
SpacetimeDerivGaugeH<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>,
::Tags::deriv<Pi<DataVector, SpatialDim, Frame>, tmpl::size_t<SpatialDim>,
Frame>,
::Tags::deriv<Phi<DataVector, SpatialDim, Frame>,
tmpl::size_t<SpatialDim>, Frame>,
::gh::Tags::ConstraintGamma2,
ThreeIndexConstraint<DataVector, SpatialDim, Frame>>
Frame
Indicates the Frame that a TensorIndexType is in.
Definition IndexType.hpp:36
Tags::deriv
Prefix indicating spatial derivatives.
Definition Prefixes.hpp:46
gh::Tags::ConstraintGamma2
Constraint dammping parameter for the generalized harmonic system (cf. lindblom2005qh).
Definition ConstraintDampingTags.hpp:70
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
gh::Tags::SpacetimeDerivGaugeH
Spacetime derivatives of the gauge source function for the generalized harmonic system.
Definition Tags.hpp:65
gh::Tags::ThreeIndexConstraint
Tags corresponding to various constraints of the generalized harmonic system, and their diagnosticall...
Definition Tags.hpp:190
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::FConstraintCompute< 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::ab<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>&,
const tnsr::iaa<DataVector, SpatialDim, Frame>&,
const tnsr::ijaa<DataVector, SpatialDim, Frame>&,
const Scalar<DataVector>&,
const tnsr::iaa<DataVector, SpatialDim, Frame>&)>(
&f_constraint<DataVector, SpatialDim, Frame>)
gsl::not_null
Require a pointer to not be a nullptr
Definition Gsl.hpp:197
Scalar
Tensor< T, Symmetry<>, index_list<> > Scalar
Scalar type.
Definition TypeAliases.hpp:21
gh::f_constraint
tnsr::a< DataType, SpatialDim, Frame > f_constraint(const tnsr::a< DataType, SpatialDim, Frame > &gauge_function, const tnsr::ab< DataType, SpatialDim, Frame > &spacetime_d_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, const tnsr::iaa< DataType, SpatialDim, Frame > &d_pi, const tnsr::ijaa< DataType, SpatialDim, Frame > &d_phi, const Scalar< DataType > &gamma2, const tnsr::iaa< DataType, SpatialDim, Frame > &three_index_constraint)
Computes the generalized-harmonic F constraint.
The documentation for this struct was generated from the following file:
  • src/Evolution/Systems/GeneralizedHarmonic/Constraints.hpp