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