SpECTRE  v2022.09.02
control_system::Tags::FunctionsOfTimeInitialize Struct Reference

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

#include <FunctionsOfTimeInitialize.hpp>

Public Types

using type = std::unordered_map< std::string, std::unique_ptr< domain::FunctionsOfTime::FunctionOfTime > >
 
template<typename Metavariables >
using option_tags = typename detail::OptionList< Metavariables, true, ::detail::has_override_functions_of_time_v< Metavariables > >::type
 

Static Public Member Functions

static std::string name ()
 
template<typename Metavariables , typename... OptionHolders>
static type create_from_options (const std::unique_ptr<::DomainCreator< Metavariables::volume_dim > > &domain_creator, const std::optional< std::string > &function_of_time_file, const std::map< std::string, std::string > &function_of_time_name_map, const double initial_time, const double initial_time_step, const OptionHolders &... option_holders)
 This version of create_from_options is used if the metavariables defined a constexpr bool override_functions_of_time and it is true, and there are control systems in the metavariables.
 
template<typename Metavariables >
static type create_from_options (const std::unique_ptr<::DomainCreator< Metavariables::volume_dim > > &domain_creator, const std::optional< std::string > &function_of_time_file, const std::map< std::string, std::string > &function_of_time_name_map)
 This version of create_from_options is used if the metavariables defined a constexpr bool override_functions_of_time and it is true, but there are no control systems in the metavariables.
 
template<typename Metavariables , typename... OptionHolders>
static type create_from_options (const std::unique_ptr<::DomainCreator< Metavariables::volume_dim > > &domain_creator, const double initial_time, const double initial_time_step, const OptionHolders &... option_holders)
 This version of create_from_options is used if the metavariables did not define a constexpr bool override_functions_of_time or it did define it and it is false, and the metavariables did define control systems.
 
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 a constexpr bool override_functions_of_time or it did define it and it is false, and the metavariables did not define control systems.
 

Static Public Attributes

static constexpr bool pass_metavariables = true
 

Detailed Description

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


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