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/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/DgElementArray.hpp" // IWYU pragma: keep
33 : #include "Evolution/DiscontinuousGalerkin/Initialization/Mortars.hpp"
34 : #include "Evolution/DiscontinuousGalerkin/Initialization/QuadratureTag.hpp"
35 : #include "Evolution/DiscontinuousGalerkin/Limiters/Minmod.hpp"
36 : #include "Evolution/DiscontinuousGalerkin/Limiters/Tags.hpp"
37 : #include "Evolution/Initialization/ConservativeSystem.hpp"
38 : #include "Evolution/Initialization/DgDomain.hpp"
39 : #include "Evolution/Initialization/Evolution.hpp"
40 : #include "Evolution/Initialization/Limiter.hpp"
41 : #include "Evolution/Initialization/SetVariables.hpp"
42 : #include "Evolution/Systems/ScalarAdvection/BoundaryConditions/Factory.hpp"
43 : #include "Evolution/Systems/ScalarAdvection/BoundaryCorrections/Factory.hpp"
44 : #include "Evolution/Systems/ScalarAdvection/FiniteDifference/Factory.hpp"
45 : #include "Evolution/Systems/ScalarAdvection/FiniteDifference/Tags.hpp"
46 : #include "Evolution/Systems/ScalarAdvection/Subcell/GhostData.hpp"
47 : #include "Evolution/Systems/ScalarAdvection/Subcell/NeighborPackagedData.hpp"
48 : #include "Evolution/Systems/ScalarAdvection/Subcell/SetInitialRdmpData.hpp"
49 : #include "Evolution/Systems/ScalarAdvection/Subcell/TciOnDgGrid.hpp"
50 : #include "Evolution/Systems/ScalarAdvection/Subcell/TciOnFdGrid.hpp"
51 : #include "Evolution/Systems/ScalarAdvection/Subcell/TciOptions.hpp"
52 : #include "Evolution/Systems/ScalarAdvection/Subcell/TimeDerivative.hpp"
53 : #include "Evolution/Systems/ScalarAdvection/Subcell/VelocityAtFace.hpp"
54 : #include "Evolution/Systems/ScalarAdvection/System.hpp"
55 : #include "Evolution/Systems/ScalarAdvection/VelocityField.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 "Options/Protocols/FactoryCreation.hpp"
62 : #include "Options/String.hpp"
63 : #include "Parallel/Local.hpp"
64 : #include "Parallel/Phase.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/AddSimpleTags.hpp"
72 : #include "ParallelAlgorithms/Actions/InitializeItems.hpp"
73 : #include "ParallelAlgorithms/Actions/LimiterActions.hpp"
74 : #include "ParallelAlgorithms/Actions/MutateApply.hpp"
75 : #include "ParallelAlgorithms/Actions/TerminatePhase.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/Completion.hpp"
81 : #include "ParallelAlgorithms/EventsAndTriggers/Event.hpp"
82 : #include "ParallelAlgorithms/EventsAndTriggers/EventsAndTriggers.hpp" // IWYU pragma: keep
83 : #include "ParallelAlgorithms/EventsAndTriggers/LogicalTriggers.hpp"
84 : #include "ParallelAlgorithms/EventsAndTriggers/Trigger.hpp"
85 : #include "PointwiseFunctions/AnalyticData/AnalyticData.hpp"
86 : #include "PointwiseFunctions/AnalyticSolutions/AnalyticSolution.hpp"
87 : #include "PointwiseFunctions/AnalyticSolutions/ScalarAdvection/Krivodonova.hpp" // IWYU pragma: keep
88 : #include "PointwiseFunctions/AnalyticSolutions/ScalarAdvection/Kuzmin.hpp" // IWYU pragma: keep
89 : #include "PointwiseFunctions/AnalyticSolutions/ScalarAdvection/Sinusoid.hpp" // IWYU pragma: keep
90 : #include "PointwiseFunctions/AnalyticSolutions/Tags.hpp"
91 : #include "Time/Actions/AdvanceTime.hpp" // IWYU pragma: keep
92 : #include "Time/Actions/RecordTimeStepperData.hpp" // IWYU pragma: keep
93 : #include "Time/Actions/SelfStartActions.hpp" // IWYU pragma: keep
94 : #include "Time/Actions/UpdateU.hpp" // IWYU pragma: keep
95 : #include "Time/ChangeSlabSize/Action.hpp"
96 : #include "Time/StepChoosers/Factory.hpp"
97 : #include "Time/StepChoosers/StepChooser.hpp"
98 : #include "Time/Tags/Time.hpp"
99 : #include "Time/Tags/TimeStepId.hpp"
100 : #include "Time/TimeSequence.hpp"
101 : #include "Time/TimeSteppers/Factory.hpp"
102 : #include "Time/TimeSteppers/LtsTimeStepper.hpp"
103 : #include "Time/TimeSteppers/TimeStepper.hpp"
104 : #include "Time/Triggers/TimeTriggers.hpp"
105 : #include "Utilities/ProtocolHelpers.hpp"
106 : #include "Utilities/TMPL.hpp"
107 :
108 : // IWYU pragma: no_include <pup.h>
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 : template <size_t Dim>
121 : struct EvolutionMetavars {
122 : static constexpr size_t volume_dim = Dim;
123 0 : using system = ScalarAdvection::System<Dim>;
124 0 : using temporal_id = Tags::TimeStepId;
125 0 : using TimeStepperBase = TimeStepper;
126 :
127 : static constexpr bool local_time_stepping =
128 : TimeStepperBase::local_time_stepping;
129 :
130 : // The use_dg_subcell flag controls whether to use "standard" limiting (false)
131 : // or a DG-FD hybrid scheme (true).
132 : static constexpr bool use_dg_subcell = true;
133 :
134 0 : using initial_data_list =
135 : tmpl::conditional_t<Dim == 1,
136 : tmpl::list<ScalarAdvection::Solutions::Krivodonova,
137 : ScalarAdvection::Solutions::Sinusoid>,
138 : tmpl::list<ScalarAdvection::Solutions::Kuzmin>>;
139 :
140 0 : using limiter = Tags::Limiter<
141 : Limiters::Minmod<Dim, typename system::variables_tag::tags_list>>;
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 : tmpl::conditional_t<
156 : use_dg_subcell,
157 : evolution::dg::subcell::Tags::ObserverCoordinatesCompute<
158 : volume_dim, Frame::ElementLogical>,
159 : ::Events::Tags::ObserverCoordinatesCompute<volume_dim,
160 : Frame::ElementLogical>>,
161 : tmpl::conditional_t<
162 : use_dg_subcell,
163 : evolution::dg::subcell::Tags::ObserverCoordinatesCompute<volume_dim,
164 : Frame::Grid>,
165 : domain::Tags::Coordinates<volume_dim, Frame::Grid>>,
166 : tmpl::conditional_t<
167 : use_dg_subcell,
168 : evolution::dg::subcell::Tags::ObserverCoordinatesCompute<
169 : volume_dim, Frame::Inertial>,
170 : domain::Tags::Coordinates<volume_dim, Frame::Inertial>>>;
171 0 : using non_tensor_compute_tags = tmpl::list<
172 : tmpl::conditional_t<
173 : use_dg_subcell,
174 : tmpl::list<
175 : evolution::dg::subcell::Tags::ObserverMeshCompute<volume_dim>,
176 : evolution::dg::subcell::Tags::ObserverInverseJacobianCompute<
177 : volume_dim, Frame::ElementLogical, Frame::Inertial>,
178 : evolution::dg::subcell::Tags::
179 : ObserverJacobianAndDetInvJacobianCompute<
180 : volume_dim, Frame::ElementLogical, Frame::Inertial>>,
181 : tmpl::list<::Events::Tags::ObserverMeshCompute<volume_dim>,
182 : ::Events::Tags::ObserverInverseJacobianCompute<
183 : volume_dim, Frame::ElementLogical, Frame::Inertial>,
184 : ::Events::Tags::ObserverJacobianCompute<
185 : volume_dim, Frame::ElementLogical, Frame::Inertial>,
186 : ::Events::Tags::ObserverDetInvJacobianCompute<
187 : Frame::ElementLogical, Frame::Inertial>>>,
188 : tmpl::list<analytic_compute, error_compute>>;
189 :
190 : struct factory_creation
191 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
192 0 : using factory_classes = tmpl::map<
193 : tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
194 : tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
195 : tmpl::pair<Event,
196 : tmpl::flatten<tmpl::list<
197 : Events::Completion,
198 : dg::Events::field_observations<
199 : volume_dim, observe_fields, non_tensor_compute_tags>,
200 : Events::time_events<system>>>>,
201 : tmpl::pair<evolution::initial_data::InitialData, initial_data_list>,
202 : tmpl::pair<LtsTimeStepper, TimeSteppers::lts_time_steppers>,
203 : tmpl::pair<PhaseChange, PhaseControl::factory_creatable_classes>,
204 : tmpl::pair<ScalarAdvection::BoundaryConditions::BoundaryCondition<Dim>,
205 : ScalarAdvection::BoundaryConditions::
206 : standard_boundary_conditions<Dim>>,
207 : tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
208 : StepChoosers::standard_step_choosers<system>>,
209 : tmpl::pair<
210 : StepChooser<StepChooserUse::Slab>,
211 : StepChoosers::standard_slab_choosers<system, local_time_stepping>>,
212 : tmpl::pair<TimeSequence<double>,
213 : TimeSequences::all_time_sequences<double>>,
214 : tmpl::pair<TimeSequence<std::uint64_t>,
215 : TimeSequences::all_time_sequences<std::uint64_t>>,
216 : tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
217 : tmpl::pair<Trigger, tmpl::append<Triggers::logical_triggers,
218 : Triggers::time_triggers>>>;
219 : };
220 :
221 : struct SubcellOptions {
222 : static constexpr bool subcell_enabled = use_dg_subcell;
223 : static constexpr bool subcell_enabled_at_external_boundary = false;
224 :
225 : // We send `ghost_zone_size` cell-centered grid points for variable
226 : // reconstruction, of which we need `ghost_zone_size-1` for reconstruction
227 : // to the internal side of the element face, and `ghost_zone_size` for
228 : // reconstruction to the external side of the element face.
229 : template <typename DbTagsList>
230 0 : static constexpr size_t ghost_zone_size(
231 : const db::DataBox<DbTagsList>& box) {
232 : return db::get<ScalarAdvection::fd::Tags::Reconstructor<volume_dim>>(box)
233 : .ghost_zone_size();
234 : }
235 :
236 0 : using DgComputeSubcellNeighborPackagedData =
237 : ScalarAdvection::subcell::NeighborPackagedData;
238 :
239 0 : using GhostVariables = ScalarAdvection::subcell::GhostVariables;
240 : };
241 :
242 0 : using observed_reduction_data_tags =
243 : observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
244 : tmpl::at<typename factory_creation::factory_classes, Event>>>>;
245 :
246 0 : using dg_step_actions = tmpl::flatten<tmpl::list<
247 : evolution::dg::Actions::ComputeTimeDerivative<
248 : volume_dim, system, AllStepChoosers, local_time_stepping>,
249 : evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
250 : system, volume_dim, false>,
251 : tmpl::conditional_t<
252 : local_time_stepping, tmpl::list<>,
253 : tmpl::list<
254 : Actions::RecordTimeStepperData<system>,
255 : evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<>>,
256 : Actions::UpdateU<system>>>,
257 : Limiters::Actions::SendData<EvolutionMetavars>,
258 : Limiters::Actions::Limit<EvolutionMetavars>>>;
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 :
264 : evolution::dg::Actions::ComputeTimeDerivative<
265 : volume_dim, system, AllStepChoosers, local_time_stepping>,
266 : evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
267 : system, volume_dim, false>,
268 : tmpl::conditional_t<
269 : local_time_stepping, tmpl::list<>,
270 : tmpl::list<
271 : Actions::RecordTimeStepperData<system>,
272 : evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<>>,
273 : Actions::UpdateU<system>>>,
274 : evolution::dg::subcell::Actions::TciAndRollback<
275 : ScalarAdvection::subcell::TciOnDgGrid<Dim>>,
276 : Actions::Goto<evolution::dg::subcell::Actions::Labels::EndOfSolvers>,
277 : Actions::Label<evolution::dg::subcell::Actions::Labels::BeginSubcell>,
278 : evolution::dg::subcell::Actions::SendDataForReconstruction<
279 : volume_dim, ScalarAdvection::subcell::GhostVariables,
280 : local_time_stepping>,
281 : evolution::dg::subcell::Actions::ReceiveDataForReconstruction<volume_dim>,
282 : Actions::Label<
283 : evolution::dg::subcell::Actions::Labels::BeginSubcellAfterDgRollback>,
284 : evolution::dg::subcell::fd::Actions::TakeTimeStep<
285 : ScalarAdvection::subcell::TimeDerivative<volume_dim>>,
286 : Actions::RecordTimeStepperData<system>, Actions::UpdateU<system>,
287 : evolution::dg::subcell::Actions::TciAndSwitchToDg<
288 : ScalarAdvection::subcell::TciOnFdGrid<volume_dim>>,
289 : Actions::Label<evolution::dg::subcell::Actions::Labels::EndOfSolvers>>>;
290 :
291 0 : using step_actions =
292 : tmpl::conditional_t<use_dg_subcell, dg_subcell_step_actions,
293 : dg_step_actions>;
294 :
295 0 : using const_global_cache_tags =
296 : tmpl::list<evolution::initial_data::Tags::InitialData,
297 : tmpl::conditional_t<
298 : use_dg_subcell,
299 : tmpl::list<ScalarAdvection::fd::Tags::Reconstructor<Dim>,
300 : ScalarAdvection::subcell::Tags::TciOptions>,
301 : tmpl::list<>>>;
302 :
303 0 : using dg_registration_list =
304 : tmpl::list<observers::Actions::RegisterEventsWithObservers>;
305 :
306 0 : using initialization_actions = tmpl::list<
307 : Initialization::Actions::InitializeItems<
308 : Initialization::TimeStepping<EvolutionMetavars, TimeStepperBase>,
309 : evolution::dg::Initialization::Domain<volume_dim>,
310 : Initialization::TimeStepperHistory<EvolutionMetavars>>,
311 : Initialization::Actions::ConservativeSystem<system>,
312 :
313 : tmpl::conditional_t<
314 : use_dg_subcell,
315 : tmpl::list<
316 : evolution::dg::subcell::Actions::SetSubcellGrid<volume_dim,
317 : system, false>,
318 : Initialization::Actions::AddSimpleTags<
319 : ScalarAdvection::subcell::VelocityAtFace<volume_dim>>,
320 : evolution::dg::subcell::Actions::SetAndCommunicateInitialRdmpData<
321 : volume_dim,
322 : ScalarAdvection::subcell::SetInitialRdmpData<volume_dim>>,
323 : evolution::dg::subcell::Actions::ComputeAndSendTciOnInitialGrid<
324 : volume_dim, system,
325 : ScalarAdvection::subcell::TciOnFdGrid<volume_dim>>,
326 : evolution::dg::subcell::Actions::SetInitialGridFromTciData<
327 : volume_dim, system>>,
328 : tmpl::list<evolution::Initialization::Actions::SetVariables<
329 : domain::Tags::Coordinates<Dim, Frame::ElementLogical>>>>,
330 :
331 : Initialization::Actions::AddComputeTags<
332 : tmpl::list<ScalarAdvection::Tags::VelocityFieldCompute<Dim>>>,
333 : Initialization::Actions::AddComputeTags<
334 : StepChoosers::step_chooser_compute_tags<EvolutionMetavars,
335 : local_time_stepping>>,
336 : ::evolution::dg::Initialization::Mortars<volume_dim, system>,
337 : Initialization::Actions::Minmod<Dim>,
338 : evolution::Actions::InitializeRunEventsAndDenseTriggers,
339 : Parallel::Actions::TerminatePhase>;
340 :
341 0 : using dg_element_array = DgElementArray<
342 : EvolutionMetavars,
343 : tmpl::list<
344 : Parallel::PhaseActions<Parallel::Phase::Initialization,
345 : initialization_actions>,
346 :
347 : Parallel::PhaseActions<Parallel::Phase::Register,
348 : tmpl::list<dg_registration_list,
349 : Parallel::Actions::TerminatePhase>>,
350 :
351 : Parallel::PhaseActions<
352 : Parallel::Phase::InitializeTimeStepperHistory,
353 : SelfStart::self_start_procedure<step_actions, system>>,
354 :
355 : Parallel::PhaseActions<
356 : Parallel::Phase::Evolve,
357 : tmpl::list<evolution::Actions::RunEventsAndTriggers,
358 : Actions::ChangeSlabSize, step_actions,
359 : Actions::AdvanceTime,
360 : PhaseControl::Actions::ExecutePhaseChange>>>>;
361 :
362 : struct registration
363 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
364 0 : using element_registrars =
365 : tmpl::map<tmpl::pair<dg_element_array, dg_registration_list>>;
366 : };
367 :
368 0 : using component_list =
369 : tmpl::list<observers::Observer<EvolutionMetavars>,
370 : observers::ObserverWriter<EvolutionMetavars>,
371 : dg_element_array>;
372 :
373 : static constexpr Options::String help{
374 : "Evolve the scalar advection equation.\n\n"};
375 :
376 : static constexpr std::array<Parallel::Phase, 5> default_phase_order{
377 : {Parallel::Phase::Initialization,
378 : Parallel::Phase::InitializeTimeStepperHistory, Parallel::Phase::Register,
379 : Parallel::Phase::Evolve, Parallel::Phase::Exit}};
380 :
381 : // NOLINTNEXTLINE(google-runtime-references)
382 0 : void pup(PUP::er& /*p*/) {}
383 : };
|
