SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
Initialization::TimeStepping< Metavariables, TimeStepperBase > Struct Template Reference

Initialize items related to time stepping. More...

#include <Evolution.hpp>

Public Types

using const_global_cache_tags
 Tags for constant items added to the GlobalCache. These items are initialized from input file options.
using mutable_global_cache_tags = tmpl::list<>
 Tags for mutable items added to the GlobalCache. These items are initialized from input file options.
using argument_tags
 Tags for items fetched by the DataBox and passed to the apply function.
using simple_tags_from_options
 Tags for simple DataBox items that are initialized from input file options.
using default_initialized_simple_tags
 Tags for simple DataBox items that are default initialized.
using return_tags
 Tags for items in the DataBox that are mutated by the apply function.
using simple_tags
 Tags for mutable DataBox items that are either default initialized or initialized by the apply function.
using compute_tags = time_stepper_ref_tags<TimeStepperBase>
 Tags for immutable DataBox items (compute items or reference items) added to the DataBox.

Static Public Member Functions

static void apply (const gsl::not_null< TimeStepId * > next_time_step_id, const gsl::not_null< TimeDelta * > time_step, const gsl::not_null< double * > slab_size_goal, const double initial_time_value, const double initial_dt_value, const double initial_slab_size, const LtsTimeStepper &time_stepper)
 Given the items fetched from a DataBox by the argument_tags when using LTS, mutate the items in the DataBox corresponding to return_tags.
static void apply (const gsl::not_null< TimeStepId * > next_time_step_id, const gsl::not_null< TimeDelta * > time_step, const gsl::not_null< double * > slab_size_goal, const double initial_time_value, const double initial_dt_value, const double initial_slab_size, const TimeStepper &time_stepper)
 Given the items fetched from a DataBox by the argument_tags, when not using LTS, mutate the items in the DataBox corresponding to return_tags.

Detailed Description

template<typename Metavariables, typename TimeStepperBase>
struct Initialization::TimeStepping< Metavariables, TimeStepperBase >

Initialize items related to time stepping.

Details

See the type aliases defined below for what items are added to the GlobalCache and DataBox and how they are initialized

Since the evolution has not started yet, initialize the state before the initial time. So Tags::TimeStepId is undefined at this point, and Tags::Next<Tags::TimeStepId> is the initial time.

Member Typedef Documentation

◆ argument_tags

template<typename Metavariables, typename TimeStepperBase>
using Initialization::TimeStepping< Metavariables, TimeStepperBase >::argument_tags
Initial value:
The evolution TimeStepper. The template parameter should be one of the time stepper base classes,...
Definition TimeStepper.hpp:32
Tag for the current time as a double.
Definition Time.hpp:19

Tags for items fetched by the DataBox and passed to the apply function.

◆ const_global_cache_tags

template<typename Metavariables, typename TimeStepperBase>
using Initialization::TimeStepping< Metavariables, TimeStepperBase >::const_global_cache_tags
Initial value:
tmpl::list<::Tags::ConcreteTimeStepper<TimeStepperBase>>

Tags for constant items added to the GlobalCache. These items are initialized from input file options.

◆ default_initialized_simple_tags

template<typename Metavariables, typename TimeStepperBase>
using Initialization::TimeStepping< Metavariables, TimeStepperBase >::default_initialized_simple_tags
Initial value:
tmpl::push_back<StepChoosers::step_chooser_simple_tags<
Metavariables, TimeStepperBase::local_time_stepping>,
Definition AdaptiveSteppingDiagnostics.hpp:10
Number of time step taken within a Slab.
Definition StepNumberWithinSlab.hpp:14
Tag for TimeStepId for the algorithm state.
Definition TimeStepId.hpp:14

Tags for simple DataBox items that are default initialized.

◆ return_tags

template<typename Metavariables, typename TimeStepperBase>
using Initialization::TimeStepping< Metavariables, TimeStepperBase >::return_tags
Initial value:
tmpl::list<::Tags::Next<::Tags::TimeStepId>, ::Tags::TimeStep,
Long-term desired slab size. Used as the default size if nothing chooses a smaller one.
Definition Tags.hpp:27
Tag for step size.
Definition TimeStep.hpp:13

Tags for items in the DataBox that are mutated by the apply function.

◆ simple_tags

template<typename Metavariables, typename TimeStepperBase>
using Initialization::TimeStepping< Metavariables, TimeStepperBase >::simple_tags
Initial value:
tmpl::append<default_initialized_simple_tags, return_tags>

Tags for mutable DataBox items that are either default initialized or initialized by the apply function.

◆ simple_tags_from_options

template<typename Metavariables, typename TimeStepperBase>
using Initialization::TimeStepping< Metavariables, TimeStepperBase >::simple_tags_from_options
Initial value:

Tags for simple DataBox items that are initialized from input file options.


The documentation for this struct was generated from the following file:
  • src/Evolution/Initialization/Evolution.hpp