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