SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
control_system::Tags::IsActiveMap Struct Reference

Tag that holds a map between control system name and whether that control system is active. Can be used in the GlobalCache. More...

#include <IsActiveMap.hpp>

Classes

struct  system

Public Types

using type = std::unordered_map<std::string, bool>
template<typename Metavariables>
using option_tags

Static Public Member Functions

template<typename Metavariables, typename... OptionHolders>
static type create_from_options (const Options::Auto< OptionHolders, Options::AutoLabel::None > &... option_holders)
template<typename Metavariables, typename... OptionHolders>
static type create_from_options (const std::optional< OptionHolders > &... option_holders)

Static Public Attributes

static constexpr bool pass_metavariables = true

Detailed Description

Tag that holds a map between control system name and whether that control system is active. Can be used in the GlobalCache.

This effectively lets us choose control systems at runtime. The OptionHolder has an option for whether the control system is active.

Member Typedef Documentation

◆ option_tags

template<typename Metavariables>
using control_system::Tags::IsActiveMap::option_tags
Initial value:
control_system::inputs<tmpl::transform<
tmpl::transform< ControlSystems, tmpl::bind< OptionTags::ControlSystemInputs, tmpl::_1 > > inputs
Alias to get all the option holders from a list of control systems. This is useful in the option_tags...
Definition OptionTags.hpp:186
tmpl::filter< detail::all_not_mocked_components< Metavariables >, tt::is_a< ControlComponent, tmpl::_1 > > all_control_components
Get all ControlComponents from the metavariables, even if they are mocked.
Definition Metafunctions.hpp:130
Definition IsActiveMap.hpp:60

The documentation for this struct was generated from the following file:
  • src/ControlSystem/Tags/IsActiveMap.hpp