Line data Source code
1 0 : // Distributed under the MIT License.
2 : // See LICENSE.txt for details.
3 :
4 : #pragma once
5 :
6 : #include <cstdint>
7 : #include <vector>
8 :
9 : #include "Domain/Creators/Factory3D.hpp"
10 : #include "Domain/Tags.hpp"
11 : #include "Evolution/Actions/RunEventsAndDenseTriggers.hpp"
12 : #include "Evolution/Actions/RunEventsAndTriggers.hpp"
13 : #include "Evolution/BoundaryCorrection.hpp"
14 : #include "Evolution/ComputeTags.hpp"
15 : #include "Evolution/DiscontinuousGalerkin/Actions/ApplyBoundaryCorrections.hpp"
16 : #include "Evolution/DiscontinuousGalerkin/Actions/ComputeTimeDerivative.hpp"
17 : #include "Evolution/DiscontinuousGalerkin/Actions/VolumeTermsImpl.tpp"
18 : #include "Evolution/DiscontinuousGalerkin/BackgroundGrVars.hpp"
19 : #include "Evolution/DiscontinuousGalerkin/DgElementArray.hpp"
20 : #include "Evolution/DiscontinuousGalerkin/Initialization/Mortars.hpp"
21 : #include "Evolution/DiscontinuousGalerkin/Initialization/QuadratureTag.hpp"
22 : #include "Evolution/DiscontinuousGalerkin/Limiters/Minmod.hpp"
23 : #include "Evolution/DiscontinuousGalerkin/Limiters/Tags.hpp"
24 : #include "Evolution/Imex/Actions/DoImplicitStep.hpp"
25 : #include "Evolution/Imex/Actions/RecordTimeStepperData.hpp"
26 : #include "Evolution/Imex/CleanHistory.hpp"
27 : #include "Evolution/Imex/ImplicitDenseOutput.hpp"
28 : #include "Evolution/Imex/Initialize.hpp"
29 : #include "Evolution/Initialization/ConservativeSystem.hpp"
30 : #include "Evolution/Initialization/DgDomain.hpp"
31 : #include "Evolution/Initialization/Evolution.hpp"
32 : #include "Evolution/Initialization/Limiter.hpp"
33 : #include "Evolution/Initialization/SetVariables.hpp"
34 : #include "Evolution/Systems/RadiationTransport/M1Grey/BoundaryConditions/Factory.hpp"
35 : #include "Evolution/Systems/RadiationTransport/M1Grey/BoundaryCorrections/Factory.hpp"
36 : #include "Evolution/Systems/RadiationTransport/M1Grey/Initialize.hpp"
37 : #include "Evolution/Systems/RadiationTransport/M1Grey/M1Closure.hpp"
38 : #include "Evolution/Systems/RadiationTransport/M1Grey/M1HydroCoupling.hpp"
39 : #include "Evolution/Systems/RadiationTransport/M1Grey/System.hpp"
40 : #include "Evolution/Systems/RadiationTransport/M1Grey/Tags.hpp"
41 : #include "Evolution/Systems/RadiationTransport/Tags.hpp"
42 : #include "IO/Observer/Actions/RegisterEvents.hpp"
43 : #include "IO/Observer/Helpers.hpp"
44 : #include "IO/Observer/ObserverComponent.hpp"
45 : #include "NumericalAlgorithms/DiscontinuousGalerkin/Formulation.hpp"
46 : #include "NumericalAlgorithms/DiscontinuousGalerkin/Tags.hpp"
47 : #include "Options/Protocols/FactoryCreation.hpp"
48 : #include "Options/String.hpp"
49 : #include "Parallel/Local.hpp"
50 : #include "Parallel/Phase.hpp"
51 : #include "Parallel/PhaseControl/CheckpointAndExitAfterWallclock.hpp"
52 : #include "Parallel/PhaseControl/ExecutePhaseChange.hpp"
53 : #include "Parallel/PhaseControl/Factory.hpp"
54 : #include "Parallel/PhaseControl/VisitAndReturn.hpp"
55 : #include "Parallel/PhaseDependentActionList.hpp"
56 : #include "Parallel/Protocols/RegistrationMetavariables.hpp"
57 : #include "ParallelAlgorithms/Actions/AddComputeTags.hpp"
58 : #include "ParallelAlgorithms/Actions/AddSimpleTags.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/EventsAndDenseTriggers/DenseTrigger.hpp"
65 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTriggers/Factory.hpp"
66 : #include "ParallelAlgorithms/EventsAndTriggers/Completion.hpp"
67 : #include "ParallelAlgorithms/EventsAndTriggers/Event.hpp"
68 : #include "ParallelAlgorithms/EventsAndTriggers/EventsAndTriggers.hpp"
69 : #include "ParallelAlgorithms/EventsAndTriggers/LogicalTriggers.hpp"
70 : #include "ParallelAlgorithms/EventsAndTriggers/Trigger.hpp"
71 : #include "PointwiseFunctions/AnalyticData/AnalyticData.hpp"
72 : #include "PointwiseFunctions/AnalyticData/RadiationTransport/M1Grey/AnalyticData.hpp"
73 : #include "PointwiseFunctions/AnalyticData/RadiationTransport/M1Grey/Factory.hpp"
74 : #include "PointwiseFunctions/AnalyticData/Tags.hpp"
75 : #include "PointwiseFunctions/AnalyticSolutions/AnalyticSolution.hpp"
76 : #include "PointwiseFunctions/AnalyticSolutions/RadiationTransport/M1Grey/ConstantM1.hpp"
77 : #include "PointwiseFunctions/AnalyticSolutions/RadiationTransport/M1Grey/Factory.hpp"
78 : #include "PointwiseFunctions/AnalyticSolutions/Tags.hpp"
79 : #include "PointwiseFunctions/Hydro/Tags.hpp"
80 : #include "PointwiseFunctions/InitialDataUtilities/InitialData.hpp"
81 : #include "Time/Actions/AdvanceTime.hpp"
82 : #include "Time/Actions/CleanHistory.hpp"
83 : #include "Time/Actions/SelfStartActions.hpp"
84 : #include "Time/ChangeSlabSize/Action.hpp"
85 : #include "Time/ChangeTimeStepperOrder.hpp"
86 : #include "Time/RecordTimeStepperData.hpp"
87 : #include "Time/StepChoosers/Factory.hpp"
88 : #include "Time/StepChoosers/StepChooser.hpp"
89 : #include "Time/Tags/Time.hpp"
90 : #include "Time/Tags/TimeStepId.hpp"
91 : #include "Time/TimeSequence.hpp"
92 : #include "Time/TimeSteppers/Factory.hpp"
93 : #include "Time/TimeSteppers/ImexTimeStepper.hpp"
94 : #include "Time/TimeSteppers/LtsTimeStepper.hpp"
95 : #include "Time/TimeSteppers/TimeStepper.hpp"
96 : #include "Time/Triggers/TimeTriggers.hpp"
97 : #include "Time/UpdateU.hpp"
98 : #include "Utilities/Functional.hpp"
99 : #include "Utilities/ProtocolHelpers.hpp"
100 : #include "Utilities/TMPL.hpp"
101 :
102 : /// \cond
103 : namespace Frame {
104 : struct Inertial;
105 : } // namespace Frame
106 : namespace PUP {
107 : class er;
108 : } // namespace PUP
109 : namespace Parallel {
110 : template <typename Metavariables>
111 : class CProxy_GlobalCache;
112 : } // namespace Parallel
113 : /// \endcond
114 :
115 : struct EvolutionMetavars {
116 : static constexpr size_t volume_dim = 3;
117 :
118 : // Set list of neutrino species to be used by M1 code
119 0 : using neutrino_species = tmpl::list<neutrinos::ElectronNeutrinos<1>>;
120 :
121 0 : using system = RadiationTransport::M1Grey::System<neutrino_species>;
122 0 : using temporal_id = Tags::TimeStepId;
123 0 : using TimeStepperBase = ImexTimeStepper;
124 :
125 : static constexpr bool local_time_stepping =
126 : TimeStepperBase::local_time_stepping;
127 : static constexpr bool use_dg_element_collection = false;
128 :
129 0 : using initial_data_list =
130 : tmpl::append<RadiationTransport::M1Grey::AnalyticData::all_data,
131 : RadiationTransport::M1Grey::Solutions::all_solutions>;
132 :
133 0 : using analytic_variables_tags = typename system::variables_tag::tags_list;
134 0 : using limiter = Tags::Limiter<
135 : Limiters::Minmod<3, typename system::variables_tag::tags_list>>;
136 :
137 0 : using analytic_compute = evolution::Tags::AnalyticSolutionsCompute<
138 : volume_dim, analytic_variables_tags, false, initial_data_list>;
139 0 : using error_compute = Tags::ErrorsCompute<analytic_variables_tags>;
140 0 : using error_tags = db::wrap_tags_in<Tags::Error, analytic_variables_tags>;
141 0 : using observe_fields = tmpl::push_back<
142 : tmpl::append<typename system::variables_tag::tags_list,
143 : typename system::primitive_variables_tag::tags_list,
144 : error_tags>,
145 : domain::Tags::Coordinates<volume_dim, Frame::Grid>,
146 : domain::Tags::Coordinates<volume_dim, Frame::Inertial>>;
147 0 : using non_tensor_compute_tags =
148 : tmpl::list<::Events::Tags::ObserverMeshCompute<volume_dim>,
149 : ::Events::Tags::ObserverDetInvJacobianCompute<
150 : Frame::ElementLogical, Frame::Inertial>,
151 : analytic_compute, error_compute>;
152 :
153 : struct factory_creation
154 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
155 0 : using factory_classes = tmpl::map<
156 : tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
157 : tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
158 : tmpl::pair<Event,
159 : tmpl::flatten<tmpl::list<
160 : Events::Completion,
161 : dg::Events::field_observations<
162 : volume_dim, observe_fields, non_tensor_compute_tags>,
163 : Events::time_events<system>>>>,
164 : tmpl::pair<evolution::BoundaryCorrection,
165 : RadiationTransport::M1Grey::BoundaryCorrections::
166 : standard_boundary_corrections<neutrino_species>>,
167 : tmpl::pair<ImexTimeStepper, TimeSteppers::imex_time_steppers>,
168 : tmpl::pair<PhaseChange, PhaseControl::factory_creatable_classes>,
169 : tmpl::pair<RadiationTransport::M1Grey::BoundaryConditions::
170 : BoundaryCondition<neutrino_species>,
171 : RadiationTransport::M1Grey::BoundaryConditions::
172 : standard_boundary_conditions<neutrino_species>>,
173 : tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
174 : StepChoosers::standard_step_choosers<system, false>>,
175 : tmpl::pair<StepChooser<StepChooserUse::Slab>,
176 : StepChoosers::standard_slab_choosers<
177 : system, local_time_stepping, false>>,
178 : tmpl::pair<TimeSequence<double>,
179 : TimeSequences::all_time_sequences<double>>,
180 : tmpl::pair<TimeSequence<std::uint64_t>,
181 : TimeSequences::all_time_sequences<std::uint64_t>>,
182 : tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
183 : tmpl::pair<Trigger, tmpl::append<Triggers::logical_triggers,
184 : Triggers::time_triggers>>,
185 : tmpl::pair<evolution::initial_data::InitialData, initial_data_list>>;
186 : };
187 :
188 0 : using observed_reduction_data_tags =
189 : observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
190 : tmpl::at<typename factory_creation::factory_classes, Event>>>>;
191 :
192 : static_assert(not local_time_stepping);
193 0 : using step_actions = tmpl::flatten<tmpl::list<
194 : Actions::MutateApply<
195 : evolution::dg::BackgroundGrVars<system, EvolutionMetavars>>,
196 : evolution::dg::Actions::ComputeTimeDerivative<
197 : volume_dim, system, AllStepChoosers, local_time_stepping,
198 : use_dg_element_collection>,
199 : tmpl::conditional_t<
200 : local_time_stepping,
201 : tmpl::list<Actions::MutateApply<RecordTimeStepperData<system>>,
202 : evolution::Actions::RunEventsAndDenseTriggers<
203 : tmpl::list<evolution::dg::ApplyBoundaryCorrections<
204 : local_time_stepping, EvolutionMetavars, volume_dim,
205 : true>>>,
206 : Actions::MutateApply<UpdateU<system, local_time_stepping>>,
207 : evolution::dg::Actions::ApplyLtsBoundaryCorrections<
208 : volume_dim, false, use_dg_element_collection>,
209 : Actions::MutateApply<ChangeTimeStepperOrder<system>>>,
210 : tmpl::list<
211 : evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
212 : volume_dim, false, use_dg_element_collection>,
213 : Actions::MutateApply<RecordTimeStepperData<system>>,
214 : imex::Actions::RecordTimeStepperData<system>,
215 : evolution::Actions::RunEventsAndDenseTriggers<
216 : tmpl::list<imex::ImplicitDenseOutput<system>>>,
217 : Actions::MutateApply<UpdateU<system, local_time_stepping>>>>,
218 : imex::Actions::DoImplicitStep<system>,
219 : Actions::CleanHistory<system, local_time_stepping>,
220 : Actions::MutateApply<imex::CleanHistory<system>>,
221 : Limiters::Actions::SendData<EvolutionMetavars>,
222 : Limiters::Actions::Limit<EvolutionMetavars>,
223 : Actions::MutateApply<typename RadiationTransport::M1Grey::
224 : ComputeM1Closure<neutrino_species>>>>;
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<volume_dim, Frame::ElementLogical>>,
239 : RadiationTransport::M1Grey::Actions::InitializeM1Tags<system>,
240 : Initialization::Actions::InitializeItems<imex::Initialize<system>>,
241 : Actions::MutateApply<typename RadiationTransport::M1Grey::
242 : ComputeM1Closure<neutrino_species>>,
243 : Initialization::Actions::AddComputeTags<
244 : StepChoosers::step_chooser_compute_tags<EvolutionMetavars,
245 : local_time_stepping>>,
246 : ::evolution::dg::Initialization::Mortars<volume_dim, system>,
247 : Initialization::Actions::Minmod<3>,
248 : evolution::Actions::InitializeRunEventsAndDenseTriggers,
249 : Parallel::Actions::TerminatePhase>;
250 :
251 0 : using dg_element_array = DgElementArray<
252 : EvolutionMetavars,
253 : tmpl::list<
254 : Parallel::PhaseActions<Parallel::Phase::Initialization,
255 : initialization_actions>,
256 :
257 : Parallel::PhaseActions<
258 : Parallel::Phase::InitializeTimeStepperHistory,
259 : SelfStart::self_start_procedure<step_actions, system>>,
260 :
261 : Parallel::PhaseActions<Parallel::Phase::Register,
262 : tmpl::list<dg_registration_list,
263 : Parallel::Actions::TerminatePhase>>,
264 :
265 : Parallel::PhaseActions<Parallel::Phase::Restart,
266 : tmpl::list<dg_registration_list,
267 : Parallel::Actions::TerminatePhase>>,
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::Evolve,
276 : tmpl::flatten<tmpl::list<
277 : std::conditional_t<local_time_stepping,
278 : evolution::Actions::RunEventsAndTriggers<
279 : Triggers::WhenToCheck::AtSteps>,
280 : tmpl::list<>>,
281 : evolution::Actions::RunEventsAndTriggers<
282 : Triggers::WhenToCheck::AtSlabs>,
283 : Actions::ChangeSlabSize, step_actions, Actions::AdvanceTime,
284 : PhaseControl::Actions::ExecutePhaseChange>>>>>;
285 :
286 : struct registration
287 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
288 0 : using element_registrars =
289 : tmpl::map<tmpl::pair<dg_element_array, dg_registration_list>>;
290 : };
291 :
292 0 : using component_list =
293 : tmpl::list<observers::Observer<EvolutionMetavars>,
294 : observers::ObserverWriter<EvolutionMetavars>,
295 : dg_element_array>;
296 :
297 0 : using const_global_cache_tags =
298 : tmpl::list<evolution::initial_data::Tags::InitialData>;
299 :
300 : static constexpr Options::String help{"Evolve the M1Grey system. \n\n"};
301 :
302 : static constexpr std::array<Parallel::Phase, 5> default_phase_order{
303 : {Parallel::Phase::Initialization,
304 : Parallel::Phase::InitializeTimeStepperHistory, Parallel::Phase::Register,
305 : Parallel::Phase::Evolve, Parallel::Phase::Exit}};
306 :
307 : // NOLINTNEXTLINE(google-runtime-references)
308 0 : void pup(PUP::er& /*p*/) {}
309 : };
|
