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 "DataStructures/Tensor/IndexType.hpp"
11 : #include "Domain/Creators/Factory1D.hpp"
12 : #include "Domain/Creators/Factory2D.hpp"
13 : #include "Domain/Creators/Factory3D.hpp"
14 : #include "Domain/Tags.hpp"
15 : #include "Evolution/Actions/RunEventsAndDenseTriggers.hpp"
16 : #include "Evolution/Actions/RunEventsAndTriggers.hpp"
17 : #include "Evolution/BoundaryCorrection.hpp"
18 : #include "Evolution/ComputeTags.hpp"
19 : #include "Evolution/DiscontinuousGalerkin/Actions/ApplyBoundaryCorrections.hpp"
20 : #include "Evolution/DiscontinuousGalerkin/Actions/ComputeTimeDerivative.hpp"
21 : #include "Evolution/DiscontinuousGalerkin/CleanMortarHistory.hpp"
22 : #include "Evolution/DiscontinuousGalerkin/DgElementArray.hpp"
23 : #include "Evolution/DiscontinuousGalerkin/EqualRateLts/ChangeFixedLtsRatio.hpp"
24 : #include "Evolution/DiscontinuousGalerkin/EqualRateLts/FixedLtsRatio.hpp"
25 : #include "Evolution/DiscontinuousGalerkin/EqualRateLts/NonconformingEqualRateRegions.hpp"
26 : #include "Evolution/DiscontinuousGalerkin/Initialization/Mortars.hpp"
27 : #include "Evolution/DiscontinuousGalerkin/Initialization/ProjectSpectralFilters.hpp"
28 : #include "Evolution/DiscontinuousGalerkin/Initialization/QuadratureTag.hpp"
29 : #include "Evolution/DiscontinuousGalerkin/Initialization/SetupEqualRateRegions.hpp"
30 : #include "Evolution/DiscontinuousGalerkin/Initialization/SpectralFilters.hpp"
31 : #include "Evolution/Initialization/DgDomain.hpp"
32 : #include "Evolution/Initialization/Evolution.hpp"
33 : #include "Evolution/Initialization/NonconservativeSystem.hpp"
34 : #include "Evolution/Initialization/SetVariables.hpp"
35 : #include "Evolution/Systems/ScalarWave/BoundaryConditions/Factory.hpp"
36 : #include "Evolution/Systems/ScalarWave/BoundaryCorrections/Factory.hpp"
37 : #include "Evolution/Systems/ScalarWave/EnergyDensity.hpp"
38 : #include "Evolution/Systems/ScalarWave/Equations.hpp"
39 : #include "Evolution/Systems/ScalarWave/Initialize.hpp"
40 : #include "Evolution/Systems/ScalarWave/MomentumDensity.hpp"
41 : #include "Evolution/Systems/ScalarWave/System.hpp"
42 : #include "IO/Observer/Actions/RegisterEvents.hpp"
43 : #include "IO/Observer/Helpers.hpp"
44 : #include "IO/Observer/ObserverComponent.hpp"
45 : #include "NumericalAlgorithms/DiscontinuousGalerkin/Formulation.hpp"
46 : #include "NumericalAlgorithms/DiscontinuousGalerkin/Tags.hpp"
47 : #include "NumericalAlgorithms/LinearOperators/Filters/Factory.hpp"
48 : #include "NumericalAlgorithms/LinearOperators/Filters/SphericalShell.hpp"
49 : #include "NumericalAlgorithms/LinearOperators/Filters/Tag.hpp"
50 : #include "Options/Protocols/FactoryCreation.hpp"
51 : #include "Options/String.hpp"
52 : #include "Parallel/ArrayCollection/DgElementCollection.hpp"
53 : #include "Parallel/Local.hpp"
54 : #include "Parallel/Phase.hpp"
55 : #include "Parallel/PhaseControl/CheckpointAndExitAfterWallclock.hpp"
56 : #include "Parallel/PhaseControl/ExecutePhaseChange.hpp"
57 : #include "Parallel/PhaseControl/Factory.hpp"
58 : #include "Parallel/PhaseControl/VisitAndReturn.hpp"
59 : #include "Parallel/PhaseDependentActionList.hpp"
60 : #include "Parallel/Protocols/RegistrationMetavariables.hpp"
61 : #include "Parallel/Reduction.hpp"
62 : #include "ParallelAlgorithms/Actions/AddComputeTags.hpp"
63 : #include "ParallelAlgorithms/Actions/InitializeItems.hpp"
64 : #include "ParallelAlgorithms/Actions/MutateApply.hpp"
65 : #include "ParallelAlgorithms/Actions/SpectralFilter.hpp"
66 : #include "ParallelAlgorithms/Actions/TerminatePhase.hpp"
67 : #include "ParallelAlgorithms/Amr/Actions/CollectDataFromChildren.hpp"
68 : #include "ParallelAlgorithms/Amr/Actions/Component.hpp"
69 : #include "ParallelAlgorithms/Amr/Actions/CreateChild.hpp"
70 : #include "ParallelAlgorithms/Amr/Actions/Initialize.hpp"
71 : #include "ParallelAlgorithms/Amr/Actions/SendAmrDiagnostics.hpp"
72 : #include "ParallelAlgorithms/Amr/Criteria/Criterion.hpp"
73 : #include "ParallelAlgorithms/Amr/Criteria/Factory.hpp"
74 : #include "ParallelAlgorithms/Amr/Criteria/Tags/Criteria.hpp"
75 : #include "ParallelAlgorithms/Amr/Events/ObserveAmrCriteria.hpp"
76 : #include "ParallelAlgorithms/Amr/Events/ObserveAmrStats.hpp"
77 : #include "ParallelAlgorithms/Amr/Events/RefineMesh.hpp"
78 : #include "ParallelAlgorithms/Amr/Projectors/CopyFromCreatorOrLeaveAsIs.hpp"
79 : #include "ParallelAlgorithms/Amr/Projectors/DefaultInitialize.hpp"
80 : #include "ParallelAlgorithms/Amr/Projectors/Tensors.hpp"
81 : #include "ParallelAlgorithms/Amr/Projectors/Variables.hpp"
82 : #include "ParallelAlgorithms/Amr/Protocols/AmrMetavariables.hpp"
83 : #include "ParallelAlgorithms/Events/ChangeFixedLtsRatio.hpp"
84 : #include "ParallelAlgorithms/Events/Completion.hpp"
85 : #include "ParallelAlgorithms/Events/Factory.hpp"
86 : #include "ParallelAlgorithms/Events/Tags.hpp"
87 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTrigger.hpp"
88 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTriggers/Factory.hpp"
89 : #include "ParallelAlgorithms/EventsAndTriggers/Event.hpp"
90 : #include "ParallelAlgorithms/EventsAndTriggers/EventsAndTriggers.hpp"
91 : #include "ParallelAlgorithms/EventsAndTriggers/LogicalTriggers.hpp"
92 : #include "ParallelAlgorithms/EventsAndTriggers/Trigger.hpp"
93 : #include "PointwiseFunctions/AnalyticData/AnalyticData.hpp"
94 : #include "PointwiseFunctions/AnalyticSolutions/AnalyticSolution.hpp"
95 : #include "PointwiseFunctions/AnalyticSolutions/Tags.hpp"
96 : #include "PointwiseFunctions/AnalyticSolutions/WaveEquation/Factory.hpp"
97 : #include "PointwiseFunctions/AnalyticSolutions/WaveEquation/PlaneWave.hpp"
98 : #include "PointwiseFunctions/AnalyticSolutions/WaveEquation/RegularSphericalWave.hpp"
99 : #include "PointwiseFunctions/InitialDataUtilities/NumericData.hpp"
100 : #include "PointwiseFunctions/MathFunctions/Factory.hpp"
101 : #include "PointwiseFunctions/MathFunctions/MathFunction.hpp"
102 : #include "Time/Actions/SelfStartActions.hpp"
103 : #include "Time/AdvanceTime.hpp"
104 : #include "Time/ChangeSlabSize/Action.hpp"
105 : #include "Time/ChangeSlabSize/Tags.hpp"
106 : #include "Time/ChangeTimeStepperOrder.hpp"
107 : #include "Time/CleanHistory.hpp"
108 : #include "Time/RecordTimeStepperData.hpp"
109 : #include "Time/StepChoosers/ByBlock.hpp"
110 : #include "Time/StepChoosers/Factory.hpp"
111 : #include "Time/StepChoosers/StepChooser.hpp"
112 : #include "Time/Tags/StepperErrors.hpp"
113 : #include "Time/Tags/Time.hpp"
114 : #include "Time/Tags/TimeStepId.hpp"
115 : #include "Time/TimeSequence.hpp"
116 : #include "Time/TimeSteppers/Factory.hpp"
117 : #include "Time/TimeSteppers/TimeStepper.hpp"
118 : #include "Time/Triggers/TimeTriggers.hpp"
119 : #include "Time/UpdateU.hpp"
120 : #include "Utilities/ErrorHandling/Error.hpp"
121 : #include "Utilities/Functional.hpp"
122 : #include "Utilities/ProtocolHelpers.hpp"
123 : #include "Utilities/TMPL.hpp"
124 :
125 : /// \cond
126 : namespace Frame {
127 :
128 : struct Inertial;
129 : } // namespace Frame
130 : namespace Parallel {
131 : template <typename Metavariables>
132 : class CProxy_GlobalCache;
133 : } // namespace Parallel
134 : namespace PUP {
135 : class er;
136 : } // namespace PUP
137 : /// \endcond
138 :
139 : template <size_t Dim>
140 : struct EvolutionMetavars {
141 : static constexpr size_t volume_dim = Dim;
142 :
143 0 : using initial_data_list = ScalarWave::Solutions::all_solutions<Dim>;
144 :
145 0 : using system = ScalarWave::System<Dim>;
146 0 : using temporal_id = Tags::TimeStepId;
147 :
148 : static constexpr bool use_dg_element_collection = false;
149 :
150 0 : using analytic_solution_fields = typename system::variables_tag::tags_list;
151 0 : using deriv_compute = ::Tags::DerivCompute<
152 : typename system::variables_tag, domain::Tags::Mesh<volume_dim>,
153 : domain::Tags::InverseJacobian<volume_dim, Frame::ElementLogical,
154 : Frame::Inertial>,
155 : typename system::gradient_variables,
156 : domain::Tags::Coordinates<volume_dim, Frame::Inertial>>;
157 0 : using analytic_compute =
158 : evolution::Tags::AnalyticSolutionsCompute<Dim, analytic_solution_fields,
159 : false, initial_data_list>;
160 0 : using error_compute = Tags::ErrorsCompute<analytic_solution_fields>;
161 0 : using error_tags = db::wrap_tags_in<Tags::Error, analytic_solution_fields>;
162 :
163 0 : using observe_fields = tmpl::push_back<
164 : tmpl::append<typename system::variables_tag::tags_list,
165 : typename deriv_compute::type::tags_list, error_tags>,
166 : ScalarWave::Tags::EnergyDensityCompute<volume_dim>,
167 : ScalarWave::Tags::MomentumDensityCompute<volume_dim>,
168 : ScalarWave::Tags::OneIndexConstraintCompute<volume_dim>,
169 : ScalarWave::Tags::TwoIndexConstraintCompute<volume_dim>,
170 : ::Tags::PointwiseL2NormCompute<
171 : ScalarWave::Tags::OneIndexConstraint<volume_dim>>,
172 : ::Tags::PointwiseL2NormCompute<
173 : ScalarWave::Tags::TwoIndexConstraint<volume_dim>>,
174 : domain::Tags::Coordinates<volume_dim, Frame::Grid>,
175 : domain::Tags::Coordinates<volume_dim, Frame::Inertial>>;
176 0 : using non_tensor_compute_tags =
177 : tmpl::list<::Events::Tags::ObserverMeshCompute<volume_dim>,
178 : ::Events::Tags::ObserverDetInvJacobianCompute<
179 : Frame::ElementLogical, Frame::Inertial>,
180 : deriv_compute, analytic_compute, error_compute>;
181 :
182 : struct factory_creation
183 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
184 0 : using factory_classes = tmpl::map<
185 : tmpl::pair<amr::Criterion,
186 : amr::Criteria::standard_criteria<
187 : volume_dim, typename system::variables_tag::tags_list>>,
188 : tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
189 : tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
190 : tmpl::pair<Event,
191 : tmpl::flatten<tmpl::list<
192 : Events::Completion, amr::Events::RefineMesh,
193 : amr::Events::ObserveAmrStats<volume_dim>,
194 : amr::Events::ObserveAmrCriteria<EvolutionMetavars>,
195 : dg::Events::field_observations<
196 : volume_dim, observe_fields, non_tensor_compute_tags>,
197 : Events::time_events<system>,
198 : dg::Events::ChangeFixedLtsRatio<volume_dim>>>>,
199 : tmpl::pair<evolution::BoundaryCorrection,
200 : ScalarWave::BoundaryCorrections::
201 : standard_boundary_corrections<volume_dim>>,
202 : tmpl::pair<evolution::initial_data::InitialData,
203 : tmpl::push_back<initial_data_list,
204 : evolution::initial_data::NumericData>>,
205 : tmpl::pair<MathFunction<1, Frame::Inertial>,
206 : MathFunctions::all_math_functions<1, Frame::Inertial>>,
207 : tmpl::pair<PhaseChange, PhaseControl::factory_creatable_classes>,
208 : tmpl::pair<
209 : ScalarWave::BoundaryConditions::BoundaryCondition<volume_dim>,
210 : ScalarWave::BoundaryConditions::standard_boundary_conditions<
211 : volume_dim>>,
212 : tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
213 : tmpl::push_back<StepChoosers::standard_step_choosers<system>,
214 : StepChoosers::ByBlock<volume_dim>>>,
215 : tmpl::pair<StepChooser<StepChooserUse::Slab>,
216 : tmpl::push_back<
217 : StepChoosers::standard_slab_choosers<system>,
218 : evolution::dg::StepChoosers::FixedLtsRatio<volume_dim>,
219 : StepChoosers::ByBlock<volume_dim>>>,
220 : tmpl::pair<TimeSequence<double>,
221 : TimeSequences::all_time_sequences<double>>,
222 : tmpl::pair<TimeSequence<std::uint64_t>,
223 : TimeSequences::all_time_sequences<std::uint64_t>>,
224 : tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
225 : tmpl::pair<Trigger, tmpl::append<Triggers::logical_triggers,
226 : Triggers::time_triggers>>,
227 : tmpl::pair<
228 : Filters::Filter<volume_dim,
229 : typename system::variables_tag::tags_list>,
230 : tmpl::append<
231 : Filters::all_filters<volume_dim,
232 : typename system::variables_tag::tags_list>,
233 : tmpl::conditional_t<
234 : volume_dim == 3,
235 : tmpl::list<Filters::SphericalShell<
236 : typename system::variables_tag::tags_list>>,
237 : tmpl::list<>>>>>;
238 : };
239 :
240 0 : using observed_reduction_data_tags =
241 : observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
242 : tmpl::at<typename factory_creation::factory_classes, Event>>>>;
243 :
244 0 : using step_actions = tmpl::flatten<tmpl::list<
245 : evolution::dg::Actions::ComputeTimeDerivative<
246 : volume_dim, system, AllStepChoosers, use_dg_element_collection>,
247 : evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
248 : volume_dim, use_dg_element_collection>,
249 : Actions::MutateApply<RecordTimeStepperData<system>>,
250 : evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<
251 : evolution::dg::ApplyLtsDenseBoundaryCorrections<EvolutionMetavars>>>,
252 : Actions::MutateApply<UpdateU<system>>,
253 : evolution::dg::Actions::ApplyLtsBoundaryCorrections<
254 : volume_dim, use_dg_element_collection>,
255 : Actions::MutateApply<ChangeTimeStepperOrder<system>>,
256 : Actions::MutateApply<CleanHistory<system>>,
257 : Actions::MutateApply<evolution::dg::CleanMortarHistory<volume_dim>>,
258 : dg::Actions::SpectralFilter<volume_dim,
259 : typename system::variables_tag::tags_list>>>;
260 :
261 0 : using const_global_cache_tags =
262 : tmpl::list<evolution::initial_data::Tags::InitialData>;
263 :
264 0 : using dg_registration_list =
265 : tmpl::list<observers::Actions::RegisterEventsWithObservers>;
266 :
267 0 : using equal_rate_regions =
268 : tmpl::list<evolution::dg::NonconformingEqualRateRegions<volume_dim>>;
269 :
270 0 : using initialization_actions = tmpl::list<
271 : Initialization::Actions::InitializeItems<
272 : Initialization::TimeStepping<EvolutionMetavars, TimeStepper, false,
273 : true>,
274 : evolution::dg::Initialization::Domain<EvolutionMetavars>,
275 : ::amr::Initialization::Initialize<volume_dim, EvolutionMetavars>>,
276 : Initialization::Actions::NonconservativeSystem<system>,
277 : Initialization::Actions::InitializeItems<
278 : Initialization::TimeStepperHistory<system>>,
279 : evolution::Initialization::Actions::SetVariables<
280 : domain::Tags::Coordinates<Dim, Frame::ElementLogical>>,
281 : ScalarWave::Actions::InitializeConstraints<volume_dim>,
282 : Initialization::Actions::AddComputeTags<
283 : StepChoosers::step_chooser_compute_tags<EvolutionMetavars>>,
284 : ::evolution::dg::Initialization::Mortars<volume_dim>,
285 : evolution::dg::Initialization::Actions::SetupEqualRateRegions<
286 : EvolutionMetavars, volume_dim, equal_rate_regions>,
287 : evolution::Actions::InitializeRunEventsAndDenseTriggers,
288 : Initialization::Actions::InitializeItems<
289 : evolution::dg::Initialization::SpectralFilters<
290 : volume_dim, typename system::variables_tag::tags_list>>,
291 : Parallel::Actions::TerminatePhase>;
292 :
293 0 : using dg_element_array = DgElementArray<
294 : EvolutionMetavars,
295 : tmpl::list<
296 : Parallel::PhaseActions<Parallel::Phase::Initialization,
297 : initialization_actions>,
298 :
299 : Parallel::PhaseActions<
300 : Parallel::Phase::InitializeTimeStepperHistory,
301 : SelfStart::self_start_procedure<step_actions, system>>,
302 :
303 : Parallel::PhaseActions<Parallel::Phase::Register,
304 : tmpl::list<dg_registration_list,
305 : Parallel::Actions::TerminatePhase>>,
306 :
307 : Parallel::PhaseActions<Parallel::Phase::Restart,
308 : tmpl::list<dg_registration_list,
309 : Parallel::Actions::TerminatePhase>>,
310 :
311 : Parallel::PhaseActions<
312 : Parallel::Phase::WriteCheckpoint,
313 : tmpl::list<evolution::Actions::RunEventsAndTriggers<
314 : Triggers::WhenToCheck::AtCheckpoints>,
315 : Parallel::Actions::TerminatePhase>>,
316 :
317 : Parallel::PhaseActions<Parallel::Phase::CheckDomain,
318 : tmpl::list<::amr::Actions::SendAmrDiagnostics,
319 : Parallel::Actions::TerminatePhase>>,
320 :
321 : Parallel::PhaseActions<
322 : Parallel::Phase::Evolve,
323 : tmpl::flatten<
324 : tmpl::list<evolution::Actions::RunEventsAndTriggers<
325 : Triggers::WhenToCheck::AtSteps>,
326 : evolution::Actions::RunEventsAndTriggers<
327 : Triggers::WhenToCheck::AtSlabs>,
328 : Actions::ChangeSlabSize,
329 : evolution::dg::Actions::ChangeFixedLtsRatio,
330 : step_actions, Actions::MutateApply<AdvanceTime<>>,
331 : PhaseControl::Actions::ExecutePhaseChange>>>>>;
332 :
333 : struct amr : tt::ConformsTo<::amr::protocols::AmrMetavariables> {
334 0 : using element_array = dg_element_array;
335 0 : using projectors = tmpl::list<
336 : Initialization::ProjectTimeStepping<volume_dim>,
337 : evolution::dg::Initialization::ProjectDomain<volume_dim>,
338 : ::amr::projectors::ProjectVariables<volume_dim,
339 : typename system::variables_tag>,
340 : ::amr::projectors::ProjectTensors<volume_dim,
341 : ::ScalarWave::Tags::ConstraintGamma2>,
342 : evolution::dg::Initialization::ProjectMortars<volume_dim>,
343 : Initialization::ProjectTimeStepperHistory<EvolutionMetavars>,
344 : evolution::Actions::ProjectRunEventsAndDenseTriggers,
345 : evolution::dg::Initialization::ProjectSpectralFilters<
346 : volume_dim, typename system::variables_tag::tags_list>,
347 : ::amr::projectors::DefaultInitialize<
348 : Initialization::Tags::InitialTimeDelta,
349 : Initialization::Tags::InitialSlabSize,
350 : ::domain::Tags::InitialExtents<volume_dim>,
351 : ::domain::Tags::InitialRefinementLevels<volume_dim>,
352 : evolution::dg::Tags::Quadrature,
353 : Tags::StepperErrors<typename system::variables_tag>,
354 : SelfStart::Tags::InitialValue<typename system::variables_tag>,
355 : SelfStart::Tags::InitialValue<Tags::TimeStep>>,
356 : ::amr::projectors::CopyFromCreatorOrLeaveAsIs<
357 : evolution::dg::Tags::ChangeFixedLtsRatio::NumberOfExpectedMessages,
358 : evolution::dg::Tags::ChangeFixedLtsRatio::NewStepSize,
359 : Tags::FixedLtsRatio,
360 : Parallel::Tags::Section<dg_element_array,
361 : evolution::dg::Tags::EqualRateRegionId>,
362 : Tags::ChangeSlabSize::NumberOfExpectedMessages,
363 : Tags::ChangeSlabSize::NewSlabSize>>;
364 : static constexpr bool keep_coarse_grids = false;
365 : static constexpr bool p_refine_only_in_event = true;
366 : };
367 :
368 : struct registration
369 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
370 0 : using element_registrars =
371 : tmpl::map<tmpl::pair<dg_element_array, dg_registration_list>>;
372 : };
373 :
374 0 : using component_list =
375 : tmpl::list<::amr::Component<EvolutionMetavars>,
376 : observers::Observer<EvolutionMetavars>,
377 : observers::ObserverWriter<EvolutionMetavars>,
378 : dg_element_array>;
379 :
380 : static constexpr Options::String help{
381 : "Evolve a Scalar Wave in Dim spatial dimension.\n\n"
382 : "The numerical flux is: UpwindFlux\n"};
383 :
384 : static constexpr auto default_phase_order = std::array<Parallel::Phase, 6>{
385 : Parallel::Phase::Initialization,
386 : Parallel::Phase::InitializeTimeStepperHistory,
387 : Parallel::Phase::Register,
388 : Parallel::Phase::CheckDomain,
389 : Parallel::Phase::Evolve,
390 : Parallel::Phase::Exit};
391 :
392 : // NOLINTNEXTLINE(google-runtime-references)
393 0 : void pup(PUP::er& /*p*/) {}
394 : };
|
