SpECTRE  v2025.08.19
control_system::size::States::DeltaRNoDrift Class Reference

Public Types

using options = tmpl::list<>
 

Public Member Functions

std::string name () const override
 Name of this state. More...
 
size_t number () const override
 Return a size_t that corresponds to the state number in SpEC. More...
 
std::unique_ptr< Stateget_clone () const override
 
std::string update (gsl::not_null< Info * > info, const StateUpdateArgs &update_args, const CrossingTimeInfo &crossing_time_info) const override
 
double control_error (const Info &info, const ControlErrorArgs &control_error_args) const override
 The return value is Q from Eq. 96 of [99]. More...
 
 WRAPPED_PUPable_decl_template (DeltaRNoDrift)
 
 DeltaRNoDrift (CkMigrateMessage *const)
 
- Public Member Functions inherited from control_system::size::State
 State (const State &)=default
 
Stateoperator= (const State &)=default
 
 State (State &&)=default
 
Stateoperator= (State &&)=default
 
virtual std::string name () const =0
 Name of this state. More...
 
virtual size_t number () const =0
 Return a size_t that corresponds to the state number in SpEC. More...
 
virtual std::unique_ptr< Stateget_clone () const =0
 
virtual std::string update (const gsl::not_null< Info * > info, const StateUpdateArgs &update_args, const CrossingTimeInfo &crossing_time_info) const =0
 Updates the Info in info. More...
 
virtual double control_error (const Info &info, const ControlErrorArgs &control_error_args) const =0
 Returns the control signal, but does not modify the state or any parameters. More...
 
 WRAPPED_PUPable_abstract (State)
 
 State (CkMigrateMessage *msg)
 

Static Public Attributes

static constexpr Options::String help
 

Member Function Documentation

◆ control_error()

double control_system::size::States::DeltaRNoDrift::control_error ( const Info info,
const ControlErrorArgs control_error_args 
) const
overridevirtual

The return value is Q from Eq. 96 of [99].

Implements control_system::size::State.

◆ get_clone()

std::unique_ptr< State > control_system::size::States::DeltaRNoDrift::get_clone ( ) const
overridevirtual

◆ name()

std::string control_system::size::States::DeltaRNoDrift::name ( ) const
inlineoverridevirtual

Name of this state.

Implements control_system::size::State.

◆ number()

size_t control_system::size::States::DeltaRNoDrift::number ( ) const
inlineoverridevirtual

Return a size_t that corresponds to the state number in SpEC.

Implements control_system::size::State.

Member Data Documentation

◆ help

constexpr Options::String control_system::size::States::DeltaRNoDrift::help
staticconstexpr
Initial value:
{
"Controls the velocity of the excision surface to maintain a constant "
"separation between the excision surface and the horizon surface. "
"This is a transition from DeltaRDriftInward to DeltaR, and otherwise "
"acts very much like state DeltaR (e.g. it has the same control error). "
"This is state 4 in SpEC."}

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