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