SpECTRE  v2025.08.19
control_system::size::StateUpdateArgs Struct Reference

Packages some of the inputs to the State::update, so that State::update doesn't need a large number of arguments. More...

#include <State.hpp>

Public Attributes

double min_char_speed
 min_char_speed is the minimum over the excision boundary of Eq. 89 of [99].
 
double min_comoving_char_speed
 min_comoving_char_speed is the minimum over the excision boundary of Eq. 28 of [99].
 
double horizon_00
 horizon_00 is the spherepack coefficient of the apparent horizon.
 
double control_error_delta_r
 control_error_delta_r is the control error when the control system is in state Label::DeltaR. This is Q in Eq. 96 of [99].
 
std::optional< double > average_radial_distance
 average_radial_distance is the average distance between the horizon and the excision boundary. Used only for state DeltaRDriftOutward. If std::nullopt, then DeltaRDriftOutward will not be used.
 
std::optional< double > max_allowed_radial_distance
 max_allowed_radial_distance is the minimum distance between the horizon and the excision boundary that will trigger state Label::DeltaRDriftOutward. If std::nullopt, then DeltaRDriftOutward will never be triggered.
 
double avg_distorted_normal_dot_unit_coord_vector
 avg_distorted_normal_dot_unit_coord_vector is the same quantity as ControlErrorArgs::avg_distorted_normal_dot_unit_coord_vector.
 
std::optional< double > inward_drift_velocity
 inward_drift_velocity is a positive quantity that represents how fast the horizon and the excision boundary move apart in state DeltaRDriftInward. If std::nullopt, then DeltaRDriftInward will never be triggered.
 
std::optional< double > min_allowed_radial_distance
 min_allowed_radial_distance is the minimum distance between the horizon and the excision boundary that will trigger state Label::DeltaRDriftInward.
 
std::optional< double > min_allowed_char_speed
 min_allowed_char_speed is the minimum char speed that will trigger state DeltaRDriftInward. If both min_allowed_radial_distance and min_allowed_char_speed are std::nullopt, then DeltaRDriftInward will never be triggered.
 
bool comoving_char_speed_increasing_inward
 comoving_char_speed_increasing_inward is true if the comoving char speed increases as the excision boundary is moved inward.
 

Detailed Description

Packages some of the inputs to the State::update, so that State::update doesn't need a large number of arguments.


The documentation for this struct was generated from the following file: