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/ComputeTags.hpp"
14 : #include "Evolution/DgSubcell/Actions/Initialize.hpp"
15 : #include "Evolution/DgSubcell/BackgroundGrVars.hpp"
16 : #include "Evolution/DgSubcell/Tags/ObserverCoordinates.hpp"
17 : #include "Evolution/DgSubcell/Tags/ObserverMesh.hpp"
18 : #include "Evolution/DiscontinuousGalerkin/Actions/ApplyBoundaryCorrections.hpp"
19 : #include "Evolution/DiscontinuousGalerkin/Actions/ComputeTimeDerivative.hpp"
20 : #include "Evolution/DiscontinuousGalerkin/Actions/VolumeTermsImpl.tpp"
21 : #include "Evolution/DiscontinuousGalerkin/BackgroundGrVars.hpp"
22 : #include "Evolution/DiscontinuousGalerkin/DgElementArray.hpp"
23 : #include "Evolution/DiscontinuousGalerkin/Initialization/Mortars.hpp"
24 : #include "Evolution/DiscontinuousGalerkin/Initialization/QuadratureTag.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/Particles/MonteCarlo/Actions/InitializeMonteCarlo.hpp"
33 : #include "Evolution/Particles/MonteCarlo/Actions/Labels.hpp"
34 : #include "Evolution/Particles/MonteCarlo/Actions/TimeStepActions.hpp"
35 : #include "Evolution/Particles/MonteCarlo/Actions/TriggerMonteCarloEvolution.hpp"
36 : #include "Evolution/Particles/MonteCarlo/CellCrossingTime.hpp"
37 : #include "Evolution/Particles/MonteCarlo/GhostZoneCommunication.hpp"
38 : #include "Evolution/Particles/MonteCarlo/GhostZoneCommunicationTags.hpp"
39 : #include "Evolution/Particles/MonteCarlo/MonteCarloOptions.hpp"
40 : #include "Evolution/Particles/MonteCarlo/NeutrinoMomentsFromMonteCarlo.hpp"
41 : #include "Evolution/Particles/MonteCarlo/SwapGrTags.hpp"
42 : #include "Evolution/Particles/MonteCarlo/System.hpp"
43 : #include "Evolution/Particles/MonteCarlo/Tags.hpp"
44 : #include "Evolution/Systems/GrMhd/ValenciaDivClean/AllSolutions.hpp"
45 : #include "IO/Observer/Actions/RegisterEvents.hpp"
46 : #include "IO/Observer/Helpers.hpp"
47 : #include "IO/Observer/ObserverComponent.hpp"
48 : #include "NumericalAlgorithms/DiscontinuousGalerkin/Formulation.hpp"
49 : #include "NumericalAlgorithms/DiscontinuousGalerkin/Tags.hpp"
50 : #include "Options/Protocols/FactoryCreation.hpp"
51 : #include "Options/String.hpp"
52 : #include "Parallel/Local.hpp"
53 : #include "Parallel/Phase.hpp"
54 : #include "Parallel/PhaseControl/CheckpointAndExitAfterWallclock.hpp"
55 : #include "Parallel/PhaseControl/ExecutePhaseChange.hpp"
56 : #include "Parallel/PhaseControl/Factory.hpp"
57 : #include "Parallel/PhaseControl/VisitAndReturn.hpp"
58 : #include "Parallel/PhaseDependentActionList.hpp"
59 : #include "Parallel/Protocols/RegistrationMetavariables.hpp"
60 : #include "ParallelAlgorithms/Actions/AddComputeTags.hpp"
61 : #include "ParallelAlgorithms/Actions/AddSimpleTags.hpp"
62 : #include "ParallelAlgorithms/Actions/InitializeItems.hpp"
63 : #include "ParallelAlgorithms/Actions/LimiterActions.hpp"
64 : #include "ParallelAlgorithms/Actions/MutateApply.hpp"
65 : #include "ParallelAlgorithms/Actions/TerminatePhase.hpp"
66 : #include "ParallelAlgorithms/Events/Factory.hpp"
67 : #include "ParallelAlgorithms/Events/ObserveFields.hpp"
68 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTrigger.hpp"
69 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTriggers/Factory.hpp"
70 : #include "ParallelAlgorithms/EventsAndTriggers/Completion.hpp"
71 : #include "ParallelAlgorithms/EventsAndTriggers/Event.hpp"
72 : #include "ParallelAlgorithms/EventsAndTriggers/EventsAndTriggers.hpp"
73 : #include "ParallelAlgorithms/EventsAndTriggers/LogicalTriggers.hpp"
74 : #include "ParallelAlgorithms/EventsAndTriggers/Trigger.hpp"
75 : #include "PointwiseFunctions/AnalyticData/AnalyticData.hpp"
76 : #include "PointwiseFunctions/AnalyticData/GrMhd/InitialMagneticFields/InitialMagneticField.hpp"
77 : #include "PointwiseFunctions/AnalyticData/Tags.hpp"
78 : #include "PointwiseFunctions/AnalyticSolutions/AnalyticSolution.hpp"
79 : #include "PointwiseFunctions/AnalyticSolutions/GeneralRelativity/WrappedGr.hpp"
80 : #include "PointwiseFunctions/AnalyticSolutions/RadiationTransport/MonteCarlo/Factory.hpp"
81 : #include "PointwiseFunctions/AnalyticSolutions/Tags.hpp"
82 : #include "PointwiseFunctions/Hydro/Tags.hpp"
83 : #include "PointwiseFunctions/InitialDataUtilities/Tags/InitialData.hpp"
84 : #include "Time/Actions/SelfStartActions.hpp"
85 : #include "Time/AdvanceTime.hpp"
86 : #include "Time/ChangeSlabSize/Action.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/LtsTimeStepper.hpp"
94 : #include "Time/TimeSteppers/TimeStepper.hpp"
95 : #include "Time/Triggers/TimeTriggers.hpp"
96 : #include "Utilities/Functional.hpp"
97 : #include "Utilities/ProtocolHelpers.hpp"
98 : #include "Utilities/TMPL.hpp"
99 :
100 : /// \cond
101 : namespace Frame {
102 : struct Inertial;
103 : } // namespace Frame
104 : namespace PUP {
105 : class er;
106 : } // namespace PUP
107 : namespace Parallel {
108 : template <typename Metavariables>
109 : class CProxy_GlobalCache;
110 : } // namespace Parallel
111 : /// \endcond
112 :
113 : // NEED:
114 : // Initial data
115 :
116 : template <size_t EnergyBins, size_t NeutrinoSpecies>
117 : struct EvolutionMetavars {
118 : static constexpr size_t volume_dim = 3;
119 :
120 0 : using system = Particles::MonteCarlo::System;
121 0 : using temporal_id = Tags::TimeStepId;
122 0 : using TimeStepperBase = TimeStepper;
123 : static constexpr bool use_dg_subcell = true;
124 :
125 0 : using initial_data_list =
126 : RadiationTransport::MonteCarlo::Solutions::all_solutions;
127 0 : using equation_of_state_tag = hydro::Tags::GrmhdEquationOfState;
128 :
129 : struct SubcellOptions {
130 0 : using evolved_vars_tags = typename system::variables_tag::tags_list;
131 :
132 : static constexpr bool subcell_enabled = use_dg_subcell;
133 : static constexpr bool subcell_enabled_at_external_boundary = true;
134 : };
135 :
136 0 : using observe_fields = tmpl::push_back<
137 : tmpl::append<tmpl::conditional_t<
138 : // Use conditional template here in case we ever want
139 : // something else than dg_subcell, but only add coordinates
140 : // for dg_subcell (MC is not coded for DG)
141 : use_dg_subcell,
142 : tmpl::list<evolution::dg::subcell::Tags::ObserverCoordinatesCompute<
143 : volume_dim, Frame::ElementLogical>,
144 : evolution::dg::subcell::Tags::ObserverCoordinatesCompute<
145 : volume_dim, Frame::Grid>,
146 : evolution::dg::subcell::Tags::ObserverCoordinatesCompute<
147 : volume_dim, Frame::Inertial>>,
148 : tmpl::list<>>>,
149 : Particles::MonteCarlo::Tags::InertialFrameEnergyDensity>;
150 0 : using non_tensor_compute_tags = tmpl::conditional_t<
151 : use_dg_subcell,
152 : tmpl::list<evolution::dg::subcell::Tags::ObserverMeshCompute<volume_dim>,
153 : evolution::dg::subcell::Tags::
154 : ObserverJacobianAndDetInvJacobianCompute<
155 : volume_dim, Frame::ElementLogical, Frame::Inertial>,
156 : evolution::dg::subcell::Tags::ObserverInverseJacobianCompute<
157 : volume_dim, Frame::ElementLogical, Frame::Inertial>>,
158 : tmpl::list<>>;
159 :
160 0 : using analytic_variables_tags = typename system::variables_tag::tags_list;
161 0 : using analytic_compute = evolution::Tags::AnalyticSolutionsCompute<
162 : volume_dim, analytic_variables_tags, false, initial_data_list>;
163 :
164 : struct factory_creation
165 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
166 0 : using factory_classes = tmpl::map<
167 : tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
168 : tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
169 : tmpl::pair<Event,
170 : tmpl::flatten<tmpl::list<
171 : Events::Completion,
172 : ::Events::ObserveNorms<observe_fields,
173 : non_tensor_compute_tags>,
174 : dg::Events::ObserveFields<volume_dim, observe_fields,
175 : non_tensor_compute_tags>>>>,
176 : tmpl::pair<evolution::initial_data::InitialData, initial_data_list>,
177 : tmpl::pair<
178 : grmhd::AnalyticData::InitialMagneticFields::InitialMagneticField,
179 : grmhd::AnalyticData::InitialMagneticFields::
180 : initial_magnetic_fields>,
181 : tmpl::pair<PhaseChange,
182 : tmpl::list<PhaseControl::CheckpointAndExitAfterWallclock>>,
183 : tmpl::pair<StepChooser<StepChooserUse::Slab>,
184 : StepChoosers::standard_slab_choosers<system, false, false>>,
185 : tmpl::pair<TimeSequence<double>,
186 : TimeSequences::all_time_sequences<double>>,
187 : tmpl::pair<TimeSequence<std::uint64_t>,
188 : TimeSequences::all_time_sequences<std::uint64_t>>,
189 : tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
190 : tmpl::pair<Trigger, Triggers::time_triggers>>;
191 : };
192 :
193 0 : using observed_reduction_data_tags =
194 : observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
195 : tmpl::at<typename factory_creation::factory_classes, Event>>>>;
196 :
197 0 : using dg_registration_list =
198 : tmpl::list<observers::Actions::RegisterEventsWithObservers>;
199 :
200 0 : using initialization_actions = tmpl::list<
201 : Initialization::Actions::InitializeItems<
202 : Initialization::TimeStepping<EvolutionMetavars, TimeStepperBase>,
203 : evolution::dg::Initialization::Domain<EvolutionMetavars>>,
204 : Initialization::Actions::AddSimpleTags<
205 : evolution::dg::BackgroundGrVars<system, EvolutionMetavars>>,
206 : evolution::dg::subcell::Actions::SetSubcellGrid<volume_dim, system,
207 : false>,
208 : Initialization::Actions::AddSimpleTags<
209 : evolution::dg::subcell::BackgroundGrVars<system, EvolutionMetavars,
210 : false>>,
211 : Actions::MutateApply<Particles::MonteCarlo::SwapGrTags>,
212 : Initialization::Actions::InitializeMCTags<system, EnergyBins,
213 : NeutrinoSpecies, true>,
214 : Initialization::Actions::AddComputeTags<tmpl::list<
215 : Particles::MonteCarlo::CellLightCrossingTimeCompute,
216 : Particles::MonteCarlo::InertialFrameEnergyDensityCompute,
217 : Particles::MonteCarlo::InverseJacobianInertialToFluidCompute,
218 : domain::Tags::JacobianCompute<4, Frame::Inertial, Frame::Fluid>>>,
219 : evolution::Actions::InitializeRunEventsAndDenseTriggers,
220 : Parallel::Actions::TerminatePhase>;
221 :
222 0 : using dg_element_array = DgElementArray<
223 : EvolutionMetavars,
224 : tmpl::list<
225 : Parallel::PhaseActions<Parallel::Phase::Initialization,
226 : initialization_actions>,
227 : Parallel::PhaseActions<Parallel::Phase::Register,
228 : tmpl::list<dg_registration_list,
229 : Parallel::Actions::TerminatePhase>>,
230 : Parallel::PhaseActions<
231 : Parallel::Phase::WriteCheckpoint,
232 : tmpl::list<evolution::Actions::RunEventsAndTriggers<
233 : Triggers::WhenToCheck::AtCheckpoints>,
234 : Parallel::Actions::TerminatePhase>>,
235 : Parallel::PhaseActions<
236 : Parallel::Phase::Evolve,
237 : tmpl::list<
238 : Actions::MutateApply<AdvanceTime>,
239 : evolution::Actions::RunEventsAndTriggers<
240 : Triggers::WhenToCheck::AtSlabs>,
241 : // Monte-Carlo is only triggered at the end of a full time
242 : // step
243 : Particles::MonteCarlo::Actions::TriggerMonteCarloEvolution,
244 : Actions::Label<
245 : Particles::MonteCarlo::Actions::Labels::BeginMonteCarlo>,
246 : Particles::MonteCarlo::Actions::SendDataForMcCommunication<
247 : volume_dim,
248 : // No local time stepping
249 : false, Particles::MonteCarlo::CommunicationStep::PreStep>,
250 : Particles::MonteCarlo::Actions::ReceiveDataForMcCommunication<
251 : volume_dim,
252 : Particles::MonteCarlo::CommunicationStep::PreStep>,
253 : Particles::MonteCarlo::Actions::TakeTimeStep<EnergyBins,
254 : NeutrinoSpecies>,
255 : Particles::MonteCarlo::Actions::SendDataForMcCommunication<
256 : volume_dim,
257 : // No local time stepping
258 : false,
259 : Particles::MonteCarlo::CommunicationStep::PostStep>,
260 : Particles::MonteCarlo::Actions::ReceiveDataForMcCommunication<
261 : volume_dim,
262 : Particles::MonteCarlo::CommunicationStep::PostStep>,
263 : Actions::Label<
264 : Particles::MonteCarlo::Actions::Labels::EndMonteCarlo>,
265 : PhaseControl::Actions::ExecutePhaseChange>>>>;
266 :
267 : struct registration
268 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
269 0 : using element_registrars =
270 : tmpl::map<tmpl::pair<dg_element_array, dg_registration_list>>;
271 : };
272 :
273 0 : using component_list =
274 : tmpl::list<observers::Observer<EvolutionMetavars>,
275 : observers::ObserverWriter<EvolutionMetavars>,
276 : dg_element_array>;
277 :
278 0 : using const_global_cache_tags = tmpl::list<
279 : Particles::MonteCarlo::Tags::MonteCarloOptions<NeutrinoSpecies>,
280 : equation_of_state_tag, evolution::initial_data::Tags::InitialData,
281 : Particles::MonteCarlo::Tags::InteractionRatesTable<EnergyBins,
282 : NeutrinoSpecies>>;
283 :
284 : static constexpr Options::String help{
285 : "Evolve Monte Carlo transport (without coupling to hydro).\n\n"};
286 :
287 : static constexpr std::array<Parallel::Phase, 5> default_phase_order{
288 : {Parallel::Phase::Initialization,
289 : Parallel::Phase::InitializeTimeStepperHistory, Parallel::Phase::Register,
290 : Parallel::Phase::Evolve, Parallel::Phase::Exit}};
291 :
292 : // NOLINTNEXTLINE(google-runtime-references)
293 0 : void pup(PUP::er& /*p*/) {}
294 : };
|
