SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
gh::bbh::Events::CheckConstraintThresholds Class Reference

Computes per-element Linf norms of the generalized-harmonic constraints, latching BBH completion criteria when thresholds are exceeded. More...

#include <CheckConstraintThresholds.hpp>

Public Types

using compute_tags_for_observation_box
using options = tmpl::list<>
using return_tags = tmpl::list<>
using argument_tags
using is_ready_argument_tags = tmpl::list<>

Public Member Functions

template<typename Metavariables, typename ArrayIndex, typename Component>
void operator() (const double time, const tnsr::a< DataVector, 3, Frame::Inertial > &gauge_constraint, const tnsr::iaa< DataVector, 3, Frame::Inertial > &three_index_constraint, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const Component *const, const ObservationValue &) const
template<typename Metavariables, typename ArrayIndex, typename Component>
bool is_ready (Parallel::GlobalCache< Metavariables > &, const ArrayIndex &, const Component *const) const
bool needs_evolved_variables () const override
 Whether the event uses anything depending on the evolved_variables. If this returns false, anything depending on the evolved variables may have an incorrect value when the event is run.
Public Member Functions inherited from Event
 Event (CkMigrateMessage *msg)
 WRAPPED_PUPable_abstract (Event)
template<typename ComputeTagsList, typename DataBoxType, typename Metavariables, typename ArrayIndex, typename ComponentPointer>
void run (const gsl::not_null< ObservationBox< ComputeTagsList, DataBoxType > * > box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const ComponentPointer, const ObservationValue &observation_value) const
template<typename DbTags, typename Metavariables, typename ArrayIndex, typename ComponentPointer>
bool is_ready (const db::DataBox< DbTags > &box, Parallel::GlobalCache< Metavariables > &cache, const ArrayIndex &array_index, const ComponentPointer) const

Static Public Member Functions

static std::string name ()

Static Public Attributes

static constexpr Options::String help

Detailed Description

Computes per-element Linf norms of the generalized-harmonic constraints, latching BBH completion criteria when thresholds are exceeded.

Details

This event is intended to run once common-horizon finding is active (typically behind a separation-based trigger). It monitors the gauge and three-index constraints, using a reduction to determine if their Linf norms exceed completion thresholds.

Member Typedef Documentation

◆ argument_tags

using gh::bbh::Events::CheckConstraintThresholds::argument_tags
Initial value:
tmpl::list<
Tag for the current time as a double.
Definition Time.hpp:19
Tags corresponding to various constraints of the generalized harmonic system, and their diagnosticall...
Definition Tags.hpp:175
Tags corresponding to various constraints of the generalized harmonic system, and their diagnosticall...
Definition Tags.hpp:190

◆ compute_tags_for_observation_box

using gh::bbh::Events::CheckConstraintThresholds::compute_tags_for_observation_box
Initial value:
tmpl::list<gh::Tags::GaugeConstraintCompute<3, Frame::Inertial>,
Compute item to get the three-index constraint for the generalized harmonic evolution system.
Definition Constraints.hpp:740

Member Function Documentation

◆ needs_evolved_variables()

bool gh::bbh::Events::CheckConstraintThresholds::needs_evolved_variables ( ) const
inlineoverridevirtual

Whether the event uses anything depending on the evolved_variables. If this returns false, anything depending on the evolved variables may have an incorrect value when the event is run.

Implements Event.

Member Data Documentation

◆ help

Options::String gh::bbh::Events::CheckConstraintThresholds::help
staticconstexpr
Initial value:
=
"Checks local Linf norms of constraints against BBH completion "
"thresholds and forwards reduced maxima to the BBH completion singleton "
"reduction callback."

The documentation for this class was generated from the following file:
  • src/Evolution/Systems/GeneralizedHarmonic/Bbh/Events/CheckConstraintThresholds.hpp