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/NoStepperErrorEstimates.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/TimeStepper.hpp"
91 : #include "Time/Triggers/TimeTriggers.hpp"
92 : #include "Utilities/Functional.hpp"
93 : #include "Utilities/ProtocolHelpers.hpp"
94 : #include "Utilities/TMPL.hpp"
95 :
96 : /// \cond
97 : namespace Frame {
98 : struct Inertial;
99 : } // namespace Frame
100 : namespace PUP {
101 : class er;
102 : } // namespace PUP
103 : namespace Parallel {
104 : template <typename Metavariables>
105 : class CProxy_GlobalCache;
106 : } // namespace Parallel
107 : /// \endcond
108 :
109 : // NEED:
110 : // Initial data
111 :
112 : template <size_t EnergyBins, size_t NeutrinoSpecies>
113 : struct EvolutionMetavars {
114 : static constexpr size_t volume_dim = 3;
115 :
116 0 : using system = Particles::MonteCarlo::System;
117 0 : using temporal_id = Tags::TimeStepId;
118 : static constexpr bool use_dg_subcell = true;
119 :
120 0 : using initial_data_list =
121 : RadiationTransport::MonteCarlo::Solutions::all_solutions;
122 0 : using equation_of_state_tag = hydro::Tags::GrmhdEquationOfState;
123 :
124 : struct SubcellOptions {
125 0 : using evolved_vars_tags = typename system::variables_tag::tags_list;
126 :
127 : static constexpr bool subcell_enabled = use_dg_subcell;
128 : static constexpr bool subcell_enabled_at_external_boundary = true;
129 : };
130 :
131 0 : using observe_fields = tmpl::push_back<
132 : tmpl::append<tmpl::conditional_t<
133 : // Use conditional template here in case we ever want
134 : // something else than dg_subcell, but only add coordinates
135 : // for dg_subcell (MC is not coded for DG)
136 : use_dg_subcell,
137 : tmpl::list<evolution::dg::subcell::Tags::ObserverCoordinatesCompute<
138 : volume_dim, Frame::ElementLogical>,
139 : evolution::dg::subcell::Tags::ObserverCoordinatesCompute<
140 : volume_dim, Frame::Grid>,
141 : evolution::dg::subcell::Tags::ObserverCoordinatesCompute<
142 : volume_dim, Frame::Inertial>>,
143 : tmpl::list<>>>,
144 : Particles::MonteCarlo::Tags::InertialFrameEnergyDensity>;
145 0 : using non_tensor_compute_tags = tmpl::conditional_t<
146 : use_dg_subcell,
147 : tmpl::list<evolution::dg::subcell::Tags::ObserverMeshCompute<volume_dim>,
148 : evolution::dg::subcell::Tags::
149 : ObserverJacobianAndDetInvJacobianCompute<
150 : volume_dim, Frame::ElementLogical, Frame::Inertial>,
151 : evolution::dg::subcell::Tags::ObserverInverseJacobianCompute<
152 : volume_dim, Frame::ElementLogical, Frame::Inertial>>,
153 : tmpl::list<>>;
154 :
155 0 : using analytic_variables_tags = typename system::variables_tag::tags_list;
156 0 : using analytic_compute = evolution::Tags::AnalyticSolutionsCompute<
157 : volume_dim, analytic_variables_tags, false, initial_data_list>;
158 :
159 : struct factory_creation
160 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
161 0 : using factory_classes = tmpl::map<
162 : tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
163 : tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
164 : tmpl::pair<Event,
165 : tmpl::flatten<tmpl::list<
166 : Events::Completion,
167 : ::Events::ObserveNorms<observe_fields,
168 : non_tensor_compute_tags>,
169 : dg::Events::ObserveFields<volume_dim, observe_fields,
170 : non_tensor_compute_tags>>>>,
171 : tmpl::pair<evolution::initial_data::InitialData, initial_data_list>,
172 : tmpl::pair<
173 : grmhd::AnalyticData::InitialMagneticFields::InitialMagneticField,
174 : grmhd::AnalyticData::InitialMagneticFields::
175 : initial_magnetic_fields>,
176 : tmpl::pair<PhaseChange,
177 : tmpl::list<PhaseControl::CheckpointAndExitAfterWallclock>>,
178 : tmpl::pair<StepChooser<StepChooserUse::Slab>,
179 : StepChoosers::standard_slab_choosers<system, false>>,
180 : tmpl::pair<TimeSequence<double>,
181 : TimeSequences::all_time_sequences<double>>,
182 : tmpl::pair<TimeSequence<std::uint64_t>,
183 : TimeSequences::all_time_sequences<std::uint64_t>>,
184 : tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
185 : tmpl::pair<Trigger, Triggers::time_triggers>>;
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 0 : using dg_registration_list =
193 : tmpl::list<observers::Actions::RegisterEventsWithObservers>;
194 :
195 0 : using initialization_actions = tmpl::list<
196 : Initialization::Actions::InitializeItems<
197 : Initialization::TimeStepping<EvolutionMetavars, TimeStepper, false,
198 : false>,
199 : evolution::dg::Initialization::Domain<EvolutionMetavars>>,
200 : Initialization::Actions::AddSimpleTags<
201 : NoStepperErrorEstimates,
202 : evolution::dg::BackgroundGrVars<system, EvolutionMetavars>>,
203 : evolution::dg::subcell::Actions::SetSubcellGrid<volume_dim, system,
204 : false>,
205 : Initialization::Actions::AddSimpleTags<
206 : evolution::dg::subcell::BackgroundGrVars<system, EvolutionMetavars,
207 : false>>,
208 : Actions::MutateApply<Particles::MonteCarlo::SwapGrTags>,
209 : Initialization::Actions::InitializeMCTags<system, EnergyBins,
210 : NeutrinoSpecies, true>,
211 : Initialization::Actions::AddComputeTags<tmpl::list<
212 : Particles::MonteCarlo::CellLightCrossingTimeCompute,
213 : Particles::MonteCarlo::InertialFrameEnergyDensityCompute,
214 : Particles::MonteCarlo::InverseJacobianInertialToFluidCompute,
215 : domain::Tags::JacobianCompute<4, Frame::Inertial, Frame::Fluid>>>,
216 : evolution::Actions::InitializeRunEventsAndDenseTriggers,
217 : Parallel::Actions::TerminatePhase>;
218 :
219 0 : using dg_element_array = DgElementArray<
220 : EvolutionMetavars,
221 : tmpl::list<
222 : Parallel::PhaseActions<Parallel::Phase::Initialization,
223 : initialization_actions>,
224 : Parallel::PhaseActions<Parallel::Phase::Register,
225 : tmpl::list<dg_registration_list,
226 : Parallel::Actions::TerminatePhase>>,
227 : Parallel::PhaseActions<
228 : Parallel::Phase::WriteCheckpoint,
229 : tmpl::list<evolution::Actions::RunEventsAndTriggers<
230 : Triggers::WhenToCheck::AtCheckpoints>,
231 : Parallel::Actions::TerminatePhase>>,
232 : Parallel::PhaseActions<
233 : Parallel::Phase::Evolve,
234 : tmpl::list<
235 : Actions::MutateApply<AdvanceTime<>>,
236 : evolution::Actions::RunEventsAndTriggers<
237 : Triggers::WhenToCheck::AtSlabs>,
238 : // Monte-Carlo is only triggered at the end of a full time
239 : // step
240 : Particles::MonteCarlo::Actions::TriggerMonteCarloEvolution,
241 : Actions::Label<
242 : Particles::MonteCarlo::Actions::Labels::BeginMonteCarlo>,
243 : Particles::MonteCarlo::Actions::SendDataForMcCommunication<
244 : volume_dim,
245 : // No local time stepping
246 : false, Particles::MonteCarlo::CommunicationStep::PreStep>,
247 : Particles::MonteCarlo::Actions::ReceiveDataForMcCommunication<
248 : volume_dim,
249 : Particles::MonteCarlo::CommunicationStep::PreStep>,
250 : Particles::MonteCarlo::Actions::TakeTimeStep<EnergyBins,
251 : NeutrinoSpecies>,
252 : Particles::MonteCarlo::Actions::SendDataForMcCommunication<
253 : volume_dim,
254 : // No local time stepping
255 : false,
256 : Particles::MonteCarlo::CommunicationStep::PostStep>,
257 : Particles::MonteCarlo::Actions::ReceiveDataForMcCommunication<
258 : volume_dim,
259 : Particles::MonteCarlo::CommunicationStep::PostStep>,
260 : Actions::Label<
261 : Particles::MonteCarlo::Actions::Labels::EndMonteCarlo>,
262 : PhaseControl::Actions::ExecutePhaseChange>>>>;
263 :
264 : struct registration
265 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
266 0 : using element_registrars =
267 : tmpl::map<tmpl::pair<dg_element_array, dg_registration_list>>;
268 : };
269 :
270 0 : using component_list =
271 : tmpl::list<observers::Observer<EvolutionMetavars>,
272 : observers::ObserverWriter<EvolutionMetavars>,
273 : dg_element_array>;
274 :
275 0 : using const_global_cache_tags = tmpl::list<
276 : Particles::MonteCarlo::Tags::MonteCarloOptions<NeutrinoSpecies>,
277 : equation_of_state_tag, evolution::initial_data::Tags::InitialData,
278 : Particles::MonteCarlo::Tags::InteractionRatesTable<EnergyBins,
279 : NeutrinoSpecies>>;
280 :
281 : static constexpr Options::String help{
282 : "Evolve Monte Carlo transport (without coupling to hydro).\n\n"};
283 :
284 : static constexpr std::array<Parallel::Phase, 5> default_phase_order{
285 : {Parallel::Phase::Initialization,
286 : Parallel::Phase::InitializeTimeStepperHistory, Parallel::Phase::Register,
287 : Parallel::Phase::Evolve, Parallel::Phase::Exit}};
288 :
289 : // NOLINTNEXTLINE(google-runtime-references)
290 0 : void pup(PUP::er& /*p*/) {}
291 : };
|