SpECTRE  v2023.03.09
control_system::size::States::Initial Class Reference

Public Member Functions

std::unique_ptr< Stateget_clone () const override
 
void update (const gsl::not_null< Info * > info, const StateUpdateArgs &update_args, const CrossingTimeInfo &crossing_time_info) const override
 Updates the Info in info. Notice that info includes a state, which might be different than the current state upon return. It is the caller's responsibility to check if the current state has changed. More...
 
double control_signal (const Info &info, const ControlSignalArgs &control_signal_args) const override
 Returns the control signal, but does not modify the state or any parameters. More...
 
 WRAPPED_PUPable_decl_template (Initial)
 
 Initial (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::unique_ptr< Stateget_clone () const =0
 
virtual void update (const gsl::not_null< Info * > info, const StateUpdateArgs &update_args, const CrossingTimeInfo &crossing_time_info) const =0
 Updates the Info in info. Notice that info includes a state, which might be different than the current state upon return. It is the caller's responsibility to check if the current state has changed. More...
 
virtual double control_signal (const Info &info, const ControlSignalArgs &control_signal_args) const =0
 Returns the control signal, but does not modify the state or any parameters. More...
 
 WRAPPED_PUPable_abstract (State)
 
 State (CkMigrateMessage *msg)
 

Member Function Documentation

◆ control_signal()

double control_system::size::States::Initial::control_signal ( const Info info,
const ControlSignalArgs control_signal_args 
) const
overridevirtual

Returns the control signal, but does not modify the state or any parameters.

Implements control_system::size::State.

◆ get_clone()

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

◆ update()

void control_system::size::States::Initial::update ( const gsl::not_null< Info * >  info,
const StateUpdateArgs update_args,
const CrossingTimeInfo crossing_time_info 
) const
overridevirtual

Updates the Info in info. Notice that info includes a state, which might be different than the current state upon return. It is the caller's responsibility to check if the current state has changed.

Implements control_system::size::State.


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