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/EagerMath/Norms.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/QuadratureTag.hpp"
28 : #include "Evolution/DiscontinuousGalerkin/Initialization/SetupEqualRateRegions.hpp"
29 : #include "Evolution/DiscontinuousGalerkin/Initialization/SpectralFilters.hpp"
30 : #include "Evolution/Initialization/DgDomain.hpp"
31 : #include "Evolution/Initialization/Evolution.hpp"
32 : #include "Evolution/Initialization/NonconservativeSystem.hpp"
33 : #include "Evolution/Initialization/SetVariables.hpp"
34 : #include "Evolution/Systems/CurvedScalarWave/Actions/SetInitialData.hpp"
35 : #include "Evolution/Systems/CurvedScalarWave/BackgroundSpacetime.hpp"
36 : #include "Evolution/Systems/CurvedScalarWave/BoundaryConditions/Factory.hpp"
37 : #include "Evolution/Systems/CurvedScalarWave/BoundaryCorrections/Factory.hpp"
38 : #include "Evolution/Systems/CurvedScalarWave/CalculateGrVars.hpp"
39 : #include "Evolution/Systems/CurvedScalarWave/Constraints.hpp"
40 : #include "Evolution/Systems/CurvedScalarWave/Initialize.hpp"
41 : #include "Evolution/Systems/CurvedScalarWave/PsiSquared.hpp"
42 : #include "Evolution/Systems/CurvedScalarWave/System.hpp"
43 : #include "Evolution/Systems/CurvedScalarWave/Tags.hpp"
44 : #include "IO/Importers/Actions/RegisterWithElementDataReader.hpp"
45 : #include "IO/Importers/ElementDataReader.hpp"
46 : #include "IO/Observer/Actions/RegisterEvents.hpp"
47 : #include "IO/Observer/Helpers.hpp"
48 : #include "IO/Observer/ObserverComponent.hpp"
49 : #include "NumericalAlgorithms/DiscontinuousGalerkin/Formulation.hpp"
50 : #include "NumericalAlgorithms/DiscontinuousGalerkin/Tags.hpp"
51 : #include "NumericalAlgorithms/LinearOperators/Filters/Factory.hpp"
52 : #include "NumericalAlgorithms/LinearOperators/Filters/Tag.hpp"
53 : #include "Options/Protocols/FactoryCreation.hpp"
54 : #include "Options/String.hpp"
55 : #include "Parallel/Local.hpp"
56 : #include "Parallel/Phase.hpp"
57 : #include "Parallel/PhaseControl/CheckpointAndExitAfterWallclock.hpp"
58 : #include "Parallel/PhaseControl/ExecutePhaseChange.hpp"
59 : #include "Parallel/PhaseControl/Factory.hpp"
60 : #include "Parallel/PhaseControl/VisitAndReturn.hpp"
61 : #include "Parallel/PhaseDependentActionList.hpp"
62 : #include "Parallel/Protocols/RegistrationMetavariables.hpp"
63 : #include "Parallel/Reduction.hpp"
64 : #include "ParallelAlgorithms/Actions/AddComputeTags.hpp"
65 : #include "ParallelAlgorithms/Actions/AddSimpleTags.hpp"
66 : #include "ParallelAlgorithms/Actions/InitializeItems.hpp"
67 : #include "ParallelAlgorithms/Actions/MutateApply.hpp"
68 : #include "ParallelAlgorithms/Actions/SpectralFilter.hpp"
69 : #include "ParallelAlgorithms/Actions/TerminatePhase.hpp"
70 : #include "ParallelAlgorithms/Events/ChangeFixedLtsRatio.hpp"
71 : #include "ParallelAlgorithms/Events/Completion.hpp"
72 : #include "ParallelAlgorithms/Events/Factory.hpp"
73 : #include "ParallelAlgorithms/Events/ObserveNorms.hpp"
74 : #include "ParallelAlgorithms/Events/ObserveTimeStepVolume.hpp"
75 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTrigger.hpp"
76 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTriggers/Factory.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 "ParallelAlgorithms/Interpolation/Actions/ElementInitInterpPoints.hpp"
82 : #include "ParallelAlgorithms/Interpolation/Actions/InitializeInterpolationTarget.hpp"
83 : #include "ParallelAlgorithms/Interpolation/Callbacks/ObserveTimeSeriesOnSurface.hpp"
84 : #include "ParallelAlgorithms/Interpolation/Events/InterpolateWithoutInterpComponent.hpp"
85 : #include "ParallelAlgorithms/Interpolation/InterpolationTarget.hpp"
86 : #include "ParallelAlgorithms/Interpolation/Protocols/InterpolationTargetTag.hpp"
87 : #include "ParallelAlgorithms/Interpolation/Tags.hpp"
88 : #include "ParallelAlgorithms/Interpolation/Targets/Sphere.hpp"
89 : #include "PointwiseFunctions/AnalyticData/AnalyticData.hpp"
90 : #include "PointwiseFunctions/AnalyticData/CurvedWaveEquation/PureSphericalHarmonic.hpp"
91 : #include "PointwiseFunctions/AnalyticData/Tags.hpp"
92 : #include "PointwiseFunctions/AnalyticSolutions/AnalyticSolution.hpp"
93 : #include "PointwiseFunctions/AnalyticSolutions/GeneralRelativity/KerrSchild.hpp"
94 : #include "PointwiseFunctions/AnalyticSolutions/GeneralRelativity/Minkowski.hpp"
95 : #include "PointwiseFunctions/AnalyticSolutions/Tags.hpp"
96 : #include "PointwiseFunctions/AnalyticSolutions/WaveEquation/Factory.hpp"
97 : #include "PointwiseFunctions/AnalyticSolutions/WaveEquation/PlaneWave.hpp"
98 : #include "PointwiseFunctions/GeneralRelativity/Christoffel.hpp"
99 : #include "PointwiseFunctions/GeneralRelativity/GeneralizedHarmonic/ExtrinsicCurvature.hpp"
100 : #include "PointwiseFunctions/GeneralRelativity/KerrHorizon.hpp"
101 : #include "PointwiseFunctions/GeneralRelativity/Surfaces/Tags.hpp"
102 : #include "PointwiseFunctions/InitialDataUtilities/InitialData.hpp"
103 : #include "PointwiseFunctions/InitialDataUtilities/Tags/InitialData.hpp"
104 : #include "PointwiseFunctions/MathFunctions/Factory.hpp"
105 : #include "PointwiseFunctions/MathFunctions/MathFunction.hpp"
106 : #include "Time/Actions/SelfStartActions.hpp"
107 : #include "Time/AdvanceTime.hpp"
108 : #include "Time/ChangeSlabSize/Action.hpp"
109 : #include "Time/ChangeTimeStepperOrder.hpp"
110 : #include "Time/CleanHistory.hpp"
111 : #include "Time/RecordTimeStepperData.hpp"
112 : #include "Time/StepChoosers/ByBlock.hpp"
113 : #include "Time/StepChoosers/Factory.hpp"
114 : #include "Time/StepChoosers/StepChooser.hpp"
115 : #include "Time/Tags/Time.hpp"
116 : #include "Time/Tags/TimeStepId.hpp"
117 : #include "Time/TimeSteppers/Factory.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/ProtocolHelpers.hpp"
123 : #include "Utilities/TMPL.hpp"
124 :
125 : /// \cond
126 : namespace Frame {
127 : struct Inertial;
128 : } // namespace Frame
129 : namespace Parallel {
130 : template <typename Metavariables>
131 : class CProxy_GlobalCache;
132 : } // namespace Parallel
133 : namespace PUP {
134 : class er;
135 : } // namespace PUP
136 : /// \endcond
137 :
138 : template <size_t Dim, typename BackgroundSpacetime>
139 : struct EvolutionMetavars {
140 : static constexpr size_t volume_dim = Dim;
141 0 : using background_spacetime = BackgroundSpacetime;
142 :
143 0 : using system = CurvedScalarWave::System<Dim>;
144 0 : using temporal_id = Tags::TimeStepId;
145 :
146 : static constexpr bool use_dg_element_collection = false;
147 :
148 0 : using deriv_compute = ::Tags::DerivCompute<
149 : typename system::variables_tag, domain::Tags::Mesh<volume_dim>,
150 : domain::Tags::InverseJacobian<volume_dim, Frame::ElementLogical,
151 : Frame::Inertial>,
152 : typename system::gradient_variables>;
153 :
154 0 : using observe_fields = tmpl::push_back<
155 : tmpl::flatten<tmpl::list<
156 : tmpl::append<typename system::variables_tag::tags_list,
157 : typename deriv_compute::type::tags_list>,
158 : ::Events::Tags::ObserverDetInvJacobianCompute<Frame::ElementLogical,
159 : Frame::Inertial>,
160 : CurvedScalarWave::Tags::OneIndexConstraintCompute<volume_dim>,
161 : CurvedScalarWave::Tags::TwoIndexConstraintCompute<volume_dim>,
162 : ::Tags::PointwiseL2NormCompute<
163 : CurvedScalarWave::Tags::OneIndexConstraint<volume_dim>>,
164 : ::Tags::PointwiseL2NormCompute<
165 : CurvedScalarWave::Tags::TwoIndexConstraint<volume_dim>>>>,
166 : domain::Tags::Coordinates<volume_dim, Frame::Grid>,
167 : domain::Tags::Coordinates<volume_dim, Frame::Inertial>>;
168 0 : using non_tensor_compute_tags =
169 : tmpl::list<::Events::Tags::ObserverMeshCompute<volume_dim>,
170 : deriv_compute>;
171 :
172 0 : static constexpr bool interpolate = volume_dim == 3;
173 0 : struct SphericalSurface
174 : : tt::ConformsTo<intrp::protocols::InterpolationTargetTag> {
175 0 : using temporal_id = ::Tags::Time;
176 0 : using vars_to_interpolate_to_target =
177 : tmpl::list<gr::Tags::SpatialMetric<DataVector, Dim>,
178 : CurvedScalarWave::Tags::Psi>;
179 0 : using compute_items_on_target =
180 : tmpl::list<CurvedScalarWave::Tags::PsiSquaredCompute,
181 : gr::surfaces::Tags::AreaElementCompute<::Frame::Inertial>,
182 : gr::surfaces::Tags::SurfaceIntegralCompute<
183 : CurvedScalarWave::Tags::PsiSquared, ::Frame::Inertial>>;
184 0 : using compute_target_points =
185 : intrp::TargetPoints::Sphere<SphericalSurface, ::Frame::Inertial>;
186 0 : using post_interpolation_callbacks =
187 : tmpl::list<intrp::callbacks::ObserveTimeSeriesOnSurface<
188 : tmpl::list<gr::surfaces::Tags::SurfaceIntegral<
189 : CurvedScalarWave::Tags::PsiSquared, ::Frame::Inertial>>,
190 : SphericalSurface>>;
191 : template <typename metavariables>
192 0 : using interpolating_component = typename metavariables::dg_element_array;
193 : };
194 :
195 0 : using initial_data_list = tmpl::flatten<tmpl::list<
196 : ScalarWave::Solutions::all_solutions<Dim>,
197 : tmpl::conditional_t<
198 : Dim == 3,
199 : tmpl::list<CurvedScalarWave::AnalyticData::PureSphericalHarmonic,
200 : CurvedScalarWave::NumericInitialData>,
201 : tmpl::list<>>>>;
202 0 : using interpolation_target_tags = tmpl::list<SphericalSurface>;
203 0 : using interpolator_source_vars =
204 : tmpl::list<gr::Tags::SpatialMetric<DataVector, volume_dim>,
205 : CurvedScalarWave::Tags::Psi>;
206 : struct factory_creation
207 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
208 0 : using factory_classes = tmpl::map<
209 : tmpl::pair<
210 : CurvedScalarWave::BoundaryConditions::BoundaryCondition<volume_dim>,
211 : CurvedScalarWave::BoundaryConditions::standard_boundary_conditions<
212 : volume_dim>>,
213 : tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
214 : tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
215 : tmpl::pair<
216 : Event,
217 : tmpl::flatten<tmpl::list<
218 : Events::Completion,
219 : dg::Events::field_observations<volume_dim, observe_fields,
220 : non_tensor_compute_tags>,
221 : tmpl::conditional_t<
222 : interpolate,
223 : intrp::Events::InterpolateWithoutInterpComponent<
224 : volume_dim, SphericalSurface, interpolator_source_vars>,
225 : tmpl::list<>>,
226 : Events::time_events<system>,
227 : dg::Events::ObserveTimeStepVolume<system>,
228 : dg::Events::ChangeFixedLtsRatio<volume_dim>>>>,
229 : tmpl::pair<evolution::BoundaryCorrection,
230 : CurvedScalarWave::BoundaryCorrections::
231 : standard_boundary_corrections<volume_dim>>,
232 : tmpl::pair<evolution::initial_data::InitialData, initial_data_list>,
233 : tmpl::pair<MathFunction<1, Frame::Inertial>,
234 : MathFunctions::all_math_functions<1, Frame::Inertial>>,
235 : tmpl::pair<PhaseChange, PhaseControl::factory_creatable_classes>,
236 : tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
237 : tmpl::push_back<StepChoosers::standard_step_choosers<system>,
238 : StepChoosers::ByBlock<volume_dim>>>,
239 : tmpl::pair<StepChooser<StepChooserUse::Slab>,
240 : tmpl::push_back<
241 : StepChoosers::standard_slab_choosers<system>,
242 : evolution::dg::StepChoosers::FixedLtsRatio<volume_dim>,
243 : StepChoosers::ByBlock<volume_dim>>>,
244 : tmpl::pair<TimeSequence<double>,
245 : TimeSequences::all_time_sequences<double>>,
246 : tmpl::pair<TimeSequence<std::uint64_t>,
247 : TimeSequences::all_time_sequences<std::uint64_t>>,
248 : tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
249 : tmpl::pair<Trigger, tmpl::append<Triggers::logical_triggers,
250 : Triggers::time_triggers>>,
251 : tmpl::pair<Filters::Filter<volume_dim,
252 : typename system::variables_tag::tags_list>,
253 : Filters::all_filters<
254 : volume_dim, typename system::variables_tag::tags_list>>>;
255 : };
256 :
257 0 : using observed_reduction_data_tags = observers::collect_reduction_data_tags<
258 : tmpl::at<typename factory_creation::factory_classes, Event>>;
259 :
260 0 : using step_actions = tmpl::flatten<tmpl::list<
261 : CurvedScalarWave::Actions::CalculateGrVars<system, true>,
262 : evolution::dg::Actions::ComputeTimeDerivative<
263 : volume_dim, system, AllStepChoosers, use_dg_element_collection>,
264 : evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
265 : volume_dim, use_dg_element_collection>,
266 : Actions::MutateApply<RecordTimeStepperData<system>>,
267 : evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<
268 : evolution::dg::ApplyLtsDenseBoundaryCorrections<EvolutionMetavars>>>,
269 : Actions::MutateApply<UpdateU<system>>,
270 : evolution::dg::Actions::ApplyLtsBoundaryCorrections<
271 : volume_dim, use_dg_element_collection>,
272 : Actions::MutateApply<ChangeTimeStepperOrder<system>>,
273 : Actions::MutateApply<CleanHistory<system>>,
274 : Actions::MutateApply<evolution::dg::CleanMortarHistory<volume_dim>>,
275 : dg::Actions::SpectralFilter<volume_dim,
276 : typename system::variables_tag::tags_list>>>;
277 :
278 0 : using const_global_cache_tags = tmpl::list<
279 : CurvedScalarWave::Tags::BackgroundSpacetime<BackgroundSpacetime>,
280 : evolution::initial_data::Tags::InitialData>;
281 :
282 0 : using dg_registration_list =
283 : tmpl::list<observers::Actions::RegisterEventsWithObservers>;
284 :
285 0 : using equal_rate_regions =
286 : tmpl::list<evolution::dg::NonconformingEqualRateRegions<volume_dim>>;
287 :
288 0 : using initialization_actions = tmpl::list<
289 : Initialization::Actions::InitializeItems<
290 : Initialization::TimeStepping<EvolutionMetavars, TimeStepper, false,
291 : true>,
292 : evolution::dg::Initialization::Domain<EvolutionMetavars>>,
293 : Initialization::Actions::NonconservativeSystem<system>,
294 : Initialization::Actions::InitializeItems<
295 : Initialization::TimeStepperHistory<system>>,
296 : CurvedScalarWave::Actions::CalculateGrVars<system, false>,
297 : Initialization::Actions::AddSimpleTags<
298 : CurvedScalarWave::Initialization::InitializeConstraintDampingGammas<
299 : volume_dim>>,
300 : Initialization::Actions::AddComputeTags<
301 : StepChoosers::step_chooser_compute_tags<EvolutionMetavars>>,
302 : ::evolution::dg::Initialization::Mortars<volume_dim>,
303 : intrp::Actions::ElementInitInterpPoints<volume_dim,
304 : interpolation_target_tags>,
305 : evolution::dg::Initialization::Actions::SetupEqualRateRegions<
306 : EvolutionMetavars, volume_dim, equal_rate_regions>,
307 : evolution::Actions::InitializeRunEventsAndDenseTriggers,
308 : Initialization::Actions::InitializeItems<
309 : evolution::dg::Initialization::SpectralFilters<
310 : volume_dim, typename system::variables_tag::tags_list>>,
311 : Parallel::Actions::TerminatePhase>;
312 :
313 0 : using dg_element_array = DgElementArray<
314 : EvolutionMetavars,
315 : tmpl::list<
316 : Parallel::PhaseActions<Parallel::Phase::Initialization,
317 : initialization_actions>,
318 : Parallel::PhaseActions<
319 : Parallel::Phase::RegisterWithElementDataReader,
320 : tmpl::list<importers::Actions::RegisterWithElementDataReader,
321 : Parallel::Actions::TerminatePhase>>,
322 : Parallel::PhaseActions<
323 : Parallel::Phase::ImportInitialData,
324 : tmpl::list<CurvedScalarWave::Actions::SetInitialData,
325 : CurvedScalarWave::Actions::ReceiveNumericInitialData,
326 : Parallel::Actions::TerminatePhase>>,
327 : Parallel::PhaseActions<
328 : Parallel::Phase::InitializeTimeStepperHistory,
329 : SelfStart::self_start_procedure<step_actions, system>>,
330 : Parallel::PhaseActions<Parallel::Phase::Register,
331 : tmpl::list<dg_registration_list,
332 : Parallel::Actions::TerminatePhase>>,
333 : Parallel::PhaseActions<Parallel::Phase::Restart,
334 : tmpl::list<dg_registration_list,
335 : Parallel::Actions::TerminatePhase>>,
336 : Parallel::PhaseActions<
337 : Parallel::Phase::WriteCheckpoint,
338 : tmpl::list<evolution::Actions::RunEventsAndTriggers<
339 : Triggers::WhenToCheck::AtCheckpoints>,
340 : Parallel::Actions::TerminatePhase>>,
341 : Parallel::PhaseActions<
342 : Parallel::Phase::Evolve,
343 : tmpl::flatten<
344 : tmpl::list<evolution::Actions::RunEventsAndTriggers<
345 : Triggers::WhenToCheck::AtSteps>,
346 : evolution::Actions::RunEventsAndTriggers<
347 : Triggers::WhenToCheck::AtSlabs>,
348 : Actions::ChangeSlabSize,
349 : evolution::dg::Actions::ChangeFixedLtsRatio,
350 : step_actions, Actions::MutateApply<AdvanceTime<>>,
351 : PhaseControl::Actions::ExecutePhaseChange>>>>>;
352 :
353 : struct registration
354 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
355 0 : using element_registrars =
356 : tmpl::map<tmpl::pair<dg_element_array, dg_registration_list>>;
357 : };
358 :
359 0 : using component_list = tmpl::flatten<
360 : tmpl::list<observers::Observer<EvolutionMetavars>,
361 : observers::ObserverWriter<EvolutionMetavars>,
362 : importers::ElementDataReader<EvolutionMetavars>,
363 : tmpl::conditional_t<interpolate,
364 : intrp::InterpolationTarget<
365 : EvolutionMetavars, SphericalSurface>,
366 : tmpl::list<>>,
367 : dg_element_array>>;
368 :
369 : static constexpr Options::String help{
370 : "Evolve a scalar wave in Dim spatial dimension on a curved background "
371 : "spacetime."};
372 :
373 0 : static constexpr auto default_phase_order =
374 : std::array{Parallel::Phase::Initialization,
375 : Parallel::Phase::RegisterWithElementDataReader,
376 : Parallel::Phase::ImportInitialData,
377 : Parallel::Phase::InitializeTimeStepperHistory,
378 : Parallel::Phase::Register,
379 : Parallel::Phase::Evolve,
380 : Parallel::Phase::Exit};
381 :
382 : // NOLINTNEXTLINE(google-runtime-references)
383 0 : void pup(PUP::er& /*p*/) {}
384 : };
|
