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