Holds all options for a single control system. More...

#include <OptionTags.hpp>

Classes
struct	Averager

struct	ControlError

struct	Controller

struct	TimescaleTuner

Public Types
using	control_system = ControlSystem

using	options = implementation defined

Public Member Functions
	OptionHolder (::Averager< deriv_order - 1 > input_averager, ::Controller< deriv_order > input_controller, ::TimescaleTuner< not is_size > input_tuner, typename ControlSystem::control_error input_control_error)

	OptionHolder (const OptionHolder &)=default

OptionHolder &	operator= (const OptionHolder &)=default

	OptionHolder (OptionHolder &&)=default

OptionHolder &	operator= (OptionHolder &&)=default

void	pup (PUP::er &p)

Public Attributes
::Averager< deriv_order - 1 >	averager {}

::Controller< deriv_order >	controller {}

::TimescaleTuner< not is_size >	tuner {}

ControlSystem::control_error	control_error {}

Static Public Attributes
static constexpr size_t	deriv_order = control_system::deriv_order

static constexpr Options::String	help = {"Options for a control system."}

Detailed Description

template<typename ControlSystem>
struct control_system::OptionHolder< ControlSystem >

Holds all options for a single control system.

This struct collects all the options for a given control system during option parsing. Then during initialization, the options can be retrieved via their public member names and assigned to their corresponding DataBox tags.

This class should only be used if a control system is active.

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

src/ControlSystem/Tags/OptionTags.hpp

Classes

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description