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