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

The FunctionsOfTime initialized from a DomainCreator, initial time, and control system OptionHolders. More...

#include <FunctionsOfTimeInitialize.hpp>

Public Types

using base = domain::Tags::FunctionsOfTime
template<typename Metavariables>
using option_holders
template<typename Metavariables>
using option_tags
Public Types inherited from domain::Tags::FunctionsOfTime
using type

Static Public Member Functions

static std::string name ()
template<typename Metavariables>
static type create_from_options (const std::unique_ptr<::DomainCreator< Metavariables::volume_dim > > &domain_creator)
 This version of create_from_options is used if the metavariables did not define control systems.
template<typename Metavariables, typename... OptionHolders>
static type create_from_options (const std::unique_ptr<::DomainCreator< Metavariables::volume_dim > > &domain_creator, const int measurements_per_update, const bool delay_update, const double initial_time, const Options::Auto< OptionHolders, Options::AutoLabel::None > &... option_holders)
 This version of create_from_options is used if the metavariables did define control systems.
template<typename Metavariables, typename... OptionHolders>
static type create_from_options (const std::unique_ptr<::DomainCreator< Metavariables::volume_dim > > &domain_creator, const int measurements_per_update, const bool delay_update, const double initial_time, const std::optional< OptionHolders > &... option_holders)
 This version of create_from_options is used if the metavariables did define control systems.

Static Public Attributes

static constexpr bool pass_metavariables = true
template<typename Metavariables>
static constexpr bool metavars_has_control_systems

Detailed Description

The FunctionsOfTime initialized from a DomainCreator, initial time, and control system OptionHolders.

Member Typedef Documentation

◆ option_holders

template<typename Metavariables>
using control_system::Tags::FunctionsOfTimeInitialize::option_holders
Initial value:
tmpl::transform<tmpl::filter<typename Metavariables::component_list,
tmpl::bind<tmpl::back, tmpl::_1>>>
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
detail::wrapped_is_a< detail::is_a_wrapper< U >, T > is_a
Check if type T is a template specialization of U
Definition IsA.hpp:58

◆ option_tags

template<typename Metavariables>
using control_system::Tags::FunctionsOfTimeInitialize::option_tags
Initial value:
tmpl::push_front<
tmpl::conditional_t<
metavars_has_control_systems<Metavariables>,
tmpl::flatten<tmpl::list<
::OptionTags::InitialTime, option_holders<Metavariables>>>,
tmpl::list<>>,
The time at which to start the simulation.
Definition InitialTime.hpp:13
Option tag on whether to delay FunctionOfTime updates by one measurement to improve parallelization.
Definition OptionTags.hpp:160
Option tag that determines how many measurements will occur per control system update.
Definition OptionTags.hpp:147
The input file tag for the DomainCreator to use.
Definition OptionTags.hpp:22

Member Data Documentation

◆ metavars_has_control_systems

template<typename Metavariables>
bool control_system::Tags::FunctionsOfTimeInitialize::metavars_has_control_systems
staticconstexpr
Initial value:
=
tmpl::size<option_holders<Metavariables>>::value > 0
constexpr T & value(T &t)
Returns t.value() if t is a std::optional otherwise returns t.
Definition OptionalHelpers.hpp:32

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