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/LtsTimeStepper.hpp"
118 : #include "Time/TimeSteppers/TimeStepper.hpp"
119 : #include "Time/Triggers/TimeTriggers.hpp"
120 : #include "Time/UpdateU.hpp"
121 : #include "Utilities/ErrorHandling/Error.hpp"
122 : #include "Utilities/Functional.hpp"
123 : #include "Utilities/ProtocolHelpers.hpp"
124 : #include "Utilities/TMPL.hpp"
125 :
126 : /// \cond
127 : namespace Frame {
128 :
129 : struct Inertial;
130 : } // namespace Frame
131 : namespace Parallel {
132 : template <typename Metavariables>
133 : class CProxy_GlobalCache;
134 : } // namespace Parallel
135 : namespace PUP {
136 : class er;
137 : } // namespace PUP
138 : /// \endcond
139 :
140 : template <size_t Dim>
141 : struct EvolutionMetavars {
142 : static constexpr size_t volume_dim = Dim;
143 :
144 0 : using initial_data_list = ScalarWave::Solutions::all_solutions<Dim>;
145 :
146 0 : using system = ScalarWave::System<Dim>;
147 0 : using temporal_id = Tags::TimeStepId;
148 0 : using TimeStepperBase = TimeStepper;
149 :
150 : static constexpr bool local_time_stepping =
151 : TimeStepperBase::local_time_stepping;
152 : static constexpr bool use_dg_element_collection = false;
153 :
154 0 : using analytic_solution_fields = typename system::variables_tag::tags_list;
155 0 : using deriv_compute = ::Tags::DerivCompute<
156 : typename system::variables_tag, domain::Tags::Mesh<volume_dim>,
157 : domain::Tags::InverseJacobian<volume_dim, Frame::ElementLogical,
158 : Frame::Inertial>,
159 : typename system::gradient_variables,
160 : domain::Tags::Coordinates<volume_dim, Frame::Inertial>>;
161 0 : using analytic_compute =
162 : evolution::Tags::AnalyticSolutionsCompute<Dim, analytic_solution_fields,
163 : false, initial_data_list>;
164 0 : using error_compute = Tags::ErrorsCompute<analytic_solution_fields>;
165 0 : using error_tags = db::wrap_tags_in<Tags::Error, analytic_solution_fields>;
166 :
167 0 : using observe_fields = tmpl::push_back<
168 : tmpl::append<typename system::variables_tag::tags_list,
169 : typename deriv_compute::type::tags_list, error_tags>,
170 : ScalarWave::Tags::EnergyDensityCompute<volume_dim>,
171 : ScalarWave::Tags::MomentumDensityCompute<volume_dim>,
172 : ScalarWave::Tags::OneIndexConstraintCompute<volume_dim>,
173 : ScalarWave::Tags::TwoIndexConstraintCompute<volume_dim>,
174 : ::Tags::PointwiseL2NormCompute<
175 : ScalarWave::Tags::OneIndexConstraint<volume_dim>>,
176 : ::Tags::PointwiseL2NormCompute<
177 : ScalarWave::Tags::TwoIndexConstraint<volume_dim>>,
178 : domain::Tags::Coordinates<volume_dim, Frame::Grid>,
179 : domain::Tags::Coordinates<volume_dim, Frame::Inertial>>;
180 0 : using non_tensor_compute_tags =
181 : tmpl::list<::Events::Tags::ObserverMeshCompute<volume_dim>,
182 : ::Events::Tags::ObserverDetInvJacobianCompute<
183 : Frame::ElementLogical, Frame::Inertial>,
184 : deriv_compute, analytic_compute, error_compute>;
185 :
186 : struct factory_creation
187 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
188 0 : using factory_classes = tmpl::map<
189 : tmpl::pair<amr::Criterion,
190 : amr::Criteria::standard_criteria<
191 : volume_dim, typename system::variables_tag::tags_list>>,
192 : tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
193 : tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
194 : tmpl::pair<Event,
195 : tmpl::flatten<tmpl::list<
196 : Events::Completion, amr::Events::RefineMesh,
197 : amr::Events::ObserveAmrStats<volume_dim>,
198 : amr::Events::ObserveAmrCriteria<EvolutionMetavars>,
199 : dg::Events::field_observations<
200 : volume_dim, observe_fields, non_tensor_compute_tags>,
201 : Events::time_events<system>,
202 : dg::Events::ChangeFixedLtsRatio<volume_dim>>>>,
203 : tmpl::pair<evolution::BoundaryCorrection,
204 : ScalarWave::BoundaryCorrections::
205 : standard_boundary_corrections<volume_dim>>,
206 : tmpl::pair<evolution::initial_data::InitialData,
207 : tmpl::push_back<initial_data_list,
208 : evolution::initial_data::NumericData>>,
209 : tmpl::pair<LtsTimeStepper, TimeSteppers::lts_time_steppers>,
210 : tmpl::pair<MathFunction<1, Frame::Inertial>,
211 : MathFunctions::all_math_functions<1, Frame::Inertial>>,
212 : tmpl::pair<PhaseChange, PhaseControl::factory_creatable_classes>,
213 : tmpl::pair<
214 : ScalarWave::BoundaryConditions::BoundaryCondition<volume_dim>,
215 : ScalarWave::BoundaryConditions::standard_boundary_conditions<
216 : volume_dim>>,
217 : tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
218 : tmpl::push_back<StepChoosers::standard_step_choosers<system>,
219 : StepChoosers::ByBlock<volume_dim>>>,
220 : tmpl::pair<StepChooser<StepChooserUse::Slab>,
221 : tmpl::push_back<
222 : StepChoosers::standard_slab_choosers<system>,
223 : evolution::dg::StepChoosers::FixedLtsRatio<volume_dim>,
224 : StepChoosers::ByBlock<volume_dim>>>,
225 : tmpl::pair<TimeSequence<double>,
226 : TimeSequences::all_time_sequences<double>>,
227 : tmpl::pair<TimeSequence<std::uint64_t>,
228 : TimeSequences::all_time_sequences<std::uint64_t>>,
229 : tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
230 : tmpl::pair<Trigger, tmpl::append<Triggers::logical_triggers,
231 : Triggers::time_triggers>>,
232 : tmpl::pair<
233 : Filters::Filter<volume_dim,
234 : typename system::variables_tag::tags_list>,
235 : tmpl::append<
236 : Filters::all_filters<volume_dim,
237 : typename system::variables_tag::tags_list>,
238 : tmpl::conditional_t<
239 : volume_dim == 3,
240 : tmpl::list<Filters::SphericalShell<
241 : typename system::variables_tag::tags_list>>,
242 : tmpl::list<>>>>>;
243 : };
244 :
245 0 : using observed_reduction_data_tags =
246 : observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
247 : tmpl::at<typename factory_creation::factory_classes, Event>>>>;
248 :
249 0 : using step_actions = tmpl::flatten<tmpl::list<
250 : evolution::dg::Actions::ComputeTimeDerivative<
251 : volume_dim, system, AllStepChoosers, local_time_stepping,
252 : use_dg_element_collection>,
253 : evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
254 : volume_dim, use_dg_element_collection>,
255 : Actions::MutateApply<RecordTimeStepperData<system>>,
256 : evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<
257 : evolution::dg::ApplyLtsDenseBoundaryCorrections<EvolutionMetavars>>>,
258 : Actions::MutateApply<UpdateU<system, local_time_stepping>>,
259 : evolution::dg::Actions::ApplyLtsBoundaryCorrections<
260 : volume_dim, use_dg_element_collection>,
261 : tmpl::conditional_t<
262 : local_time_stepping,
263 : tmpl::list<Actions::MutateApply<ChangeTimeStepperOrder<system>>>,
264 : tmpl::list<>>,
265 : Actions::MutateApply<CleanHistory<system>>,
266 : Actions::MutateApply<evolution::dg::CleanMortarHistory<volume_dim>>,
267 : dg::Actions::SpectralFilter>>;
268 :
269 0 : using const_global_cache_tags =
270 : tmpl::list<evolution::initial_data::Tags::InitialData>;
271 :
272 0 : using dg_registration_list =
273 : tmpl::list<observers::Actions::RegisterEventsWithObservers>;
274 :
275 0 : using equal_rate_regions =
276 : tmpl::list<evolution::dg::NonconformingEqualRateRegions<volume_dim>>;
277 :
278 0 : using initialization_actions = tmpl::list<
279 : Initialization::Actions::InitializeItems<
280 : Initialization::TimeStepping<EvolutionMetavars, TimeStepperBase,
281 : false, local_time_stepping>,
282 : evolution::dg::Initialization::Domain<EvolutionMetavars>,
283 : ::amr::Initialization::Initialize<volume_dim, EvolutionMetavars>,
284 : Initialization::TimeStepperHistory<EvolutionMetavars>>,
285 : Initialization::Actions::NonconservativeSystem<system>,
286 : evolution::Initialization::Actions::SetVariables<
287 : domain::Tags::Coordinates<Dim, Frame::ElementLogical>>,
288 : ScalarWave::Actions::InitializeConstraints<volume_dim>,
289 : Initialization::Actions::AddComputeTags<
290 : StepChoosers::step_chooser_compute_tags<EvolutionMetavars>>,
291 : ::evolution::dg::Initialization::Mortars<volume_dim>,
292 : evolution::dg::Initialization::Actions::SetupEqualRateRegions<
293 : EvolutionMetavars, volume_dim, equal_rate_regions>,
294 : evolution::Actions::InitializeRunEventsAndDenseTriggers,
295 : Initialization::Actions::InitializeItems<
296 : evolution::dg::Initialization::SpectralFilters<
297 : volume_dim, typename system::variables_tag::tags_list>>,
298 : Parallel::Actions::TerminatePhase>;
299 :
300 0 : using dg_element_array = DgElementArray<
301 : EvolutionMetavars,
302 : tmpl::list<
303 : Parallel::PhaseActions<Parallel::Phase::Initialization,
304 : initialization_actions>,
305 :
306 : Parallel::PhaseActions<
307 : Parallel::Phase::InitializeTimeStepperHistory,
308 : SelfStart::self_start_procedure<step_actions, system>>,
309 :
310 : Parallel::PhaseActions<Parallel::Phase::Register,
311 : tmpl::list<dg_registration_list,
312 : Parallel::Actions::TerminatePhase>>,
313 :
314 : Parallel::PhaseActions<Parallel::Phase::Restart,
315 : tmpl::list<dg_registration_list,
316 : Parallel::Actions::TerminatePhase>>,
317 :
318 : Parallel::PhaseActions<
319 : Parallel::Phase::WriteCheckpoint,
320 : tmpl::list<evolution::Actions::RunEventsAndTriggers<
321 : Triggers::WhenToCheck::AtCheckpoints>,
322 : Parallel::Actions::TerminatePhase>>,
323 :
324 : Parallel::PhaseActions<Parallel::Phase::CheckDomain,
325 : tmpl::list<::amr::Actions::SendAmrDiagnostics,
326 : Parallel::Actions::TerminatePhase>>,
327 :
328 : Parallel::PhaseActions<
329 : Parallel::Phase::Evolve,
330 : tmpl::flatten<tmpl::list<
331 : std::conditional_t<local_time_stepping,
332 : evolution::Actions::RunEventsAndTriggers<
333 : Triggers::WhenToCheck::AtSteps>,
334 : tmpl::list<>>,
335 : evolution::Actions::RunEventsAndTriggers<
336 : Triggers::WhenToCheck::AtSlabs>,
337 : Actions::ChangeSlabSize,
338 : evolution::dg::Actions::ChangeFixedLtsRatio, step_actions,
339 : Actions::MutateApply<AdvanceTime<>>,
340 : PhaseControl::Actions::ExecutePhaseChange>>>>>;
341 :
342 : struct amr : tt::ConformsTo<::amr::protocols::AmrMetavariables> {
343 0 : using element_array = dg_element_array;
344 0 : using projectors = tmpl::list<
345 : Initialization::ProjectTimeStepping<volume_dim>,
346 : evolution::dg::Initialization::ProjectDomain<volume_dim>,
347 : ::amr::projectors::ProjectVariables<volume_dim,
348 : typename system::variables_tag>,
349 : ::amr::projectors::ProjectTensors<volume_dim,
350 : ::ScalarWave::Tags::ConstraintGamma2>,
351 : evolution::dg::Initialization::ProjectMortars<volume_dim>,
352 : Initialization::ProjectTimeStepperHistory<EvolutionMetavars>,
353 : evolution::Actions::ProjectRunEventsAndDenseTriggers,
354 : evolution::dg::Initialization::ProjectSpectralFilters<
355 : volume_dim, typename system::variables_tag::tags_list>,
356 : ::amr::projectors::DefaultInitialize<
357 : Initialization::Tags::InitialTimeDelta,
358 : Initialization::Tags::InitialSlabSize<local_time_stepping>,
359 : ::domain::Tags::InitialExtents<volume_dim>,
360 : ::domain::Tags::InitialRefinementLevels<volume_dim>,
361 : evolution::dg::Tags::Quadrature,
362 : Tags::StepperErrors<typename system::variables_tag>,
363 : SelfStart::Tags::InitialValue<typename system::variables_tag>,
364 : SelfStart::Tags::InitialValue<Tags::TimeStep>>,
365 : ::amr::projectors::CopyFromCreatorOrLeaveAsIs<
366 : evolution::dg::Tags::ChangeFixedLtsRatio::NumberOfExpectedMessages,
367 : evolution::dg::Tags::ChangeFixedLtsRatio::NewStepSize,
368 : Tags::FixedLtsRatio,
369 : Parallel::Tags::Section<dg_element_array,
370 : evolution::dg::Tags::EqualRateRegionId>,
371 : Tags::ChangeSlabSize::NumberOfExpectedMessages,
372 : Tags::ChangeSlabSize::NewSlabSize>>;
373 : static constexpr bool keep_coarse_grids = false;
374 : static constexpr bool p_refine_only_in_event = true;
375 : };
376 :
377 : 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<::amr::Component<EvolutionMetavars>,
385 : observers::Observer<EvolutionMetavars>,
386 : observers::ObserverWriter<EvolutionMetavars>,
387 : dg_element_array>;
388 :
389 : static constexpr Options::String help{
390 : "Evolve a Scalar Wave in Dim spatial dimension.\n\n"
391 : "The numerical flux is: UpwindFlux\n"};
392 :
393 : static constexpr auto default_phase_order = std::array<Parallel::Phase, 6>{
394 : Parallel::Phase::Initialization,
395 : Parallel::Phase::InitializeTimeStepperHistory,
396 : Parallel::Phase::Register,
397 : Parallel::Phase::CheckDomain,
398 : Parallel::Phase::Evolve,
399 : Parallel::Phase::Exit};
400 :
401 : // NOLINTNEXTLINE(google-runtime-references)
402 0 : void pup(PUP::er& /*p*/) {}
403 : };
|
