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