control_system::Tags::Averager< ControlSystem > Struct Template Reference

DataBox tag for the averager. More...

#include <SystemTags.hpp>

Public Types
using	type = ::Averager<ControlSystem::deriv_order - 1>
using	option_tags

Static Public Member Functions
static type	create_from_options (const std::optional< control_system::OptionHolder< ControlSystem > > &option_holder)

Static Public Attributes
static constexpr bool	pass_metavariables = false

Detailed Description

template<typename ControlSystem>
struct control_system::Tags::Averager< ControlSystem >

DataBox tag for the averager.

To compute the deriv_orderth derivative of a control error, the max derivative we need from the averager is the deriv_order - 1st derivative.

If the option holder is nullopt, constructs a default Averager.

Member Typedef Documentation

option_tags

template<typename ControlSystem>

using control_system::Tags::Averager< ControlSystem >::option_tags

Initial value:

 
      tmpl::list<OptionTags::ControlSystemInputs<ControlSystem>>

---

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

• src/ControlSystem/Tags/SystemTags.hpp