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/Creators/Factory2D.hpp"
12 : #include "Domain/Tags.hpp"
13 : #include "Evolution/Actions/RunEventsAndDenseTriggers.hpp"
14 : #include "Evolution/Actions/RunEventsAndTriggers.hpp"
15 : #include "Evolution/BoundaryCorrection.hpp"
16 : #include "Evolution/ComputeTags.hpp"
17 : #include "Evolution/DgSubcell/Actions/Initialize.hpp"
18 : #include "Evolution/DgSubcell/Actions/Labels.hpp"
19 : #include "Evolution/DgSubcell/Actions/ReconstructionCommunication.hpp"
20 : #include "Evolution/DgSubcell/Actions/SelectNumericalMethod.hpp"
21 : #include "Evolution/DgSubcell/Actions/TakeTimeStep.hpp"
22 : #include "Evolution/DgSubcell/Actions/TciAndRollback.hpp"
23 : #include "Evolution/DgSubcell/Actions/TciAndSwitchToDg.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/ScalarAdvection/BoundaryConditions/Factory.hpp"
45 : #include "Evolution/Systems/ScalarAdvection/BoundaryCorrections/Factory.hpp"
46 : #include "Evolution/Systems/ScalarAdvection/FiniteDifference/Factory.hpp"
47 : #include "Evolution/Systems/ScalarAdvection/FiniteDifference/Tags.hpp"
48 : #include "Evolution/Systems/ScalarAdvection/Subcell/GhostData.hpp"
49 : #include "Evolution/Systems/ScalarAdvection/Subcell/NeighborPackagedData.hpp"
50 : #include "Evolution/Systems/ScalarAdvection/Subcell/SetInitialRdmpData.hpp"
51 : #include "Evolution/Systems/ScalarAdvection/Subcell/TciOnDgGrid.hpp"
52 : #include "Evolution/Systems/ScalarAdvection/Subcell/TciOnFdGrid.hpp"
53 : #include "Evolution/Systems/ScalarAdvection/Subcell/TciOptions.hpp"
54 : #include "Evolution/Systems/ScalarAdvection/Subcell/TimeDerivative.hpp"
55 : #include "Evolution/Systems/ScalarAdvection/Subcell/VelocityAtFace.hpp"
56 : #include "Evolution/Systems/ScalarAdvection/System.hpp"
57 : #include "Evolution/Systems/ScalarAdvection/VelocityField.hpp"
58 : #include "IO/Observer/Actions/RegisterEvents.hpp"
59 : #include "IO/Observer/Helpers.hpp"
60 : #include "IO/Observer/ObserverComponent.hpp"
61 : #include "NumericalAlgorithms/DiscontinuousGalerkin/Formulation.hpp"
62 : #include "NumericalAlgorithms/DiscontinuousGalerkin/Tags.hpp"
63 : #include "Options/Protocols/FactoryCreation.hpp"
64 : #include "Options/String.hpp"
65 : #include "Parallel/Local.hpp"
66 : #include "Parallel/Phase.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/AddSimpleTags.hpp"
74 : #include "ParallelAlgorithms/Actions/InitializeItems.hpp"
75 : #include "ParallelAlgorithms/Actions/LimiterActions.hpp"
76 : #include "ParallelAlgorithms/Actions/MutateApply.hpp"
77 : #include "ParallelAlgorithms/Actions/TerminatePhase.hpp"
78 : #include "ParallelAlgorithms/Events/Factory.hpp"
79 : #include "ParallelAlgorithms/Events/Tags.hpp"
80 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTrigger.hpp"
81 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTriggers/Factory.hpp"
82 : #include "ParallelAlgorithms/EventsAndTriggers/Completion.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/AnalyticSolutions/AnalyticSolution.hpp"
89 : #include "PointwiseFunctions/AnalyticSolutions/ScalarAdvection/Krivodonova.hpp"
90 : #include "PointwiseFunctions/AnalyticSolutions/ScalarAdvection/Kuzmin.hpp"
91 : #include "PointwiseFunctions/AnalyticSolutions/ScalarAdvection/Sinusoid.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/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 : template <size_t Dim>
122 : struct EvolutionMetavars {
123 : static constexpr size_t volume_dim = Dim;
124 0 : using system = ScalarAdvection::System<Dim>;
125 0 : using temporal_id = Tags::TimeStepId;
126 0 : using TimeStepperBase = TimeStepper;
127 :
128 : static constexpr bool local_time_stepping =
129 : TimeStepperBase::local_time_stepping;
130 : static constexpr bool use_dg_element_collection = false;
131 :
132 : // The use_dg_subcell flag controls whether to use "standard" limiting (false)
133 : // or a DG-FD hybrid scheme (true).
134 : static constexpr bool use_dg_subcell = true;
135 :
136 0 : using initial_data_list =
137 : tmpl::conditional_t<Dim == 1,
138 : tmpl::list<ScalarAdvection::Solutions::Krivodonova,
139 : ScalarAdvection::Solutions::Sinusoid>,
140 : tmpl::list<ScalarAdvection::Solutions::Kuzmin>>;
141 :
142 0 : using limiter = Tags::Limiter<
143 : Limiters::Minmod<Dim, typename system::variables_tag::tags_list>>;
144 :
145 0 : using analytic_variables_tags = typename system::variables_tag::tags_list;
146 0 : using analytic_compute = evolution::Tags::AnalyticSolutionsCompute<
147 : volume_dim, analytic_variables_tags, use_dg_subcell, initial_data_list>;
148 0 : using error_compute = Tags::ErrorsCompute<analytic_variables_tags>;
149 0 : using error_tags = db::wrap_tags_in<Tags::Error, analytic_variables_tags>;
150 0 : using observe_fields = tmpl::push_back<
151 : tmpl::append<
152 : typename system::variables_tag::tags_list, error_tags,
153 : tmpl::conditional_t<use_dg_subcell,
154 : tmpl::list<evolution::dg::subcell::Tags::
155 : TciStatusCompute<volume_dim>>,
156 : tmpl::list<>>>,
157 : tmpl::conditional_t<
158 : use_dg_subcell,
159 : evolution::dg::subcell::Tags::ObserverCoordinatesCompute<
160 : volume_dim, Frame::ElementLogical>,
161 : ::Events::Tags::ObserverCoordinatesCompute<volume_dim,
162 : Frame::ElementLogical>>,
163 : tmpl::conditional_t<
164 : use_dg_subcell,
165 : evolution::dg::subcell::Tags::ObserverCoordinatesCompute<volume_dim,
166 : Frame::Grid>,
167 : domain::Tags::Coordinates<volume_dim, Frame::Grid>>,
168 : tmpl::conditional_t<
169 : use_dg_subcell,
170 : evolution::dg::subcell::Tags::ObserverCoordinatesCompute<
171 : volume_dim, Frame::Inertial>,
172 : domain::Tags::Coordinates<volume_dim, Frame::Inertial>>>;
173 0 : using non_tensor_compute_tags = tmpl::list<
174 : tmpl::conditional_t<
175 : use_dg_subcell,
176 : tmpl::list<
177 : evolution::dg::subcell::Tags::ObserverMeshCompute<volume_dim>,
178 : evolution::dg::subcell::Tags::ObserverInverseJacobianCompute<
179 : volume_dim, Frame::ElementLogical, Frame::Inertial>,
180 : evolution::dg::subcell::Tags::
181 : ObserverJacobianAndDetInvJacobianCompute<
182 : volume_dim, Frame::ElementLogical, Frame::Inertial>>,
183 : tmpl::list<::Events::Tags::ObserverMeshCompute<volume_dim>,
184 : ::Events::Tags::ObserverInverseJacobianCompute<
185 : volume_dim, Frame::ElementLogical, Frame::Inertial>,
186 : ::Events::Tags::ObserverJacobianCompute<
187 : volume_dim, Frame::ElementLogical, Frame::Inertial>,
188 : ::Events::Tags::ObserverDetInvJacobianCompute<
189 : Frame::ElementLogical, Frame::Inertial>>>,
190 : tmpl::list<analytic_compute, error_compute>>;
191 :
192 : struct factory_creation
193 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
194 0 : using factory_classes = tmpl::map<
195 : tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
196 : tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
197 : tmpl::pair<Event,
198 : tmpl::flatten<tmpl::list<
199 : Events::Completion,
200 : dg::Events::field_observations<
201 : volume_dim, observe_fields, non_tensor_compute_tags>,
202 : Events::time_events<system>>>>,
203 : tmpl::pair<evolution::BoundaryCorrection,
204 : ScalarAdvection::BoundaryCorrections::
205 : standard_boundary_corrections<Dim>>,
206 : tmpl::pair<evolution::initial_data::InitialData, initial_data_list>,
207 : tmpl::pair<LtsTimeStepper, TimeSteppers::lts_time_steppers>,
208 : tmpl::pair<PhaseChange, PhaseControl::factory_creatable_classes>,
209 : tmpl::pair<ScalarAdvection::BoundaryConditions::BoundaryCondition<Dim>,
210 : ScalarAdvection::BoundaryConditions::
211 : standard_boundary_conditions<Dim>>,
212 : tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
213 : StepChoosers::standard_step_choosers<system>>,
214 : tmpl::pair<
215 : StepChooser<StepChooserUse::Slab>,
216 : StepChoosers::standard_slab_choosers<system, local_time_stepping>>,
217 : tmpl::pair<TimeSequence<double>,
218 : TimeSequences::all_time_sequences<double>>,
219 : tmpl::pair<TimeSequence<std::uint64_t>,
220 : TimeSequences::all_time_sequences<std::uint64_t>>,
221 : tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
222 : tmpl::pair<Trigger, tmpl::append<Triggers::logical_triggers,
223 : Triggers::time_triggers>>>;
224 : };
225 :
226 : struct SubcellOptions {
227 : static constexpr bool subcell_enabled = use_dg_subcell;
228 : static constexpr bool subcell_enabled_at_external_boundary = false;
229 :
230 : // We send `ghost_zone_size` cell-centered grid points for variable
231 : // reconstruction, of which we need `ghost_zone_size-1` for reconstruction
232 : // to the internal side of the element face, and `ghost_zone_size` for
233 : // reconstruction to the external side of the element face.
234 : template <typename DbTagsList>
235 0 : static constexpr size_t ghost_zone_size(
236 : const db::DataBox<DbTagsList>& box) {
237 : return db::get<ScalarAdvection::fd::Tags::Reconstructor<volume_dim>>(box)
238 : .ghost_zone_size();
239 : }
240 :
241 0 : using DgComputeSubcellNeighborPackagedData =
242 : ScalarAdvection::subcell::NeighborPackagedData;
243 :
244 0 : using GhostVariables = ScalarAdvection::subcell::GhostVariables;
245 : };
246 :
247 0 : using observed_reduction_data_tags =
248 : observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
249 : tmpl::at<typename factory_creation::factory_classes, Event>>>>;
250 :
251 0 : using dg_step_actions = tmpl::flatten<tmpl::list<
252 : evolution::dg::Actions::ComputeTimeDerivative<
253 : volume_dim, system, AllStepChoosers, local_time_stepping,
254 : use_dg_element_collection>,
255 : evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
256 : volume_dim, false, use_dg_element_collection>,
257 : Actions::MutateApply<RecordTimeStepperData<system>>,
258 : evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<>>,
259 : Actions::MutateApply<UpdateU<system, local_time_stepping>>,
260 : Actions::MutateApply<CleanHistory<system>>,
261 : tmpl::conditional_t<
262 : local_time_stepping,
263 : Actions::MutateApply<evolution::dg::CleanMortarHistory<system>>,
264 : tmpl::list<>>,
265 : Limiters::Actions::SendData<EvolutionMetavars>,
266 : Limiters::Actions::Limit<EvolutionMetavars>>>;
267 :
268 0 : using dg_subcell_step_actions = tmpl::flatten<tmpl::list<
269 : evolution::dg::subcell::Actions::SelectNumericalMethod,
270 : Actions::Label<evolution::dg::subcell::Actions::Labels::BeginDg>,
271 :
272 : evolution::dg::Actions::ComputeTimeDerivative<
273 : volume_dim, system, AllStepChoosers, local_time_stepping,
274 : use_dg_element_collection>,
275 : evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
276 : volume_dim, false, use_dg_element_collection>,
277 : Actions::MutateApply<RecordTimeStepperData<system>>,
278 : evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<>>,
279 : Actions::MutateApply<UpdateU<system, local_time_stepping>>,
280 : evolution::dg::subcell::Actions::TciAndRollback<
281 : ScalarAdvection::subcell::TciOnDgGrid<Dim>>,
282 : Actions::MutateApply<CleanHistory<system>>,
283 : tmpl::conditional_t<
284 : local_time_stepping,
285 : Actions::MutateApply<evolution::dg::CleanMortarHistory<system>>,
286 : tmpl::list<>>,
287 : Actions::Goto<evolution::dg::subcell::Actions::Labels::EndOfSolvers>,
288 : Actions::Label<evolution::dg::subcell::Actions::Labels::BeginSubcell>,
289 : evolution::dg::subcell::Actions::SendDataForReconstruction<
290 : volume_dim, ScalarAdvection::subcell::GhostVariables,
291 : local_time_stepping, use_dg_element_collection>,
292 : evolution::dg::subcell::Actions::ReceiveDataForReconstruction<volume_dim>,
293 : Actions::Label<
294 : evolution::dg::subcell::Actions::Labels::BeginSubcellAfterDgRollback>,
295 : evolution::dg::subcell::fd::Actions::TakeTimeStep<
296 : ScalarAdvection::subcell::TimeDerivative<volume_dim>>,
297 : Actions::MutateApply<RecordTimeStepperData<system>>,
298 : Actions::MutateApply<UpdateU<system, local_time_stepping>>,
299 : Actions::MutateApply<CleanHistory<system>>,
300 : tmpl::conditional_t<
301 : local_time_stepping,
302 : Actions::MutateApply<evolution::dg::CleanMortarHistory<system>>,
303 : tmpl::list<>>,
304 : evolution::dg::subcell::Actions::TciAndSwitchToDg<
305 : ScalarAdvection::subcell::TciOnFdGrid<volume_dim>>,
306 : Actions::Label<evolution::dg::subcell::Actions::Labels::EndOfSolvers>>>;
307 :
308 0 : using step_actions =
309 : tmpl::conditional_t<use_dg_subcell, dg_subcell_step_actions,
310 : dg_step_actions>;
311 :
312 0 : using const_global_cache_tags =
313 : tmpl::list<evolution::initial_data::Tags::InitialData,
314 : tmpl::conditional_t<
315 : use_dg_subcell,
316 : tmpl::list<ScalarAdvection::fd::Tags::Reconstructor<Dim>,
317 : ScalarAdvection::subcell::Tags::TciOptions>,
318 : tmpl::list<>>>;
319 :
320 0 : using dg_registration_list =
321 : tmpl::list<observers::Actions::RegisterEventsWithObservers>;
322 :
323 0 : using initialization_actions = tmpl::list<
324 : Initialization::Actions::InitializeItems<
325 : Initialization::TimeStepping<EvolutionMetavars, TimeStepperBase>,
326 : evolution::dg::Initialization::Domain<EvolutionMetavars>,
327 : Initialization::TimeStepperHistory<EvolutionMetavars>>,
328 : Initialization::Actions::ConservativeSystem<system>,
329 :
330 : tmpl::conditional_t<
331 : use_dg_subcell,
332 : tmpl::list<
333 : evolution::dg::subcell::Actions::SetSubcellGrid<volume_dim,
334 : system, false>,
335 : Initialization::Actions::AddSimpleTags<
336 : ScalarAdvection::subcell::VelocityAtFace<volume_dim>>,
337 : evolution::dg::subcell::Actions::SetAndCommunicateInitialRdmpData<
338 : volume_dim,
339 : ScalarAdvection::subcell::SetInitialRdmpData<volume_dim>>,
340 : evolution::dg::subcell::Actions::ComputeAndSendTciOnInitialGrid<
341 : volume_dim, system,
342 : ScalarAdvection::subcell::TciOnFdGrid<volume_dim>>,
343 : evolution::dg::subcell::Actions::SetInitialGridFromTciData<
344 : volume_dim, system>>,
345 : tmpl::list<evolution::Initialization::Actions::SetVariables<
346 : domain::Tags::Coordinates<Dim, Frame::ElementLogical>>>>,
347 :
348 : Initialization::Actions::AddComputeTags<
349 : tmpl::list<ScalarAdvection::Tags::VelocityFieldCompute<Dim>>>,
350 : Initialization::Actions::AddComputeTags<
351 : StepChoosers::step_chooser_compute_tags<EvolutionMetavars,
352 : local_time_stepping>>,
353 : ::evolution::dg::Initialization::Mortars<volume_dim, system>,
354 : Initialization::Actions::Minmod<Dim>,
355 : evolution::Actions::InitializeRunEventsAndDenseTriggers,
356 : Parallel::Actions::TerminatePhase>;
357 :
358 0 : using dg_element_array = DgElementArray<
359 : EvolutionMetavars,
360 : tmpl::list<
361 : Parallel::PhaseActions<Parallel::Phase::Initialization,
362 : initialization_actions>,
363 :
364 : Parallel::PhaseActions<Parallel::Phase::Register,
365 : tmpl::list<dg_registration_list,
366 : Parallel::Actions::TerminatePhase>>,
367 :
368 : Parallel::PhaseActions<Parallel::Phase::Restart,
369 : tmpl::list<dg_registration_list,
370 : Parallel::Actions::TerminatePhase>>,
371 :
372 : Parallel::PhaseActions<
373 : Parallel::Phase::WriteCheckpoint,
374 : tmpl::list<evolution::Actions::RunEventsAndTriggers<
375 : Triggers::WhenToCheck::AtCheckpoints>,
376 : Parallel::Actions::TerminatePhase>>,
377 :
378 : Parallel::PhaseActions<
379 : Parallel::Phase::InitializeTimeStepperHistory,
380 : SelfStart::self_start_procedure<step_actions, system>>,
381 :
382 : Parallel::PhaseActions<
383 : Parallel::Phase::Evolve,
384 : tmpl::flatten<tmpl::list<
385 : std::conditional_t<local_time_stepping,
386 : evolution::Actions::RunEventsAndTriggers<
387 : Triggers::WhenToCheck::AtSteps>,
388 : tmpl::list<>>,
389 : evolution::Actions::RunEventsAndTriggers<
390 : Triggers::WhenToCheck::AtSlabs>,
391 : Actions::ChangeSlabSize, step_actions,
392 : Actions::MutateApply<AdvanceTime>,
393 : PhaseControl::Actions::ExecutePhaseChange>>>>>;
394 :
395 : struct registration
396 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
397 0 : using element_registrars =
398 : tmpl::map<tmpl::pair<dg_element_array, dg_registration_list>>;
399 : };
400 :
401 0 : using component_list =
402 : tmpl::list<observers::Observer<EvolutionMetavars>,
403 : observers::ObserverWriter<EvolutionMetavars>,
404 : dg_element_array>;
405 :
406 : static constexpr Options::String help{
407 : "Evolve the scalar advection equation.\n\n"};
408 :
409 : static constexpr std::array<Parallel::Phase, 5> default_phase_order{
410 : {Parallel::Phase::Initialization,
411 : Parallel::Phase::InitializeTimeStepperHistory, Parallel::Phase::Register,
412 : Parallel::Phase::Evolve, Parallel::Phase::Exit}};
413 :
414 : // NOLINTNEXTLINE(google-runtime-references)
415 0 : void pup(PUP::er& /*p*/) {}
416 : };
|
