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/LtsTimeStepper.hpp"
119 : #include "Time/TimeSteppers/TimeStepper.hpp"
120 : #include "Time/Triggers/TimeTriggers.hpp"
121 : #include "Time/UpdateU.hpp"
122 : #include "Utilities/ErrorHandling/Error.hpp"
123 : #include "Utilities/ProtocolHelpers.hpp"
124 : #include "Utilities/TMPL.hpp"
125 :
126 : /// \cond
127 : namespace Frame {
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, typename BackgroundSpacetime>
140 : struct EvolutionMetavars {
141 : static constexpr size_t volume_dim = Dim;
142 0 : using background_spacetime = BackgroundSpacetime;
143 :
144 0 : using system = CurvedScalarWave::System<Dim>;
145 0 : using temporal_id = Tags::TimeStepId;
146 0 : using TimeStepperBase = LtsTimeStepper;
147 :
148 : static constexpr bool local_time_stepping =
149 : TimeStepperBase::local_time_stepping;
150 : static constexpr bool use_dg_element_collection = false;
151 :
152 0 : using deriv_compute = ::Tags::DerivCompute<
153 : typename system::variables_tag, domain::Tags::Mesh<volume_dim>,
154 : domain::Tags::InverseJacobian<volume_dim, Frame::ElementLogical,
155 : Frame::Inertial>,
156 : typename system::gradient_variables>;
157 :
158 0 : using observe_fields = tmpl::push_back<
159 : tmpl::flatten<tmpl::list<
160 : tmpl::append<typename system::variables_tag::tags_list,
161 : typename deriv_compute::type::tags_list>,
162 : ::Events::Tags::ObserverDetInvJacobianCompute<Frame::ElementLogical,
163 : Frame::Inertial>,
164 : CurvedScalarWave::Tags::OneIndexConstraintCompute<volume_dim>,
165 : CurvedScalarWave::Tags::TwoIndexConstraintCompute<volume_dim>,
166 : ::Tags::PointwiseL2NormCompute<
167 : CurvedScalarWave::Tags::OneIndexConstraint<volume_dim>>,
168 : ::Tags::PointwiseL2NormCompute<
169 : CurvedScalarWave::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 : deriv_compute>;
175 :
176 0 : static constexpr bool interpolate = volume_dim == 3;
177 0 : struct SphericalSurface
178 : : tt::ConformsTo<intrp::protocols::InterpolationTargetTag> {
179 0 : using temporal_id = ::Tags::Time;
180 0 : using vars_to_interpolate_to_target =
181 : tmpl::list<gr::Tags::SpatialMetric<DataVector, Dim>,
182 : CurvedScalarWave::Tags::Psi>;
183 0 : using compute_items_on_target =
184 : tmpl::list<CurvedScalarWave::Tags::PsiSquaredCompute,
185 : gr::surfaces::Tags::AreaElementCompute<::Frame::Inertial>,
186 : gr::surfaces::Tags::SurfaceIntegralCompute<
187 : CurvedScalarWave::Tags::PsiSquared, ::Frame::Inertial>>;
188 0 : using compute_target_points =
189 : intrp::TargetPoints::Sphere<SphericalSurface, ::Frame::Inertial>;
190 0 : using post_interpolation_callbacks =
191 : tmpl::list<intrp::callbacks::ObserveTimeSeriesOnSurface<
192 : tmpl::list<gr::surfaces::Tags::SurfaceIntegral<
193 : CurvedScalarWave::Tags::PsiSquared, ::Frame::Inertial>>,
194 : SphericalSurface>>;
195 : template <typename metavariables>
196 0 : using interpolating_component = typename metavariables::dg_element_array;
197 : };
198 :
199 0 : using initial_data_list = tmpl::flatten<tmpl::list<
200 : ScalarWave::Solutions::all_solutions<Dim>,
201 : tmpl::conditional_t<
202 : Dim == 3,
203 : tmpl::list<CurvedScalarWave::AnalyticData::PureSphericalHarmonic,
204 : CurvedScalarWave::NumericInitialData>,
205 : tmpl::list<>>>>;
206 0 : using interpolation_target_tags = tmpl::list<SphericalSurface>;
207 0 : using interpolator_source_vars =
208 : tmpl::list<gr::Tags::SpatialMetric<DataVector, volume_dim>,
209 : CurvedScalarWave::Tags::Psi>;
210 : struct factory_creation
211 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
212 0 : using factory_classes = tmpl::map<
213 : tmpl::pair<
214 : CurvedScalarWave::BoundaryConditions::BoundaryCondition<volume_dim>,
215 : CurvedScalarWave::BoundaryConditions::standard_boundary_conditions<
216 : volume_dim>>,
217 : tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
218 : tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
219 : tmpl::pair<
220 : Event,
221 : tmpl::flatten<tmpl::list<
222 : Events::Completion,
223 : dg::Events::field_observations<volume_dim, observe_fields,
224 : non_tensor_compute_tags>,
225 : tmpl::conditional_t<
226 : interpolate,
227 : intrp::Events::InterpolateWithoutInterpComponent<
228 : volume_dim, SphericalSurface, interpolator_source_vars>,
229 : tmpl::list<>>,
230 : Events::time_events<system>,
231 : dg::Events::ObserveTimeStepVolume<system>,
232 : dg::Events::ChangeFixedLtsRatio<volume_dim>>>>,
233 : tmpl::pair<evolution::BoundaryCorrection,
234 : CurvedScalarWave::BoundaryCorrections::
235 : standard_boundary_corrections<volume_dim>>,
236 : tmpl::pair<evolution::initial_data::InitialData, initial_data_list>,
237 : tmpl::pair<LtsTimeStepper, TimeSteppers::lts_time_steppers>,
238 : tmpl::pair<MathFunction<1, Frame::Inertial>,
239 : MathFunctions::all_math_functions<1, Frame::Inertial>>,
240 : tmpl::pair<PhaseChange, PhaseControl::factory_creatable_classes>,
241 : tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
242 : tmpl::push_back<StepChoosers::standard_step_choosers<system>,
243 : StepChoosers::ByBlock<volume_dim>>>,
244 : tmpl::pair<StepChooser<StepChooserUse::Slab>,
245 : tmpl::push_back<
246 : StepChoosers::standard_slab_choosers<system>,
247 : evolution::dg::StepChoosers::FixedLtsRatio<volume_dim>,
248 : StepChoosers::ByBlock<volume_dim>>>,
249 : tmpl::pair<TimeSequence<double>,
250 : TimeSequences::all_time_sequences<double>>,
251 : tmpl::pair<TimeSequence<std::uint64_t>,
252 : TimeSequences::all_time_sequences<std::uint64_t>>,
253 : tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
254 : tmpl::pair<Trigger, tmpl::append<Triggers::logical_triggers,
255 : Triggers::time_triggers>>,
256 : tmpl::pair<Filters::Filter<volume_dim,
257 : typename system::variables_tag::tags_list>,
258 : Filters::all_filters<
259 : volume_dim, typename system::variables_tag::tags_list>>>;
260 : };
261 :
262 0 : using observed_reduction_data_tags = observers::collect_reduction_data_tags<
263 : tmpl::at<typename factory_creation::factory_classes, Event>>;
264 :
265 0 : using step_actions = tmpl::flatten<tmpl::list<
266 : CurvedScalarWave::Actions::CalculateGrVars<system, true>,
267 : evolution::dg::Actions::ComputeTimeDerivative<
268 : volume_dim, system, AllStepChoosers, local_time_stepping,
269 : use_dg_element_collection>,
270 : evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
271 : volume_dim, use_dg_element_collection>,
272 : Actions::MutateApply<RecordTimeStepperData<system>>,
273 : evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<
274 : evolution::dg::ApplyLtsDenseBoundaryCorrections<EvolutionMetavars>>>,
275 : Actions::MutateApply<UpdateU<system, local_time_stepping>>,
276 : evolution::dg::Actions::ApplyLtsBoundaryCorrections<
277 : volume_dim, use_dg_element_collection>,
278 : tmpl::conditional_t<
279 : local_time_stepping,
280 : tmpl::list<Actions::MutateApply<ChangeTimeStepperOrder<system>>>,
281 : tmpl::list<>>,
282 : Actions::MutateApply<CleanHistory<system>>,
283 : Actions::MutateApply<evolution::dg::CleanMortarHistory<volume_dim>>,
284 : dg::Actions::SpectralFilter>>;
285 :
286 0 : using const_global_cache_tags = tmpl::list<
287 : CurvedScalarWave::Tags::BackgroundSpacetime<BackgroundSpacetime>,
288 : evolution::initial_data::Tags::InitialData>;
289 :
290 0 : using dg_registration_list =
291 : tmpl::list<observers::Actions::RegisterEventsWithObservers>;
292 :
293 0 : using equal_rate_regions =
294 : tmpl::list<evolution::dg::NonconformingEqualRateRegions<volume_dim>>;
295 :
296 0 : using initialization_actions = tmpl::list<
297 : Initialization::Actions::InitializeItems<
298 : Initialization::TimeStepping<EvolutionMetavars, TimeStepperBase,
299 : false, local_time_stepping>,
300 : evolution::dg::Initialization::Domain<EvolutionMetavars>,
301 : Initialization::TimeStepperHistory<EvolutionMetavars>>,
302 : Initialization::Actions::NonconservativeSystem<system>,
303 : CurvedScalarWave::Actions::CalculateGrVars<system, false>,
304 : Initialization::Actions::AddSimpleTags<
305 : CurvedScalarWave::Initialization::InitializeConstraintDampingGammas<
306 : volume_dim>>,
307 : Initialization::Actions::AddComputeTags<
308 : StepChoosers::step_chooser_compute_tags<EvolutionMetavars>>,
309 : ::evolution::dg::Initialization::Mortars<volume_dim>,
310 : intrp::Actions::ElementInitInterpPoints<volume_dim,
311 : interpolation_target_tags>,
312 : evolution::dg::Initialization::Actions::SetupEqualRateRegions<
313 : EvolutionMetavars, volume_dim, equal_rate_regions>,
314 : evolution::Actions::InitializeRunEventsAndDenseTriggers,
315 : Initialization::Actions::InitializeItems<
316 : evolution::dg::Initialization::SpectralFilters<
317 : volume_dim, typename system::variables_tag::tags_list>>,
318 : Parallel::Actions::TerminatePhase>;
319 :
320 0 : using dg_element_array = DgElementArray<
321 : EvolutionMetavars,
322 : tmpl::list<
323 : Parallel::PhaseActions<Parallel::Phase::Initialization,
324 : initialization_actions>,
325 : Parallel::PhaseActions<
326 : Parallel::Phase::RegisterWithElementDataReader,
327 : tmpl::list<importers::Actions::RegisterWithElementDataReader,
328 : Parallel::Actions::TerminatePhase>>,
329 : Parallel::PhaseActions<
330 : Parallel::Phase::ImportInitialData,
331 : tmpl::list<CurvedScalarWave::Actions::SetInitialData,
332 : CurvedScalarWave::Actions::ReceiveNumericInitialData,
333 : Parallel::Actions::TerminatePhase>>,
334 : Parallel::PhaseActions<
335 : Parallel::Phase::InitializeTimeStepperHistory,
336 : SelfStart::self_start_procedure<step_actions, system>>,
337 : Parallel::PhaseActions<Parallel::Phase::Register,
338 : tmpl::list<dg_registration_list,
339 : Parallel::Actions::TerminatePhase>>,
340 : Parallel::PhaseActions<Parallel::Phase::Restart,
341 : tmpl::list<dg_registration_list,
342 : Parallel::Actions::TerminatePhase>>,
343 : Parallel::PhaseActions<
344 : Parallel::Phase::WriteCheckpoint,
345 : tmpl::list<evolution::Actions::RunEventsAndTriggers<
346 : Triggers::WhenToCheck::AtCheckpoints>,
347 : Parallel::Actions::TerminatePhase>>,
348 : Parallel::PhaseActions<
349 : Parallel::Phase::Evolve,
350 : tmpl::flatten<tmpl::list<
351 : std::conditional_t<local_time_stepping,
352 : evolution::Actions::RunEventsAndTriggers<
353 : Triggers::WhenToCheck::AtSteps>,
354 : tmpl::list<>>,
355 : evolution::Actions::RunEventsAndTriggers<
356 : Triggers::WhenToCheck::AtSlabs>,
357 : Actions::ChangeSlabSize,
358 : evolution::dg::Actions::ChangeFixedLtsRatio, step_actions,
359 : Actions::MutateApply<AdvanceTime<>>,
360 : PhaseControl::Actions::ExecutePhaseChange>>>>>;
361 :
362 : struct registration
363 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
364 0 : using element_registrars =
365 : tmpl::map<tmpl::pair<dg_element_array, dg_registration_list>>;
366 : };
367 :
368 0 : using component_list = tmpl::flatten<
369 : tmpl::list<observers::Observer<EvolutionMetavars>,
370 : observers::ObserverWriter<EvolutionMetavars>,
371 : importers::ElementDataReader<EvolutionMetavars>,
372 : tmpl::conditional_t<interpolate,
373 : intrp::InterpolationTarget<
374 : EvolutionMetavars, SphericalSurface>,
375 : tmpl::list<>>,
376 : dg_element_array>>;
377 :
378 : static constexpr Options::String help{
379 : "Evolve a scalar wave in Dim spatial dimension on a curved background "
380 : "spacetime."};
381 :
382 0 : static constexpr auto default_phase_order =
383 : std::array{Parallel::Phase::Initialization,
384 : Parallel::Phase::RegisterWithElementDataReader,
385 : Parallel::Phase::ImportInitialData,
386 : Parallel::Phase::InitializeTimeStepperHistory,
387 : Parallel::Phase::Register,
388 : Parallel::Phase::Evolve,
389 : Parallel::Phase::Exit};
390 :
391 : // NOLINTNEXTLINE(google-runtime-references)
392 0 : void pup(PUP::er& /*p*/) {}
393 : };
|
