SpECTRE  v2026.06.30
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
using equal_rate_regions
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:
tmpl::list<gh::gauges::Tags::GaugeCondition,
evolution::initial_data::Tags::InitialData,
gh::Tags::DampingFunctionGamma0<volume_dim, Frame::Grid>,
gh::Tags::DampingFunctionGamma1<volume_dim, Frame::Grid>,
gh::Tags::DampingFunctionGamma2<volume_dim, Frame::Grid>>
evolution::initial_data::Tags::InitialData
The global cache tag for the initial data type.
Definition InitialData.hpp:37
gh::Tags::DampingFunctionGamma0
A DampingFunction to compute the constraint damping parameter .
Definition ConstraintDampingTags.hpp:79
gh::Tags::DampingFunctionGamma1
A DampingFunction to compute the constraint damping parameter .
Definition ConstraintDampingTags.hpp:97
gh::Tags::DampingFunctionGamma2
A DampingFunction to compute the constraint damping parameter .
Definition ConstraintDampingTags.hpp:115
gh::gauges::Tags::GaugeCondition
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>

◆ equal_rate_regions

template<size_t VolumeDim, bool LocalTimeStepping>
using GeneralizedHarmonicTemplateBase< VolumeDim, LocalTimeStepping >::equal_rate_regions
Initial value:
tmpl::list<evolution::dg::NonconformingEqualRateRegions<volume_dim>>

◆ 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<
Initialization::Actions::InitializeItems<
Initialization::TimeStepping<DerivedMetavars, TimeStepper,
UseControlSystems, true>,
evolution::dg::Initialization::Domain<DerivedMetavars,
UseControlSystems>,
::amr::Initialization::Initialize<volume_dim, DerivedMetavars>,
Initialization::TimeStepperHistory<DerivedMetavars>>,
Initialization::Actions::NonconservativeSystem<system>,
Initialization::Actions::AddComputeTags<::Tags::DerivCompute<
typename system::variables_tag, domain::Tags::Mesh<volume_dim>,
domain::Tags::InverseJacobian<volume_dim, Frame::ElementLogical,
Frame::Inertial>,
typename system::gradient_variables,
domain::Tags::Coordinates<volume_dim, Frame::Inertial>>>,
gh::Actions::InitializeGhAnd3Plus1Variables<volume_dim>,
Initialization::Actions::AddComputeTags<
StepChoosers::step_chooser_compute_tags<
GeneralizedHarmonicTemplateBase>>,
::evolution::dg::Initialization::Mortars<volume_dim>,
evolution::dg::Initialization::Actions::SetupEqualRateRegions<
DerivedMetavars, volume_dim, equal_rate_regions>,
evolution::Actions::InitializeRunEventsAndDenseTriggers,
Initialization::Actions::InitializeItems<
evolution::dg::Initialization::SpectralFilters<
volume_dim, typename system::variables_tag::tags_list>>,
Parallel::Actions::TerminatePhase>
TimeStepper
Abstract base class for TimeSteppers.
Definition TimeStepper.hpp:74
Frame::ElementLogical
Definition IndexType.hpp:43
Frame::Inertial
Definition IndexType.hpp:46
GeneralizedHarmonicTemplateBase
Definition GeneralizedHarmonicBase.hpp:344
Initialization::Actions::AddComputeTags
Initialize the list of compute tags in ComputeTagsList
Definition AddComputeTags.hpp:39
Initialization::Actions::InitializeItems
Mutate DataBox items by calling db::mutate_apply on each Mutator in the order they are specified.
Definition InitializeItems.hpp:35
Initialization::Actions::NonconservativeSystem
Allocate variables needed for evolution of nonconservative systems.
Definition NonconservativeSystem.hpp:50
Initialization::TimeStepperHistory
Initialize time-stepper items.
Definition Evolution.hpp:298
Initialization::TimeStepping
Initialize items related to time stepping.
Definition Evolution.hpp:95
Parallel::Actions::TerminatePhase
Terminate the algorithm to proceed to the next phase.
Definition TerminatePhase.hpp:28
Tags::DerivCompute
Compute the spatial derivatives of tags in a Variables.
Definition PartialDerivatives.hpp:384
amr::Initialization::Initialize
Initialize items related to adaptive mesh refinement.
Definition Initialize.hpp:28
domain::Tags::Coordinates
The coordinates in a given frame.
Definition Tags.hpp:85
domain::Tags::InverseJacobian
The inverse Jacobian from the source frame to the target frame.
Definition Tags.hpp:118
domain::Tags::Mesh
The computational grid of the Element in the DataBox.
Definition Tags.hpp:62
evolution::Actions::InitializeRunEventsAndDenseTriggers
Definition RunEventsAndDenseTriggers.hpp:297
evolution::dg::Initialization::Actions::SetupEqualRateRegions
Set up FixedLtsRatio and mortar time-stepping policies to disable local time-stepping in equal rate r...
Definition SetupEqualRateRegions.hpp:124
evolution::dg::Initialization::Domain
Initialize items related to the basic structure of the element.
Definition DgDomain.hpp:65
evolution::dg::Initialization::Mortars
Initialize mortars between elements for exchanging boundary correction terms.
Definition Mortars.hpp:131
evolution::dg::Initialization::SpectralFilters
Initialization mutator that selects the spectral filter for each element and stores it as Filters::Ta...
Definition SpectralFilters.hpp:64

