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 <type_traits>
9 : #include <vector>
10 :
11 : #include "DataStructures/DataBox/PrefixHelpers.hpp"
12 : #include "DataStructures/Tensor/TypeAliases.hpp"
13 : #include "Domain/Creators/DomainCreator.hpp"
14 : #include "Domain/Creators/Factory3D.hpp"
15 : #include "Domain/Tags.hpp"
16 : #include "Evolution/Actions/RunEventsAndDenseTriggers.hpp"
17 : #include "Evolution/Actions/RunEventsAndTriggers.hpp"
18 : #include "Evolution/BoundaryCorrection.hpp"
19 : #include "Evolution/ComputeTags.hpp"
20 : #include "Evolution/DiscontinuousGalerkin/Actions/ApplyBoundaryCorrections.hpp"
21 : #include "Evolution/DiscontinuousGalerkin/Actions/ComputeTimeDerivative.hpp"
22 : #include "Evolution/DiscontinuousGalerkin/BackgroundGrVars.hpp"
23 : #include "Evolution/DiscontinuousGalerkin/DgElementArray.hpp"
24 : #include "Evolution/DiscontinuousGalerkin/Initialization/Mortars.hpp"
25 : #include "Evolution/DiscontinuousGalerkin/Limiters/Minmod.hpp"
26 : #include "Evolution/DiscontinuousGalerkin/Limiters/Tags.hpp"
27 : #include "Evolution/Initialization/ConservativeSystem.hpp"
28 : #include "Evolution/Initialization/DgDomain.hpp"
29 : #include "Evolution/Initialization/Evolution.hpp"
30 : #include "Evolution/Initialization/Limiter.hpp"
31 : #include "Evolution/Initialization/SetVariables.hpp"
32 : #include "Evolution/Systems/ForceFree/BoundaryConditions/BoundaryCondition.hpp"
33 : #include "Evolution/Systems/ForceFree/BoundaryConditions/Factory.hpp"
34 : #include "Evolution/Systems/ForceFree/BoundaryCorrections/Factory.hpp"
35 : #include "Evolution/Systems/ForceFree/ElectricCurrentDensity.hpp"
36 : #include "Evolution/Systems/ForceFree/ElectromagneticVariables.hpp"
37 : #include "Evolution/Systems/ForceFree/MaskNeutronStarInterior.hpp"
38 : #include "Evolution/Systems/ForceFree/System.hpp"
39 : #include "Evolution/Systems/ForceFree/Tags.hpp"
40 : #include "Evolution/Tags/Filter.hpp"
41 : #include "IO/Observer/Actions/RegisterEvents.hpp"
42 : #include "IO/Observer/Actions/RegisterWithObservers.hpp"
43 : #include "IO/Observer/Helpers.hpp"
44 : #include "IO/Observer/ObserverComponent.hpp"
45 : #include "NumericalAlgorithms/LinearOperators/ExponentialFilter.hpp"
46 : #include "Options/Options.hpp"
47 : #include "Options/Protocols/FactoryCreation.hpp"
48 : #include "Parallel/Local.hpp"
49 : #include "Parallel/Phase.hpp"
50 : #include "Parallel/PhaseControl/CheckpointAndExitAfterWallclock.hpp"
51 : #include "Parallel/PhaseControl/ExecutePhaseChange.hpp"
52 : #include "Parallel/PhaseControl/PhaseChange.hpp"
53 : #include "Parallel/PhaseControl/VisitAndReturn.hpp"
54 : #include "Parallel/PhaseDependentActionList.hpp"
55 : #include "Parallel/Protocols/RegistrationMetavariables.hpp"
56 : #include "ParallelAlgorithms/Actions/AddComputeTags.hpp"
57 : #include "ParallelAlgorithms/Actions/AddSimpleTags.hpp"
58 : #include "ParallelAlgorithms/Actions/FilterAction.hpp"
59 : #include "ParallelAlgorithms/Actions/InitializeItems.hpp"
60 : #include "ParallelAlgorithms/Actions/LimiterActions.hpp"
61 : #include "ParallelAlgorithms/Actions/MutateApply.hpp"
62 : #include "ParallelAlgorithms/Actions/TerminatePhase.hpp"
63 : #include "ParallelAlgorithms/Events/Factory.hpp"
64 : #include "ParallelAlgorithms/Events/Tags.hpp"
65 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTrigger.hpp"
66 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTriggers/Factory.hpp"
67 : #include "ParallelAlgorithms/EventsAndTriggers/Completion.hpp"
68 : #include "ParallelAlgorithms/EventsAndTriggers/Event.hpp"
69 : #include "ParallelAlgorithms/EventsAndTriggers/EventsAndTriggers.hpp"
70 : #include "ParallelAlgorithms/EventsAndTriggers/LogicalTriggers.hpp"
71 : #include "ParallelAlgorithms/EventsAndTriggers/Trigger.hpp"
72 : #include "PointwiseFunctions/AnalyticData/ForceFree/AnalyticData.hpp"
73 : #include "PointwiseFunctions/AnalyticData/ForceFree/Factory.hpp"
74 : #include "PointwiseFunctions/AnalyticSolutions/ForceFree/Factory.hpp"
75 : #include "PointwiseFunctions/AnalyticSolutions/Tags.hpp"
76 : #include "PointwiseFunctions/InitialDataUtilities/InitialData.hpp"
77 : #include "Time/Actions/AdvanceTime.hpp"
78 : #include "Time/Actions/CleanHistory.hpp"
79 : #include "Time/Actions/SelfStartActions.hpp"
80 : #include "Time/ChangeSlabSize/Action.hpp"
81 : #include "Time/ChangeTimeStepperOrder.hpp"
82 : #include "Time/RecordTimeStepperData.hpp"
83 : #include "Time/StepChoosers/Factory.hpp"
84 : #include "Time/StepChoosers/StepChooser.hpp"
85 : #include "Time/Tags/Time.hpp"
86 : #include "Time/Tags/TimeStepId.hpp"
87 : #include "Time/TimeSequence.hpp"
88 : #include "Time/TimeSteppers/Factory.hpp"
89 : #include "Time/TimeSteppers/LtsTimeStepper.hpp"
90 : #include "Time/TimeSteppers/TimeStepper.hpp"
91 : #include "Time/Triggers/TimeTriggers.hpp"
92 : #include "Time/UpdateU.hpp"
93 : #include "Utilities/ProtocolHelpers.hpp"
94 : #include "Utilities/TMPL.hpp"
95 :
96 : /// \cond
97 : namespace PUP {
98 : class er;
99 : } // namespace PUP
100 : namespace Parallel {
101 : template <typename Metavariables>
102 : class CProxy_GlobalCache;
103 : } // namespace Parallel
104 : /// \endcond
105 :
106 : struct EvolutionMetavars {
107 : static constexpr size_t volume_dim = 3;
108 0 : using system = ForceFree::System;
109 0 : using temporal_id = Tags::TimeStepId;
110 0 : using TimeStepperBase = TimeStepper;
111 :
112 : static constexpr bool local_time_stepping =
113 : TimeStepperBase::local_time_stepping;
114 : static constexpr bool use_dg_element_collection = false;
115 :
116 0 : using initial_data_list = tmpl::append<ForceFree::Solutions::all_solutions,
117 : ForceFree::AnalyticData::all_data>;
118 :
119 0 : using limiter = Tags::Limiter<Limiters::Minmod<
120 : 3, tmpl::list<ForceFree::Tags::TildeE, ForceFree::Tags::TildeB,
121 : ForceFree::Tags::TildeQ>>>;
122 :
123 0 : using analytic_variables_tags = typename system::variables_tag::tags_list;
124 :
125 0 : using analytic_compute = evolution::Tags::AnalyticSolutionsCompute<
126 : volume_dim, analytic_variables_tags, false, initial_data_list>;
127 :
128 0 : using error_compute = Tags::ErrorsCompute<analytic_variables_tags>;
129 :
130 0 : using error_tags = db::wrap_tags_in<Tags::Error, analytic_variables_tags>;
131 :
132 0 : using observe_fields = tmpl::push_back<
133 : tmpl::append<typename system::variables_tag::tags_list, error_tags>,
134 : domain::Tags::Coordinates<volume_dim, Frame::Grid>,
135 : domain::Tags::Coordinates<volume_dim, Frame::Inertial>,
136 : ForceFree::Tags::ElectricFieldCompute,
137 : ForceFree::Tags::MagneticFieldCompute,
138 : ForceFree::Tags::ChargeDensityCompute,
139 : ForceFree::Tags::ElectricCurrentDensityCompute>;
140 :
141 0 : using non_tensor_compute_tags =
142 : tmpl::list<::Events::Tags::ObserverMeshCompute<volume_dim>,
143 : ::Events::Tags::ObserverDetInvJacobianCompute<
144 : Frame::ElementLogical, Frame::Inertial>,
145 : analytic_compute, error_compute>;
146 :
147 : struct factory_creation
148 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
149 0 : using factory_classes = tmpl::map<
150 : tmpl::pair<ForceFree::BoundaryConditions::BoundaryCondition,
151 : ForceFree::BoundaryConditions::standard_boundary_conditions>,
152 : tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
153 : tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
154 : tmpl::pair<Event,
155 : tmpl::flatten<tmpl::list<
156 : Events::Completion,
157 : dg::Events::field_observations<
158 : volume_dim, observe_fields, non_tensor_compute_tags>,
159 : Events::time_events<system>>>>,
160 : tmpl::pair<
161 : evolution::BoundaryCorrection,
162 : ForceFree::BoundaryCorrections::standard_boundary_corrections>,
163 : tmpl::pair<evolution::initial_data::InitialData, initial_data_list>,
164 : tmpl::pair<LtsTimeStepper, TimeSteppers::lts_time_steppers>,
165 : tmpl::pair<PhaseChange,
166 : tmpl::list<PhaseControl::VisitAndReturn<
167 : Parallel::Phase::LoadBalancing>,
168 : PhaseControl::CheckpointAndExitAfterWallclock>>,
169 : tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
170 : StepChoosers::standard_step_choosers<system>>,
171 : tmpl::pair<
172 : StepChooser<StepChooserUse::Slab>,
173 : StepChoosers::standard_slab_choosers<system, local_time_stepping>>,
174 : tmpl::pair<TimeSequence<double>,
175 : TimeSequences::all_time_sequences<double>>,
176 : tmpl::pair<TimeSequence<std::uint64_t>,
177 : TimeSequences::all_time_sequences<std::uint64_t>>,
178 : tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
179 : tmpl::pair<Trigger, tmpl::append<Triggers::logical_triggers,
180 : Triggers::time_triggers>>>;
181 : };
182 :
183 0 : using observed_reduction_data_tags =
184 : observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
185 : tmpl::at<typename factory_creation::factory_classes, Event>>>>;
186 :
187 0 : using dg_step_actions = tmpl::flatten<tmpl::list<
188 : Actions::MutateApply<
189 : evolution::dg::BackgroundGrVars<system, EvolutionMetavars>>,
190 : evolution::dg::Actions::ComputeTimeDerivative<
191 : volume_dim, system, AllStepChoosers, local_time_stepping,
192 : use_dg_element_collection>,
193 : tmpl::conditional_t<
194 : local_time_stepping,
195 : tmpl::list<Actions::MutateApply<RecordTimeStepperData<system>>,
196 : evolution::Actions::RunEventsAndDenseTriggers<
197 : tmpl::list<evolution::dg::ApplyBoundaryCorrections<
198 : local_time_stepping, system, volume_dim, true>>>,
199 : Actions::MutateApply<UpdateU<system, local_time_stepping>>,
200 : evolution::dg::Actions::ApplyLtsBoundaryCorrections<
201 : volume_dim, false, use_dg_element_collection>,
202 : Actions::MutateApply<ChangeTimeStepperOrder<system>>>,
203 : tmpl::list<
204 : evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
205 : volume_dim, false, use_dg_element_collection>,
206 : Actions::MutateApply<RecordTimeStepperData<system>>,
207 : evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<>>,
208 : Actions::MutateApply<UpdateU<system, local_time_stepping>>>>,
209 : Actions::CleanHistory<system, local_time_stepping>,
210 : Limiters::Actions::SendData<EvolutionMetavars>,
211 : Limiters::Actions::Limit<EvolutionMetavars>,
212 :
213 : dg::Actions::Filter<
214 : Filters::Exponential<0>,
215 : tmpl::list<ForceFree::Tags::TildeE, ForceFree::Tags::TildeB,
216 : ForceFree::Tags::TildePsi, ForceFree::Tags::TildePhi,
217 : ForceFree::Tags::TildeQ>>
218 :
219 : >>;
220 :
221 0 : using const_global_cache_tags =
222 : tmpl::list<evolution::initial_data::Tags::InitialData,
223 : ForceFree::Tags::KappaPsi, ForceFree::Tags::KappaPhi,
224 : ForceFree::Tags::ParallelConductivity>;
225 :
226 0 : using dg_registration_list =
227 : tmpl::list<observers::Actions::RegisterEventsWithObservers>;
228 :
229 0 : using initialization_actions = tmpl::list<
230 : Initialization::Actions::InitializeItems<
231 : Initialization::TimeStepping<EvolutionMetavars, TimeStepperBase>,
232 : evolution::dg::Initialization::Domain<EvolutionMetavars>,
233 : Initialization::TimeStepperHistory<EvolutionMetavars>>,
234 : Initialization::Actions::AddSimpleTags<
235 : evolution::dg::BackgroundGrVars<system, EvolutionMetavars>>,
236 : Initialization::Actions::ConservativeSystem<system>,
237 : evolution::Initialization::Actions::SetVariables<
238 : domain::Tags::Coordinates<3, Frame::ElementLogical>>,
239 :
240 : Initialization::Actions::AddSimpleTags<
241 : ForceFree::MaskNeutronStarInterior<EvolutionMetavars, false>>,
242 :
243 : Initialization::Actions::AddComputeTags<
244 : tmpl::list<ForceFree::Tags::ComputeTildeJ>>,
245 :
246 : Initialization::Actions::AddComputeTags<
247 : StepChoosers::step_chooser_compute_tags<EvolutionMetavars,
248 : local_time_stepping>>,
249 : ::evolution::dg::Initialization::Mortars<volume_dim, system>,
250 : Initialization::Actions::Minmod<3>,
251 : evolution::Actions::InitializeRunEventsAndDenseTriggers,
252 : Parallel::Actions::TerminatePhase>;
253 :
254 0 : using dg_element_array_component = DgElementArray<
255 : EvolutionMetavars,
256 : tmpl::list<
257 : Parallel::PhaseActions<Parallel::Phase::Initialization,
258 : initialization_actions>,
259 :
260 : Parallel::PhaseActions<Parallel::Phase::Register,
261 : tmpl::list<dg_registration_list,
262 : Parallel::Actions::TerminatePhase>>,
263 :
264 : Parallel::PhaseActions<Parallel::Phase::Restart,
265 : tmpl::list<dg_registration_list,
266 : Parallel::Actions::TerminatePhase>>,
267 :
268 : Parallel::PhaseActions<
269 : Parallel::Phase::WriteCheckpoint,
270 : tmpl::list<evolution::Actions::RunEventsAndTriggers<
271 : Triggers::WhenToCheck::AtCheckpoints>,
272 : Parallel::Actions::TerminatePhase>>,
273 :
274 : Parallel::PhaseActions<
275 : Parallel::Phase::InitializeTimeStepperHistory,
276 : SelfStart::self_start_procedure<dg_step_actions, system>>,
277 :
278 : Parallel::PhaseActions<
279 : Parallel::Phase::Evolve,
280 : tmpl::flatten<tmpl::list<
281 : std::conditional_t<local_time_stepping,
282 : evolution::Actions::RunEventsAndTriggers<
283 : Triggers::WhenToCheck::AtSteps>,
284 : tmpl::list<>>,
285 : evolution::Actions::RunEventsAndTriggers<
286 : Triggers::WhenToCheck::AtSlabs>,
287 : Actions::ChangeSlabSize, dg_step_actions,
288 : Actions::AdvanceTime,
289 : PhaseControl::Actions::ExecutePhaseChange>>>>>;
290 :
291 : struct registration
292 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
293 0 : using element_registrars =
294 : tmpl::map<tmpl::pair<dg_element_array_component, dg_registration_list>>;
295 : };
296 :
297 0 : using component_list =
298 : tmpl::list<observers::Observer<EvolutionMetavars>,
299 : observers::ObserverWriter<EvolutionMetavars>,
300 : dg_element_array_component>;
301 :
302 : static constexpr Options::String help{
303 : "Evolve the GRFFE system with divergence cleaning.\n"};
304 :
305 : static constexpr std::array<Parallel::Phase, 5> default_phase_order{
306 : {Parallel::Phase::Initialization,
307 : Parallel::Phase::InitializeTimeStepperHistory, Parallel::Phase::Register,
308 : Parallel::Phase::Evolve, Parallel::Phase::Exit}};
309 :
310 : // NOLINTNEXTLINE(google-runtime-references)
311 0 : void pup(PUP::er& /*p*/) {}
312 : };
|