Line data Source code
1 0 : // Distributed under the MIT License.
2 : // See LICENSE.txt for details.
3 :
4 : #pragma once
5 :
6 : #include <array>
7 : #include <cstddef>
8 : #include <cstdint>
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/Actions/SendAuxiliaryData.hpp"
22 : #include "Evolution/DiscontinuousGalerkin/CleanMortarHistory.hpp"
23 : #include "Evolution/DiscontinuousGalerkin/DgElementArray.hpp"
24 : #include "Evolution/DiscontinuousGalerkin/Initialization/BoundaryEvolvedVariables.hpp"
25 : #include "Evolution/DiscontinuousGalerkin/Initialization/Mortars.hpp"
26 : #include "Evolution/DiscontinuousGalerkin/Initialization/SpectralFilters.hpp"
27 : #include "Evolution/Initialization/DgDomain.hpp"
28 : #include "Evolution/Initialization/Evolution.hpp"
29 : #include "Evolution/Initialization/NonconservativeSystem.hpp"
30 : #include "Evolution/Initialization/SetVariables.hpp"
31 : #include "Evolution/Systems/SecondOrderScalarWave/BoundaryConditions/Factory.hpp"
32 : #include "Evolution/Systems/SecondOrderScalarWave/BoundaryCorrections/Factory.hpp"
33 : #include "Evolution/Systems/SecondOrderScalarWave/System.hpp"
34 : #include "Evolution/Systems/SecondOrderScalarWave/UpdateAuxiliaryVariables.hpp"
35 : #include "IO/Observer/Actions/RegisterEvents.hpp"
36 : #include "IO/Observer/Helpers.hpp"
37 : #include "IO/Observer/ObserverComponent.hpp"
38 : #include "NumericalAlgorithms/LinearOperators/Filters/Factory.hpp"
39 : #include "Options/Protocols/FactoryCreation.hpp"
40 : #include "Options/String.hpp"
41 : #include "Parallel/Phase.hpp"
42 : #include "Parallel/PhaseControl/ExecutePhaseChange.hpp"
43 : #include "Parallel/PhaseControl/Factory.hpp"
44 : #include "Parallel/PhaseDependentActionList.hpp"
45 : #include "Parallel/Protocols/RegistrationMetavariables.hpp"
46 : #include "ParallelAlgorithms/Actions/AddComputeTags.hpp"
47 : #include "ParallelAlgorithms/Actions/InitializeItems.hpp"
48 : #include "ParallelAlgorithms/Actions/MutateApply.hpp"
49 : #include "ParallelAlgorithms/Actions/RandomizeVariables.hpp"
50 : #include "ParallelAlgorithms/Actions/SpectralFilter.hpp"
51 : #include "ParallelAlgorithms/Actions/TerminatePhase.hpp"
52 : #include "ParallelAlgorithms/Events/Completion.hpp"
53 : #include "ParallelAlgorithms/Events/Factory.hpp"
54 : #include "ParallelAlgorithms/Events/Tags.hpp"
55 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTrigger.hpp"
56 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTriggers/Factory.hpp"
57 : #include "ParallelAlgorithms/EventsAndTriggers/Event.hpp"
58 : #include "ParallelAlgorithms/EventsAndTriggers/LogicalTriggers.hpp"
59 : #include "ParallelAlgorithms/EventsAndTriggers/Trigger.hpp"
60 : #include "PointwiseFunctions/AnalyticSolutions/Tags.hpp"
61 : #include "PointwiseFunctions/AnalyticSolutions/WaveEquation/Factory.hpp"
62 : #include "PointwiseFunctions/InitialDataUtilities/NumericData.hpp"
63 : #include "PointwiseFunctions/MathFunctions/Factory.hpp"
64 : #include "PointwiseFunctions/MathFunctions/MathFunction.hpp"
65 : #include "Time/Actions/SelfStartActions.hpp"
66 : #include "Time/AdvanceTime.hpp"
67 : #include "Time/ChangeSlabSize/Action.hpp"
68 : #include "Time/ChangeTimeStepperOrder.hpp"
69 : #include "Time/CleanHistory.hpp"
70 : #include "Time/RecordTimeStepperData.hpp"
71 : #include "Time/StepChoosers/Factory.hpp"
72 : #include "Time/StepChoosers/StepChooser.hpp"
73 : #include "Time/Tags/TimeStepId.hpp"
74 : #include "Time/TimeSequence.hpp"
75 : #include "Time/TimeSteppers/Factory.hpp"
76 : #include "Time/TimeSteppers/TimeStepper.hpp"
77 : #include "Time/Triggers/TimeTriggers.hpp"
78 : #include "Time/UpdateU.hpp"
79 : #include "Utilities/ProtocolHelpers.hpp"
80 : #include "Utilities/TMPL.hpp" // IWYU pragma: keep
81 :
82 : /// \cond
83 : namespace PUP {
84 : class er;
85 : } // namespace PUP
86 : /// \endcond
87 :
88 : template <size_t Dim>
89 : struct EvolutionMetavars {
90 : static constexpr size_t volume_dim = Dim;
91 :
92 0 : using initial_data_list =
93 : SecondOrderScalarWave::Solutions::all_solutions<Dim>;
94 :
95 0 : using system = SecondOrderScalarWave::System<Dim>;
96 0 : using temporal_id = Tags::TimeStepId;
97 :
98 : // For labeling the yaml option for RandomizeVariables
99 0 : struct RandomizeInitialData {};
100 :
101 : static constexpr bool use_dg_element_collection = false;
102 :
103 : // The system's variables_tag is list-valued (split volume/boundary
104 : // variables); the DG actions act on the volume entry.
105 0 : using volume_variables_tag = ::Tags::Variables<typename system::volume_vars>;
106 :
107 0 : using analytic_solution_fields = typename system::volume_vars;
108 0 : using analytic_compute =
109 : evolution::Tags::AnalyticSolutionsCompute<Dim, analytic_solution_fields,
110 : false, initial_data_list>;
111 0 : using error_compute = Tags::ErrorsCompute<analytic_solution_fields>;
112 0 : using error_tags = db::wrap_tags_in<Tags::Error, analytic_solution_fields>;
113 :
114 0 : using observe_fields =
115 : tmpl::push_back<tmpl::append<typename system::volume_vars, error_tags>,
116 : domain::Tags::Coordinates<volume_dim, Frame::Grid>,
117 : domain::Tags::Coordinates<volume_dim, Frame::Inertial>>;
118 0 : using non_tensor_compute_tags =
119 : tmpl::list<::Events::Tags::ObserverMeshCompute<volume_dim>,
120 : ::Events::Tags::ObserverDetInvJacobianCompute<
121 : Frame::ElementLogical, Frame::Inertial>,
122 : analytic_compute, error_compute>;
123 :
124 : struct factory_creation
125 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
126 0 : using factory_classes = tmpl::map<
127 : tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
128 : tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
129 : tmpl::pair<Event,
130 : tmpl::flatten<tmpl::list<
131 : Events::Completion,
132 : dg::Events::field_observations<
133 : volume_dim, observe_fields, non_tensor_compute_tags>,
134 : Events::time_events<system>>>>,
135 : tmpl::pair<evolution::BoundaryCorrection,
136 : SecondOrderScalarWave::BoundaryCorrections::
137 : standard_boundary_corrections<volume_dim>>,
138 : tmpl::pair<evolution::initial_data::InitialData,
139 : tmpl::push_back<initial_data_list,
140 : evolution::initial_data::NumericData>>,
141 : tmpl::pair<MathFunction<1, Frame::Inertial>,
142 : MathFunctions::all_math_functions<1, Frame::Inertial>>,
143 : tmpl::pair<PhaseChange, PhaseControl::factory_creatable_classes>,
144 : tmpl::pair<SecondOrderScalarWave::BoundaryConditions::BoundaryCondition<
145 : volume_dim>,
146 : SecondOrderScalarWave::BoundaryConditions::
147 : standard_boundary_conditions<volume_dim>>,
148 : tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
149 : StepChoosers::standard_step_choosers<system>>,
150 : tmpl::pair<StepChooser<StepChooserUse::Slab>,
151 : StepChoosers::standard_slab_choosers<system>>,
152 : tmpl::pair<TimeSequence<double>,
153 : TimeSequences::all_time_sequences<double>>,
154 : tmpl::pair<TimeSequence<std::uint64_t>,
155 : TimeSequences::all_time_sequences<std::uint64_t>>,
156 : tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
157 : tmpl::pair<Trigger, tmpl::append<Triggers::logical_triggers,
158 : Triggers::time_triggers>>,
159 : tmpl::pair<
160 : Filters::Filter<volume_dim, typename system::volume_vars>,
161 : Filters::all_filters<volume_dim, typename system::volume_vars>>>;
162 : };
163 :
164 0 : using observed_reduction_data_tags =
165 : observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
166 : tmpl::at<typename factory_creation::factory_classes, Event>>>>;
167 :
168 0 : using step_actions = tmpl::flatten<tmpl::list<
169 : Actions::MutateApply<
170 : SecondOrderScalarWave::UpdateAuxiliaryVariables<volume_dim>>,
171 : evolution::dg::Actions::SendAuxiliaryData<
172 : volume_dim, system, use_dg_element_collection, volume_variables_tag>,
173 : evolution::dg::Actions::ApplyAuxiliaryBoundaryCorrectionsToVariables<
174 : volume_dim, use_dg_element_collection, volume_variables_tag>,
175 : evolution::dg::Actions::ComputeTimeDerivative<
176 : volume_dim, system, AllStepChoosers, use_dg_element_collection,
177 : volume_variables_tag>,
178 : evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
179 : volume_dim, use_dg_element_collection, volume_variables_tag>,
180 : Actions::MutateApply<RecordTimeStepperData<system>>,
181 : evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<>>,
182 : Actions::MutateApply<UpdateU<system>>,
183 : Actions::MutateApply<ChangeTimeStepperOrder<system>>,
184 : Actions::MutateApply<CleanHistory<system>>,
185 : Actions::MutateApply<evolution::dg::CleanMortarHistory<volume_dim>>,
186 : dg::Actions::SpectralFilter<volume_dim, typename system::volume_vars>>>;
187 :
188 0 : using const_global_cache_tags =
189 : tmpl::list<evolution::initial_data::Tags::InitialData>;
190 :
191 0 : using dg_registration_list =
192 : tmpl::list<observers::Actions::RegisterEventsWithObservers>;
193 :
194 0 : using initialization_actions = tmpl::list<
195 : Initialization::Actions::InitializeItems<
196 : // LDG infrastructure does not suppory LTS for now.
197 : Initialization::TimeStepping<EvolutionMetavars, TimeStepper, false,
198 : false>,
199 : evolution::dg::Initialization::Domain<EvolutionMetavars>>,
200 : Initialization::Actions::NonconservativeSystem<system>,
201 : evolution::Initialization::Actions::SetVariables<
202 : domain::Tags::Coordinates<Dim, Frame::ElementLogical>>,
203 : ::Actions::RandomizeVariables<volume_variables_tag, RandomizeInitialData>,
204 : evolution::dg::Initialization::BoundaryEvolvedVariables<
205 : volume_dim, system,
206 : SecondOrderScalarWave::BoundaryConditions::
207 : standard_boundary_conditions<volume_dim>>,
208 : Initialization::Actions::InitializeItems<
209 : Initialization::TimeStepperHistory<system>>,
210 : Initialization::Actions::AddComputeTags<
211 : StepChoosers::step_chooser_compute_tags<EvolutionMetavars>>,
212 : ::evolution::dg::Initialization::Mortars<volume_dim>,
213 : evolution::Actions::InitializeRunEventsAndDenseTriggers,
214 : Initialization::Actions::InitializeItems<
215 : evolution::dg::Initialization::SpectralFilters<
216 : volume_dim, typename system::volume_vars>>,
217 : Parallel::Actions::TerminatePhase>;
218 :
219 0 : using dg_element_array = DgElementArray<
220 : EvolutionMetavars,
221 : tmpl::list<
222 : Parallel::PhaseActions<Parallel::Phase::Initialization,
223 : initialization_actions>,
224 :
225 : Parallel::PhaseActions<
226 : Parallel::Phase::InitializeTimeStepperHistory,
227 : SelfStart::self_start_procedure<step_actions, system>>,
228 :
229 : Parallel::PhaseActions<Parallel::Phase::Register,
230 : tmpl::list<dg_registration_list,
231 : Parallel::Actions::TerminatePhase>>,
232 :
233 : Parallel::PhaseActions<Parallel::Phase::Restart,
234 : tmpl::list<dg_registration_list,
235 : Parallel::Actions::TerminatePhase>>,
236 :
237 : Parallel::PhaseActions<
238 : Parallel::Phase::WriteCheckpoint,
239 : tmpl::list<evolution::Actions::RunEventsAndTriggers<
240 : Triggers::WhenToCheck::AtCheckpoints>,
241 : Parallel::Actions::TerminatePhase>>,
242 :
243 : Parallel::PhaseActions<
244 : Parallel::Phase::Evolve,
245 : tmpl::flatten<
246 : tmpl::list<evolution::Actions::RunEventsAndTriggers<
247 : Triggers::WhenToCheck::AtSteps>,
248 : evolution::Actions::RunEventsAndTriggers<
249 : Triggers::WhenToCheck::AtSlabs>,
250 : Actions::ChangeSlabSize, step_actions,
251 : Actions::MutateApply<AdvanceTime<>>,
252 : PhaseControl::Actions::ExecutePhaseChange>>>>>;
253 :
254 : struct registration
255 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
256 0 : using element_registrars =
257 : tmpl::map<tmpl::pair<dg_element_array, dg_registration_list>>;
258 : };
259 :
260 0 : using component_list =
261 : tmpl::list<observers::Observer<EvolutionMetavars>,
262 : observers::ObserverWriter<EvolutionMetavars>,
263 : dg_element_array>;
264 :
265 : static constexpr Options::String help{
266 : "Evolve a second-order in space scalar wave in Dim spatial dimensions "
267 : "using the local discontinuous Galerkin (LDG) method."};
268 :
269 : static constexpr auto default_phase_order = std::array<Parallel::Phase, 5>{
270 : Parallel::Phase::Initialization,
271 : Parallel::Phase::InitializeTimeStepperHistory, Parallel::Phase::Register,
272 : Parallel::Phase::Evolve, Parallel::Phase::Exit};
273 :
274 : // NOLINTNEXTLINE(google-runtime-references)
275 0 : void pup(PUP::er& /*p*/) {}
276 : };
|
