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< State >	get_clone () const override

std::string	update (const gsl::not_null< Info * > info, const StateUpdateArgs &update_args, const CrossingTimeInfo &crossing_time_info) const override
	Updates the Info in `info`. More...

double	control_error (const Info &info, const ControlErrorArgs &control_error_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

State &	operator= (const State &)=default

	State (State &&)=default

State &	operator= (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< State >	get_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)

Member Function Documentation

◆ control_error()

double control_system::size::States::Initial::control_error	(	const Info &	info,
		const ControlErrorArgs &	control_error_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

Implements control_system::size::State.

◆ name()

std::string control_system::size::States::Initial::name ( ) const

inlineoverridevirtual

Name of this state.

Implements control_system::size::State.

◆ number()

size_t control_system::size::States::Initial::number ( ) const

inlineoverridevirtual

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

Implements control_system::size::State.

◆ update()

std::string 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.

Note: 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.

Returns: The return string is used as a helpful diagnostic that may be printed to determine what logic decisions the state is making (depends on the control_system::Tags::Verbosity flag).

Implements control_system::size::State.

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

src/ControlSystem/ControlErrors/Size/Initial.hpp

Public Member Functions

Member Function Documentation

◆ control_error()

◆ get_clone()

◆ name()

◆ number()

◆ update()