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