SpECTRE  v2026.04.01
Loading...
Searching...
No Matches
GeneralizedHarmonicTemplateBase< VolumeDim, LocalTimeStepping > Struct Template Reference

Public Types

using system = gh::System<volume_dim>
using TimeStepperBase
using factory_creation
using observed_reduction_data_tags
using initialize_initial_data_dependent_quantities_actions
using const_global_cache_tags
using dg_registration_list
template<typename DerivedMetavars, typename ControlSystems>
using step_actions
template<typename DerivedMetavars, bool UseControlSystems>
using initialization_actions

Public Member Functions

void pup (PUP::er &)

Static Public Attributes

static constexpr size_t volume_dim = VolumeDim
static constexpr bool local_time_stepping
static constexpr bool use_dg_element_collection = false
static constexpr auto default_phase_order

Member Typedef Documentation

◆ const_global_cache_tags

template<size_t VolumeDim, bool LocalTimeStepping>
using GeneralizedHarmonicTemplateBase< VolumeDim, LocalTimeStepping >::const_global_cache_tags
Initial value:
The global cache tag for the initial data type.
Definition InitialData.hpp:37
A DampingFunction to compute the constraint damping parameter .
Definition ConstraintDampingTags.hpp:79
A DampingFunction to compute the constraint damping parameter .
Definition ConstraintDampingTags.hpp:97
A DampingFunction to compute the constraint damping parameter .
Definition ConstraintDampingTags.hpp:115
The gauge condition to impose.
Definition GaugeCondition.hpp:43

◆ dg_registration_list

template<size_t VolumeDim, bool LocalTimeStepping>
using GeneralizedHarmonicTemplateBase< VolumeDim, LocalTimeStepping >::dg_registration_list
Initial value:
tmpl::list<observers::Actions::RegisterEventsWithObservers>

◆ factory_creation

template<size_t VolumeDim, bool LocalTimeStepping>
using GeneralizedHarmonicTemplateBase< VolumeDim, LocalTimeStepping >::factory_creation
Initial value:
detail::FactoryCreation<volume_dim, local_time_stepping>

◆ initialization_actions

template<size_t VolumeDim, bool LocalTimeStepping>
template<typename DerivedMetavars, bool UseControlSystems>
using GeneralizedHarmonicTemplateBase< VolumeDim, LocalTimeStepping >::initialization_actions
Initial value:
tmpl::list<
UseControlSystems>,
typename system::variables_tag, domain::Tags::Mesh<volume_dim>,
typename system::gradient_variables>>,
tmpl::push_back<StepChoosers::step_chooser_compute_tags<
GeneralizedHarmonicTemplateBase, local_time_stepping>>>,
Definition IndexType.hpp:43
Definition IndexType.hpp:46
Definition GeneralizedHarmonicBase.hpp:331
Initialize the list of compute tags in ComputeTagsList
Definition AddComputeTags.hpp:39
Mutate DataBox items by calling db::mutate_apply on each Mutator in the order they are specified.
Definition InitializeItems.hpp:35
Allocate variables needed for evolution of nonconservative systems.
Definition NonconservativeSystem.hpp:45
Initialize time-stepper items.
Definition Evolution.hpp:317
Initialize items related to time stepping.
Definition Evolution.hpp:116
Terminate the algorithm to proceed to the next phase.
Definition TerminatePhase.hpp:28
Compute the spatial derivatives of tags in a Variables.
Definition PartialDerivatives.hpp:384
Initialize items related to adaptive mesh refinement.
Definition Initialize.hpp:28
The inverse Jacobian from the source frame to the target frame.
Definition Tags.hpp:118
The computational grid of the Element in the DataBox.
Definition Tags.hpp:62
Definition RunEventsAndDenseTriggers.hpp:297
Initialize items related to the basic structure of the element.
Definition DgDomain.hpp:65
Initialize mortars between elements for exchanging boundary correction terms.
Definition Mortars.hpp:131

◆ initialize_initial_data_dependent_quantities_actions

template<size_t VolumeDim, bool LocalTimeStepping>
using GeneralizedHarmonicTemplateBase< VolumeDim, LocalTimeStepping >::initialize_initial_data_dependent_quantities_actions
Initial value:
gh::Solutions::all_solutions<volume_dim>, volume_dim>,
Set from the gauge source function (or 1-index constraint) and from the 3-index constraint.
Definition SetPiAndPhiFromConstraints.hpp:65

◆ observed_reduction_data_tags

template<size_t VolumeDim, bool LocalTimeStepping>
using GeneralizedHarmonicTemplateBase< VolumeDim, LocalTimeStepping >::observed_reduction_data_tags
Initial value:
observers::collect_reduction_data_tags<tmpl::push_back<
tmpl::at<typename factory_creation::factory_classes, Event>>>

◆ TimeStepperBase

template<size_t VolumeDim, bool LocalTimeStepping>
using GeneralizedHarmonicTemplateBase< VolumeDim, LocalTimeStepping >::TimeStepperBase
Initial value:
tmpl::conditional_t<LocalTimeStepping, LtsTimeStepper, TimeStepper>

Member Data Documentation

◆ default_phase_order

template<size_t VolumeDim, bool LocalTimeStepping>
auto GeneralizedHarmonicTemplateBase< VolumeDim, LocalTimeStepping >::default_phase_order
staticconstexpr
Initial value:
=
@ Evolve
phase in which time steps are taken for an evolution executable
Definition Phase.hpp:59
@ Register
phase in which components register with other components
Definition Phase.hpp:79
@ ImportInitialData
phase in which initial data is imported from volume files
Definition Phase.hpp:65
@ RegisterWithElementDataReader
phase in which components register with the data importer components
Definition Phase.hpp:81
@ CheckDomain
phase in which sanity checks are done after AMR
Definition Phase.hpp:50
@ Initialization
initial phase of an executable
Definition Phase.hpp:67
@ InitializeTimeStepperHistory
phase in which the time stepper executes a self-start procedure
Definition Phase.hpp:72
@ InitializeInitialDataDependentQuantities
phase in which quantities dependent on imported initial data are initialized
Definition Phase.hpp:70
@ Exit
final phase of an executable
Definition Phase.hpp:63

◆ local_time_stepping

template<size_t VolumeDim, bool LocalTimeStepping>
bool GeneralizedHarmonicTemplateBase< VolumeDim, LocalTimeStepping >::local_time_stepping
staticconstexpr
Initial value:
=
TimeStepperBase::local_time_stepping

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