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