Line data Source code
1 0 : // Distributed under the MIT License.
2 : // See LICENSE.txt for details.
3 :
4 : #pragma once
5 :
6 : #include <cstddef>
7 : #include <cstdint>
8 : #include <vector>
9 :
10 : #include "Domain/Creators/Factory1D.hpp"
11 : #include "Domain/Tags.hpp"
12 : #include "Evolution/Actions/RunEventsAndDenseTriggers.hpp"
13 : #include "Evolution/Actions/RunEventsAndTriggers.hpp"
14 : #include "Evolution/BoundaryCorrection.hpp"
15 : #include "Evolution/ComputeTags.hpp"
16 : #include "Evolution/DgSubcell/Actions/Initialize.hpp"
17 : #include "Evolution/DgSubcell/Actions/Labels.hpp"
18 : #include "Evolution/DgSubcell/Actions/ReconstructionCommunication.hpp"
19 : #include "Evolution/DgSubcell/Actions/SelectNumericalMethod.hpp"
20 : #include "Evolution/DgSubcell/Actions/TakeTimeStep.hpp"
21 : #include "Evolution/DgSubcell/Actions/TciAndRollback.hpp"
22 : #include "Evolution/DgSubcell/Actions/TciAndSwitchToDg.hpp"
23 : #include "Evolution/DgSubcell/DisableLts.hpp"
24 : #include "Evolution/DgSubcell/GetTciDecision.hpp"
25 : #include "Evolution/DgSubcell/NeighborReconstructedFaceSolution.hpp"
26 : #include "Evolution/DgSubcell/NeighborTciDecision.hpp"
27 : #include "Evolution/DgSubcell/PrepareNeighborData.hpp"
28 : #include "Evolution/DgSubcell/Tags/ObserverCoordinates.hpp"
29 : #include "Evolution/DgSubcell/Tags/ObserverMesh.hpp"
30 : #include "Evolution/DgSubcell/Tags/TciStatus.hpp"
31 : #include "Evolution/DiscontinuousGalerkin/Actions/ApplyBoundaryCorrections.hpp"
32 : #include "Evolution/DiscontinuousGalerkin/Actions/ComputeTimeDerivative.hpp"
33 : #include "Evolution/DiscontinuousGalerkin/CleanMortarHistory.hpp"
34 : #include "Evolution/DiscontinuousGalerkin/DgElementArray.hpp"
35 : #include "Evolution/DiscontinuousGalerkin/Initialization/Mortars.hpp"
36 : #include "Evolution/DiscontinuousGalerkin/Initialization/QuadratureTag.hpp"
37 : #include "Evolution/DiscontinuousGalerkin/Limiters/Minmod.hpp"
38 : #include "Evolution/DiscontinuousGalerkin/Limiters/Tags.hpp"
39 : #include "Evolution/Initialization/ConservativeSystem.hpp"
40 : #include "Evolution/Initialization/DgDomain.hpp"
41 : #include "Evolution/Initialization/Evolution.hpp"
42 : #include "Evolution/Initialization/Limiter.hpp"
43 : #include "Evolution/Initialization/SetVariables.hpp"
44 : #include "Evolution/Systems/Burgers/BoundaryConditions/Factory.hpp"
45 : #include "Evolution/Systems/Burgers/BoundaryCorrections/Factory.hpp"
46 : #include "Evolution/Systems/Burgers/FiniteDifference/Factory.hpp"
47 : #include "Evolution/Systems/Burgers/FiniteDifference/Tags.hpp"
48 : #include "Evolution/Systems/Burgers/Subcell/GhostData.hpp"
49 : #include "Evolution/Systems/Burgers/Subcell/NeighborPackagedData.hpp"
50 : #include "Evolution/Systems/Burgers/Subcell/SetInitialRdmpData.hpp"
51 : #include "Evolution/Systems/Burgers/Subcell/TciOnDgGrid.hpp"
52 : #include "Evolution/Systems/Burgers/Subcell/TciOnFdGrid.hpp"
53 : #include "Evolution/Systems/Burgers/Subcell/TimeDerivative.hpp"
54 : #include "Evolution/Systems/Burgers/System.hpp"
55 : #include "IO/Observer/Actions/RegisterEvents.hpp"
56 : #include "IO/Observer/Helpers.hpp"
57 : #include "IO/Observer/ObserverComponent.hpp"
58 : #include "NumericalAlgorithms/DiscontinuousGalerkin/Formulation.hpp"
59 : #include "NumericalAlgorithms/DiscontinuousGalerkin/Tags.hpp"
60 : #include "Options/Protocols/FactoryCreation.hpp"
61 : #include "Options/String.hpp"
62 : #include "Parallel/Local.hpp"
63 : #include "Parallel/Phase.hpp"
64 : #include "Parallel/PhaseControl/CheckpointAndExitAfterWallclock.hpp"
65 : #include "Parallel/PhaseControl/ExecutePhaseChange.hpp"
66 : #include "Parallel/PhaseControl/Factory.hpp"
67 : #include "Parallel/PhaseControl/VisitAndReturn.hpp"
68 : #include "Parallel/PhaseDependentActionList.hpp"
69 : #include "Parallel/Protocols/RegistrationMetavariables.hpp"
70 : #include "ParallelAlgorithms/Actions/AddComputeTags.hpp"
71 : #include "ParallelAlgorithms/Actions/InitializeItems.hpp"
72 : #include "ParallelAlgorithms/Actions/LimiterActions.hpp"
73 : #include "ParallelAlgorithms/Actions/MutateApply.hpp"
74 : #include "ParallelAlgorithms/Actions/TerminatePhase.hpp"
75 : #include "ParallelAlgorithms/Events/Completion.hpp"
76 : #include "ParallelAlgorithms/Events/Factory.hpp"
77 : #include "ParallelAlgorithms/Events/Tags.hpp"
78 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTrigger.hpp"
79 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTriggers/Factory.hpp"
80 : #include "ParallelAlgorithms/EventsAndTriggers/Event.hpp"
81 : #include "ParallelAlgorithms/EventsAndTriggers/EventsAndTriggers.hpp"
82 : #include "ParallelAlgorithms/EventsAndTriggers/LogicalTriggers.hpp"
83 : #include "ParallelAlgorithms/EventsAndTriggers/Trigger.hpp"
84 : #include "PointwiseFunctions/AnalyticData/AnalyticData.hpp"
85 : #include "PointwiseFunctions/AnalyticData/Burgers/Factory.hpp"
86 : #include "PointwiseFunctions/AnalyticData/Burgers/Sinusoid.hpp"
87 : #include "PointwiseFunctions/AnalyticSolutions/AnalyticSolution.hpp"
88 : #include "PointwiseFunctions/AnalyticSolutions/Burgers/Bump.hpp"
89 : #include "PointwiseFunctions/AnalyticSolutions/Burgers/Factory.hpp"
90 : #include "PointwiseFunctions/AnalyticSolutions/Burgers/Linear.hpp"
91 : #include "PointwiseFunctions/AnalyticSolutions/Burgers/Step.hpp"
92 : #include "PointwiseFunctions/AnalyticSolutions/Tags.hpp"
93 : #include "Time/Actions/SelfStartActions.hpp"
94 : #include "Time/AdvanceTime.hpp"
95 : #include "Time/ChangeSlabSize/Action.hpp"
96 : #include "Time/ChangeStepSize.hpp"
97 : #include "Time/ChangeTimeStepperOrder.hpp"
98 : #include "Time/CleanHistory.hpp"
99 : #include "Time/RecordTimeStepperData.hpp"
100 : #include "Time/StepChoosers/Factory.hpp"
101 : #include "Time/StepChoosers/FixedLtsRatio.hpp"
102 : #include "Time/StepChoosers/StepChooser.hpp"
103 : #include "Time/Tags/Time.hpp"
104 : #include "Time/Tags/TimeStepId.hpp"
105 : #include "Time/TimeSequence.hpp"
106 : #include "Time/TimeSteppers/Factory.hpp"
107 : #include "Time/TimeSteppers/LtsTimeStepper.hpp"
108 : #include "Time/TimeSteppers/TimeStepper.hpp"
109 : #include "Time/Triggers/TimeTriggers.hpp"
110 : #include "Time/UpdateU.hpp"
111 : #include "Utilities/ProtocolHelpers.hpp"
112 : #include "Utilities/TMPL.hpp"
113 :
114 : /// \cond
115 : namespace PUP {
116 : class er;
117 : } // namespace PUP
118 : namespace Parallel {
119 : template <typename Metavariables>
120 : class CProxy_GlobalCache;
121 : } // namespace Parallel
122 : /// \endcond
123 :
124 0 : struct EvolutionMetavars {
125 0 : static constexpr size_t volume_dim = 1;
126 0 : using system = Burgers::System;
127 0 : using temporal_id = Tags::TimeStepId;
128 0 : using TimeStepperBase = TimeStepper;
129 :
130 0 : static constexpr bool local_time_stepping =
131 : TimeStepperBase::local_time_stepping;
132 0 : static constexpr bool use_dg_element_collection = false;
133 :
134 : // The use_dg_subcell flag controls whether to use "standard" limiting (false)
135 : // or a DG-FD hybrid scheme (true).
136 0 : static constexpr bool use_dg_subcell = true;
137 :
138 0 : using initial_data_list = tmpl::append<Burgers::Solutions::all_solutions,
139 : Burgers::AnalyticData::all_data>;
140 :
141 0 : using limiter =
142 : Tags::Limiter<Limiters::Minmod<1, system::variables_tag::tags_list>>;
143 :
144 0 : using analytic_variables_tags = typename system::variables_tag::tags_list;
145 0 : using analytic_compute = evolution::Tags::AnalyticSolutionsCompute<
146 : volume_dim, analytic_variables_tags, use_dg_subcell, initial_data_list>;
147 0 : using error_compute = Tags::ErrorsCompute<analytic_variables_tags>;
148 0 : using error_tags = db::wrap_tags_in<Tags::Error, analytic_variables_tags>;
149 0 : using observe_fields = tmpl::push_back<
150 : tmpl::append<
151 : typename system::variables_tag::tags_list, error_tags,
152 : tmpl::conditional_t<use_dg_subcell,
153 : tmpl::list<evolution::dg::subcell::Tags::
154 : TciStatusCompute<volume_dim>>,
155 : tmpl::list<>>>,
156 : ::Events::Tags::ObserverDetInvJacobianCompute<Frame::ElementLogical,
157 : Frame::Inertial>,
158 : tmpl::conditional_t<
159 : use_dg_subcell,
160 : evolution::dg::subcell::Tags::ObserverCoordinatesCompute<volume_dim,
161 : Frame::Grid>,
162 : domain::Tags::Coordinates<volume_dim, Frame::Grid>>,
163 : tmpl::conditional_t<
164 : use_dg_subcell,
165 : evolution::dg::subcell::Tags::ObserverCoordinatesCompute<
166 : volume_dim, Frame::Inertial>,
167 : domain::Tags::Coordinates<volume_dim, Frame::Inertial>>>;
168 0 : using non_tensor_compute_tags = tmpl::list<
169 : tmpl::conditional_t<
170 : use_dg_subcell,
171 : evolution::dg::subcell::Tags::ObserverMeshCompute<volume_dim>,
172 : ::Events::Tags::ObserverMeshCompute<volume_dim>>,
173 : analytic_compute, error_compute>;
174 :
175 0 : struct factory_creation
176 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
177 0 : using factory_classes = tmpl::map<
178 : tmpl::pair<Burgers::BoundaryConditions::BoundaryCondition,
179 : Burgers::BoundaryConditions::standard_boundary_conditions>,
180 : tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
181 : tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
182 : tmpl::pair<Event,
183 : tmpl::flatten<tmpl::list<
184 : Events::Completion,
185 : dg::Events::field_observations<
186 : volume_dim, observe_fields, non_tensor_compute_tags>,
187 : Events::time_events<system>>>>,
188 : tmpl::pair<evolution::BoundaryCorrection,
189 : Burgers::BoundaryCorrections::standard_boundary_corrections>,
190 : tmpl::pair<evolution::initial_data::InitialData, initial_data_list>,
191 : tmpl::pair<LtsTimeStepper, TimeSteppers::lts_time_steppers>,
192 : tmpl::pair<PhaseChange, PhaseControl::factory_creatable_classes>,
193 : tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
194 : StepChoosers::standard_step_choosers<system>>,
195 : tmpl::pair<StepChooser<StepChooserUse::Slab>,
196 : tmpl::append<StepChoosers::standard_slab_choosers<
197 : system, local_time_stepping>,
198 : tmpl::conditional_t<
199 : use_dg_subcell and local_time_stepping,
200 : tmpl::list<StepChoosers::FixedLtsRatio>,
201 : tmpl::list<>>>>,
202 : tmpl::pair<TimeSequence<double>,
203 : TimeSequences::all_time_sequences<double>>,
204 : tmpl::pair<TimeSequence<std::uint64_t>,
205 : TimeSequences::all_time_sequences<std::uint64_t>>,
206 : tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
207 : tmpl::pair<Trigger, tmpl::append<Triggers::logical_triggers,
208 : Triggers::time_triggers>>>;
209 : };
210 :
211 0 : struct SubcellOptions {
212 0 : static constexpr bool subcell_enabled = use_dg_subcell;
213 0 : static constexpr bool subcell_enabled_at_external_boundary = true;
214 :
215 : // We send `ghost_zone_size` cell-centered grid points for variable
216 : // reconstruction, of which we need `ghost_zone_size-1` for reconstruction
217 : // to the internal side of the element face, and `ghost_zone_size` for
218 : // reconstruction to the external side of the element face.
219 : template <typename DbTagsList>
220 0 : static constexpr size_t ghost_zone_size(
221 : const db::DataBox<DbTagsList>& box) {
222 : return db::get<Burgers::fd::Tags::Reconstructor>(box).ghost_zone_size();
223 : }
224 :
225 0 : using DgComputeSubcellNeighborPackagedData =
226 : Burgers::subcell::NeighborPackagedData;
227 :
228 0 : using GhostVariables = Burgers::subcell::GhostVariables;
229 : };
230 :
231 0 : using observed_reduction_data_tags =
232 : observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
233 : tmpl::at<typename factory_creation::factory_classes, Event>>>>;
234 :
235 0 : using dg_step_actions = tmpl::flatten<tmpl::list<
236 : evolution::dg::Actions::ComputeTimeDerivative<
237 : volume_dim, system, AllStepChoosers, local_time_stepping,
238 : use_dg_element_collection>,
239 : evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
240 : volume_dim, use_dg_element_collection>,
241 : Actions::MutateApply<RecordTimeStepperData<system>>,
242 : tmpl::conditional_t<
243 : local_time_stepping,
244 : tmpl::list<evolution::Actions::RunEventsAndDenseTriggers<
245 : tmpl::list<evolution::dg::ApplyBoundaryCorrections<
246 : local_time_stepping, EvolutionMetavars, volume_dim,
247 : true>>>,
248 : Actions::MutateApply<UpdateU<system, local_time_stepping>>,
249 : evolution::dg::Actions::ApplyLtsBoundaryCorrections<
250 : volume_dim, false, use_dg_element_collection>,
251 : Actions::MutateApply<ChangeTimeStepperOrder<system>>>,
252 : tmpl::list<
253 : evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<>>,
254 : Actions::MutateApply<UpdateU<system, local_time_stepping>>>>,
255 : tmpl::conditional_t<use_dg_subcell,
256 : evolution::dg::subcell::Actions::TciAndRollback<
257 : Burgers::subcell::TciOnDgGrid>,
258 : tmpl::list<>>,
259 : Actions::MutateApply<CleanHistory<system>>,
260 : tmpl::conditional_t<
261 : local_time_stepping,
262 : Actions::MutateApply<evolution::dg::CleanMortarHistory<volume_dim>>,
263 : tmpl::list<>>,
264 : tmpl::conditional_t<use_dg_subcell, tmpl::list<>,
265 : tmpl::list<
266 : Limiters::Actions::SendData<EvolutionMetavars>,
267 : Limiters::Actions::Limit<EvolutionMetavars>>>>>;
268 :
269 0 : using dg_subcell_step_actions = tmpl::flatten<tmpl::list<
270 : evolution::dg::subcell::Actions::SelectNumericalMethod,
271 : Actions::Label<evolution::dg::subcell::Actions::Labels::BeginDg>,
272 : dg_step_actions,
273 : Actions::Goto<evolution::dg::subcell::Actions::Labels::EndOfSolvers>,
274 : Actions::Label<evolution::dg::subcell::Actions::Labels::BeginSubcell>,
275 : tmpl::conditional_t<local_time_stepping,
276 : // This is just to adjust for FixedLtsRatio, so we
277 : // can pass an empty list of StepChoosers.
278 : Actions::MutateApply<ChangeStepSize<tmpl::list<>>>,
279 : tmpl::list<>>,
280 : evolution::dg::subcell::Actions::SendDataForReconstruction<
281 : volume_dim, Burgers::subcell::GhostVariables,
282 : use_dg_element_collection>,
283 : evolution::dg::subcell::Actions::ReceiveDataForReconstruction<volume_dim>,
284 : Actions::Label<
285 : evolution::dg::subcell::Actions::Labels::BeginSubcellAfterDgRollback>,
286 : evolution::dg::subcell::fd::Actions::TakeTimeStep<
287 : Burgers::subcell::TimeDerivative>,
288 : Actions::MutateApply<RecordTimeStepperData<system>>,
289 : evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<>>,
290 : Actions::MutateApply<UpdateU<system, local_time_stepping>>,
291 : Actions::MutateApply<CleanHistory<system>>,
292 : tmpl::conditional_t<
293 : local_time_stepping,
294 : Actions::MutateApply<evolution::dg::CleanMortarHistory<volume_dim>>,
295 : tmpl::list<>>,
296 : evolution::dg::subcell::Actions::TciAndSwitchToDg<
297 : Burgers::subcell::TciOnFdGrid>,
298 : Actions::Label<evolution::dg::subcell::Actions::Labels::EndOfSolvers>>>;
299 :
300 0 : using step_actions =
301 : tmpl::conditional_t<use_dg_subcell, dg_subcell_step_actions,
302 : dg_step_actions>;
303 :
304 0 : using const_global_cache_tags = tmpl::list<
305 : evolution::initial_data::Tags::InitialData,
306 : tmpl::conditional_t<use_dg_subcell,
307 : tmpl::list<Burgers::fd::Tags::Reconstructor>,
308 : tmpl::list<>>>;
309 :
310 0 : using dg_registration_list =
311 : tmpl::list<observers::Actions::RegisterEventsWithObservers>;
312 :
313 0 : using initialization_actions = tmpl::list<
314 : Initialization::Actions::InitializeItems<
315 : Initialization::TimeStepping<EvolutionMetavars, TimeStepperBase>,
316 : evolution::dg::Initialization::Domain<EvolutionMetavars>,
317 : Initialization::TimeStepperHistory<EvolutionMetavars>>,
318 : Initialization::Actions::ConservativeSystem<system>,
319 :
320 : tmpl::conditional_t<
321 : use_dg_subcell,
322 : tmpl::list<
323 : evolution::dg::subcell::Actions::SetSubcellGrid<volume_dim,
324 : system, false>,
325 : evolution::dg::subcell::Actions::SetAndCommunicateInitialRdmpData<
326 : volume_dim, Burgers::subcell::SetInitialRdmpData>,
327 : evolution::dg::subcell::Actions::ComputeAndSendTciOnInitialGrid<
328 : volume_dim, system, Burgers::subcell::TciOnFdGrid>,
329 : evolution::dg::subcell::Actions::SetInitialGridFromTciData<
330 : volume_dim, system>>,
331 : tmpl::list<evolution::Initialization::Actions::SetVariables<
332 : domain::Tags::Coordinates<1, Frame::ElementLogical>>>>,
333 :
334 : Initialization::Actions::AddComputeTags<
335 : StepChoosers::step_chooser_compute_tags<EvolutionMetavars,
336 : local_time_stepping>>,
337 : ::evolution::dg::Initialization::Mortars<volume_dim>,
338 : tmpl::conditional_t<use_dg_subcell and local_time_stepping,
339 : Initialization::Actions::InitializeItems<
340 : evolution::dg::subcell::DisableLts<1>>,
341 : tmpl::list<>>,
342 : tmpl::conditional_t<use_dg_subcell, tmpl::list<>,
343 : Initialization::Actions::Minmod<1>>,
344 : evolution::Actions::InitializeRunEventsAndDenseTriggers,
345 : Parallel::Actions::TerminatePhase>;
346 :
347 0 : using dg_element_array = DgElementArray<
348 : EvolutionMetavars,
349 : tmpl::list<
350 : Parallel::PhaseActions<Parallel::Phase::Initialization,
351 : initialization_actions>,
352 :
353 : Parallel::PhaseActions<Parallel::Phase::Register,
354 : tmpl::list<dg_registration_list,
355 : Parallel::Actions::TerminatePhase>>,
356 :
357 : Parallel::PhaseActions<Parallel::Phase::Restart,
358 : tmpl::list<dg_registration_list,
359 : Parallel::Actions::TerminatePhase>>,
360 :
361 : Parallel::PhaseActions<
362 : Parallel::Phase::WriteCheckpoint,
363 : tmpl::list<evolution::Actions::RunEventsAndTriggers<
364 : Triggers::WhenToCheck::AtCheckpoints>,
365 : Parallel::Actions::TerminatePhase>>,
366 :
367 : Parallel::PhaseActions<
368 : Parallel::Phase::InitializeTimeStepperHistory,
369 : SelfStart::self_start_procedure<step_actions, system>>,
370 :
371 : Parallel::PhaseActions<
372 : Parallel::Phase::Evolve,
373 : tmpl::flatten<tmpl::list<
374 : std::conditional_t<local_time_stepping,
375 : evolution::Actions::RunEventsAndTriggers<
376 : Triggers::WhenToCheck::AtSteps>,
377 : tmpl::list<>>,
378 : evolution::Actions::RunEventsAndTriggers<
379 : Triggers::WhenToCheck::AtSlabs>,
380 : Actions::ChangeSlabSize, step_actions,
381 : Actions::MutateApply<AdvanceTime<>>,
382 : PhaseControl::Actions::ExecutePhaseChange>>>>>;
383 :
384 0 : struct registration
385 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
386 0 : using element_registrars =
387 : tmpl::map<tmpl::pair<dg_element_array, dg_registration_list>>;
388 : };
389 :
390 0 : using component_list =
391 : tmpl::list<observers::Observer<EvolutionMetavars>,
392 : observers::ObserverWriter<EvolutionMetavars>,
393 : dg_element_array>;
394 :
395 0 : static constexpr Options::String help{
396 : "Evolve the Burgers equation.\n\n"
397 : "The analytic solution is: Linear\n"
398 : "The numerical flux is: LocalLaxFriedrichs\n"};
399 :
400 0 : static constexpr std::array<Parallel::Phase, 5> default_phase_order{
401 : {Parallel::Phase::Initialization,
402 : Parallel::Phase::InitializeTimeStepperHistory, Parallel::Phase::Register,
403 : Parallel::Phase::Evolve, Parallel::Phase::Exit}};
404 :
405 : // NOLINTNEXTLINE(google-runtime-references)
406 0 : void pup(PUP::er& /*p*/) {}
407 : };
|