◆ initialize_initial_data_dependent_quantities_actions

template<size_t VolumeDim, bool LocalTimeStepping>
using GeneralizedHarmonicTemplateBase< VolumeDim, LocalTimeStepping >::initialize_initial_data_dependent_quantities_actions
Initial value:
tmpl::list<gh::gauges::SetPiAndPhiFromConstraints<
gh::Solutions::all_solutions<volume_dim>, volume_dim>,
Parallel::Actions::TerminatePhase>
gh::gauges::SetPiAndPhiFromConstraints
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>>>

◆ step_actions

template<size_t VolumeDim, bool LocalTimeStepping>
template<typename DerivedMetavars, typename ControlSystems>
using GeneralizedHarmonicTemplateBase< VolumeDim, LocalTimeStepping >::step_actions
Initial value:
tmpl::list<
evolution::dg::Actions::ComputeTimeDerivative<
volume_dim, system, AllStepChoosers, use_dg_element_collection>,
evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
volume_dim, use_dg_element_collection>,
Actions::MutateApply<RecordTimeStepperData<system>>,
evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<
::domain::CheckFunctionsOfTimeAreReadyPostprocessor<volume_dim>,
evolution::dg::ApplyLtsDenseBoundaryCorrections<DerivedMetavars>>>,
control_system::Actions::LimitTimeStep<ControlSystems>,
Actions::MutateApply<UpdateU<system>>,
evolution::dg::Actions::ApplyLtsBoundaryCorrections<
volume_dim, use_dg_element_collection>,
Actions::MutateApply<ChangeTimeStepperOrder<system>>,
Actions::MutateApply<CleanHistory<system>>,
Actions::MutateApply<evolution::dg::CleanMortarHistory<volume_dim>>,
dg::Actions::SpectralFilter>
Actions::MutateApply
Apply the function Mutator::apply to the DataBox.
Definition MutateApply.hpp:49
AllStepChoosers
A placeholder type to indicate that all constructible step choosers should be used in step chooser ut...
Definition StepChooser.hpp:64
control_system::Actions::LimitTimeStep
Limit the step size in a GTS evolution to prevent deadlocks from control system measurements.
Definition LimitTimeStep.hpp:73
dg::Actions::SpectralFilter
Applies the element's spectral volume filter to the evolved variables.
Definition SpectralFilter.hpp:68
domain::CheckFunctionsOfTimeAreReadyPostprocessor
Dense-output postprocessor to check that functions of time are up-to-date.
Definition FunctionsOfTimeAreReady.hpp:253
evolution::Actions::RunEventsAndDenseTriggers
Run the events and dense triggers.
Definition RunEventsAndDenseTriggers.hpp:78
evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative
Computes the boundary corrections for global time-stepping and adds them to the time derivative.
Definition ApplyBoundaryCorrections.hpp:1408
evolution::dg::Actions::ApplyLtsBoundaryCorrections
Computes the boundary corrections for local time-stepping and adds them to the variables.
Definition ApplyBoundaryCorrections.hpp:1440
evolution::dg::Actions::ComputeTimeDerivative
Computes the time derivative for a DG time step.
Definition ComputeTimeDerivative.hpp:358
evolution::dg::ApplyLtsDenseBoundaryCorrections
Apply corrections from boundary communication for LTS dense output.
Definition ApplyBoundaryCorrections.hpp:1333

◆ 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:
=
std::array{Parallel::Phase::Initialization,
Parallel::Phase::RegisterWithElementDataReader,
Parallel::Phase::ImportInitialData,
Parallel::Phase::InitializeInitialDataDependentQuantities,
Parallel::Phase::Register,
Parallel::Phase::InitializeTimeStepperHistory,
Parallel::Phase::CheckDomain,
Parallel::Phase::Evolve,
Parallel::Phase::Exit}
Parallel::Phase::Evolve
@ Evolve
phase in which time steps are taken for an evolution executable
Definition Phase.hpp:59
Parallel::Phase::Register
@ Register
phase in which components register with other components
Definition Phase.hpp:79
Parallel::Phase::ImportInitialData
@ ImportInitialData
phase in which initial data is imported from volume files
Definition Phase.hpp:65
Parallel::Phase::RegisterWithElementDataReader
@ RegisterWithElementDataReader
phase in which components register with the data importer components
Definition Phase.hpp:81
Parallel::Phase::CheckDomain
@ CheckDomain
phase in which sanity checks are done after AMR
Definition Phase.hpp:50
Parallel::Phase::Initialization
@ Initialization
initial phase of an executable
Definition Phase.hpp:67
Parallel::Phase::InitializeTimeStepperHistory
@ InitializeTimeStepperHistory
phase in which the time stepper executes a self-start procedure
Definition Phase.hpp:72
Parallel::Phase::InitializeInitialDataDependentQuantities
@ InitializeInitialDataDependentQuantities
phase in which quantities dependent on imported initial data are initialized
Definition Phase.hpp:70
Parallel::Phase::Exit
@ 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