Line data Source code
1 0 : // Distributed under the MIT License.
2 : // See LICENSE.txt for details.
3 :
4 : #pragma once
5 :
6 : #include <cstddef>
7 : #include <cstdint>
8 : #include <vector>
9 :
10 : #include "Domain/Creators/Factory1D.hpp"
11 : #include "Domain/Creators/Factory2D.hpp"
12 : #include "Domain/Creators/Factory3D.hpp"
13 : #include "Domain/Tags.hpp"
14 : #include "Evolution/Actions/RunEventsAndDenseTriggers.hpp"
15 : #include "Evolution/Actions/RunEventsAndTriggers.hpp"
16 : #include "Evolution/ComputeTags.hpp"
17 : #include "Evolution/Conservative/UpdateConservatives.hpp"
18 : #include "Evolution/DiscontinuousGalerkin/Actions/ApplyBoundaryCorrections.hpp"
19 : #include "Evolution/DiscontinuousGalerkin/Actions/ComputeTimeDerivative.hpp"
20 : #include "Evolution/DiscontinuousGalerkin/BackgroundGrVars.hpp"
21 : #include "Evolution/DiscontinuousGalerkin/DgElementArray.hpp"
22 : #include "Evolution/DiscontinuousGalerkin/Initialization/Mortars.hpp"
23 : #include "Evolution/DiscontinuousGalerkin/Initialization/QuadratureTag.hpp"
24 : #include "Evolution/DiscontinuousGalerkin/Limiters/Minmod.hpp"
25 : #include "Evolution/DiscontinuousGalerkin/Limiters/Tags.hpp"
26 : #include "Evolution/Initialization/ConservativeSystem.hpp"
27 : #include "Evolution/Initialization/DgDomain.hpp"
28 : #include "Evolution/Initialization/Evolution.hpp"
29 : #include "Evolution/Initialization/Limiter.hpp"
30 : #include "Evolution/Initialization/SetVariables.hpp"
31 : #include "Evolution/Systems/RelativisticEuler/Valencia/BoundaryConditions/Factory.hpp"
32 : #include "Evolution/Systems/RelativisticEuler/Valencia/BoundaryCorrections/Factory.hpp"
33 : #include "Evolution/Systems/RelativisticEuler/Valencia/FixConservatives.hpp"
34 : #include "Evolution/Systems/RelativisticEuler/Valencia/System.hpp"
35 : #include "Evolution/Systems/RelativisticEuler/Valencia/Tags.hpp"
36 : #include "Evolution/VariableFixing/Actions.hpp"
37 : #include "Evolution/VariableFixing/FixToAtmosphere.hpp"
38 : #include "Evolution/VariableFixing/Tags.hpp"
39 : #include "IO/Observer/Actions/RegisterEvents.hpp"
40 : #include "IO/Observer/Helpers.hpp"
41 : #include "IO/Observer/ObserverComponent.hpp"
42 : #include "NumericalAlgorithms/DiscontinuousGalerkin/Formulation.hpp"
43 : #include "NumericalAlgorithms/DiscontinuousGalerkin/Tags.hpp"
44 : #include "Options/Protocols/FactoryCreation.hpp"
45 : #include "Options/String.hpp"
46 : #include "Parallel/Local.hpp"
47 : #include "Parallel/Phase.hpp"
48 : #include "Parallel/PhaseControl/CheckpointAndExitAfterWallclock.hpp"
49 : #include "Parallel/PhaseControl/ExecutePhaseChange.hpp"
50 : #include "Parallel/PhaseControl/Factory.hpp"
51 : #include "Parallel/PhaseControl/VisitAndReturn.hpp"
52 : #include "Parallel/PhaseDependentActionList.hpp"
53 : #include "Parallel/Protocols/RegistrationMetavariables.hpp"
54 : #include "ParallelAlgorithms/Actions/AddComputeTags.hpp"
55 : #include "ParallelAlgorithms/Actions/AddSimpleTags.hpp"
56 : #include "ParallelAlgorithms/Actions/InitializeItems.hpp"
57 : #include "ParallelAlgorithms/Actions/LimiterActions.hpp"
58 : #include "ParallelAlgorithms/Actions/MutateApply.hpp"
59 : #include "ParallelAlgorithms/Actions/TerminatePhase.hpp"
60 : #include "ParallelAlgorithms/Events/Factory.hpp"
61 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTrigger.hpp"
62 : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTriggers/Factory.hpp"
63 : #include "ParallelAlgorithms/EventsAndTriggers/Completion.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/AnalyticSolutions/AnalyticSolution.hpp"
70 : #include "PointwiseFunctions/AnalyticSolutions/RelativisticEuler/SmoothFlow.hpp"
71 : #include "PointwiseFunctions/AnalyticSolutions/Tags.hpp"
72 : #include "PointwiseFunctions/Hydro/EquationsOfState/Factory.hpp"
73 : #include "PointwiseFunctions/Hydro/EquationsOfState/RegisterDerivedWithCharm.hpp"
74 : #include "PointwiseFunctions/Hydro/SoundSpeedSquared.hpp"
75 : #include "PointwiseFunctions/Hydro/Tags.hpp"
76 : #include "Time/Actions/AdvanceTime.hpp"
77 : #include "Time/Actions/RecordTimeStepperData.hpp"
78 : #include "Time/Actions/SelfStartActions.hpp"
79 : #include "Time/Actions/UpdateU.hpp"
80 : #include "Time/ChangeSlabSize/Action.hpp"
81 : #include "Time/StepChoosers/Factory.hpp"
82 : #include "Time/StepChoosers/StepChooser.hpp"
83 : #include "Time/Tags/Time.hpp"
84 : #include "Time/Tags/TimeStepId.hpp"
85 : #include "Time/TimeSequence.hpp"
86 : #include "Time/TimeSteppers/Factory.hpp"
87 : #include "Time/TimeSteppers/LtsTimeStepper.hpp"
88 : #include "Time/TimeSteppers/TimeStepper.hpp"
89 : #include "Time/Triggers/TimeTriggers.hpp"
90 : #include "Utilities/Functional.hpp"
91 : #include "Utilities/ProtocolHelpers.hpp"
92 : #include "Utilities/TMPL.hpp"
93 :
94 : /// \cond
95 : namespace Frame {
96 : struct Inertial;
97 : } // namespace Frame
98 : namespace PUP {
99 : class er;
100 : } // namespace PUP
101 : namespace Parallel {
102 : template <typename Metavariables>
103 : class CProxy_GlobalCache;
104 : } // namespace Parallel
105 : /// \endcond
106 :
107 : template <size_t Dim, typename InitialData>
108 : struct EvolutionMetavars {
109 : static constexpr size_t volume_dim = Dim;
110 : static constexpr dg::Formulation dg_formulation =
111 : dg::Formulation::StrongInertial;
112 :
113 0 : using initial_data = InitialData;
114 : static_assert(
115 : is_analytic_data_v<initial_data> xor is_analytic_solution_v<initial_data>,
116 : "initial_data must be either an analytic_data or an analytic_solution");
117 :
118 0 : using eos_base = typename EquationsOfState::get_eos_base<
119 : typename initial_data::equation_of_state_type>;
120 0 : using equation_of_state_type = typename std::unique_ptr<eos_base>;
121 :
122 0 : using system = RelativisticEuler::Valencia::System<Dim>;
123 :
124 0 : using temporal_id = Tags::TimeStepId;
125 0 : using TimeStepperBase = TimeStepper;
126 :
127 : static constexpr bool local_time_stepping =
128 : TimeStepperBase::local_time_stepping;
129 :
130 0 : using initial_data_tag =
131 : tmpl::conditional_t<is_analytic_solution_v<initial_data>,
132 : Tags::AnalyticSolution<initial_data>,
133 : Tags::AnalyticData<initial_data>>;
134 :
135 0 : using analytic_variables_tags =
136 : typename system::primitive_variables_tag::tags_list;
137 :
138 0 : using equation_of_state_tag =
139 : hydro::Tags::EquationOfState<equation_of_state_type>;
140 :
141 0 : using limiter = Tags::Limiter<Limiters::Minmod<
142 : Dim, tmpl::list<RelativisticEuler::Valencia::Tags::TildeD,
143 : RelativisticEuler::Valencia::Tags::TildeTau,
144 : RelativisticEuler::Valencia::Tags::TildeS<Dim>>>>;
145 :
146 0 : using analytic_compute =
147 : evolution::Tags::AnalyticSolutionsCompute<volume_dim,
148 : analytic_variables_tags, false>;
149 0 : using error_compute = Tags::ErrorsCompute<analytic_variables_tags>;
150 0 : using error_tags = db::wrap_tags_in<Tags::Error, analytic_variables_tags>;
151 0 : using observe_fields = tmpl::push_back<
152 : tmpl::append<typename system::variables_tag::tags_list,
153 : typename system::primitive_variables_tag::tags_list,
154 : error_tags>,
155 : domain::Tags::Coordinates<volume_dim, Frame::Grid>,
156 : domain::Tags::Coordinates<volume_dim, Frame::Inertial>>;
157 0 : using non_tensor_compute_tags =
158 : tmpl::list<::Events::Tags::ObserverMeshCompute<volume_dim>,
159 : ::Events::Tags::ObserverDetInvJacobianCompute<
160 : Frame::ElementLogical, Frame::Inertial>,
161 : analytic_compute, error_compute>;
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 : dg::Events::field_observations<
172 : volume_dim, observe_fields, non_tensor_compute_tags>,
173 : Events::time_events<system>>>>,
174 : tmpl::pair<LtsTimeStepper, TimeSteppers::lts_time_steppers>,
175 : tmpl::pair<PhaseChange, PhaseControl::factory_creatable_classes>,
176 : tmpl::pair<RelativisticEuler::Valencia::BoundaryConditions::
177 : BoundaryCondition<volume_dim>,
178 : RelativisticEuler::Valencia::BoundaryConditions::
179 : standard_boundary_conditions<volume_dim>>,
180 : tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
181 : StepChoosers::standard_step_choosers<system, false>>,
182 : tmpl::pair<StepChooser<StepChooserUse::Slab>,
183 : StepChoosers::standard_slab_choosers<
184 : system, local_time_stepping, 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, tmpl::append<Triggers::logical_triggers,
191 : Triggers::time_triggers>>>;
192 : };
193 :
194 0 : using observed_reduction_data_tags =
195 : observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
196 : tmpl::at<typename factory_creation::factory_classes, Event>>>>;
197 :
198 0 : using step_actions = tmpl::flatten<tmpl::list<
199 : Actions::MutateApply<
200 : evolution::dg::BackgroundGrVars<system, EvolutionMetavars, false>>,
201 : evolution::dg::Actions::ComputeTimeDerivative<
202 : volume_dim, system, AllStepChoosers, local_time_stepping>,
203 : tmpl::conditional_t<
204 : local_time_stepping,
205 : tmpl::list<evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<
206 : evolution::dg::ApplyBoundaryCorrections<
207 : local_time_stepping, system, volume_dim, true>,
208 : AlwaysReadyPostprocessor<
209 : typename system::primitive_from_conservative>>>,
210 : evolution::dg::Actions::ApplyLtsBoundaryCorrections<
211 : system, volume_dim, false>>,
212 : tmpl::list<
213 : evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
214 : system, volume_dim, false>,
215 : Actions::RecordTimeStepperData<system>,
216 : evolution::Actions::RunEventsAndDenseTriggers<
217 : tmpl::list<AlwaysReadyPostprocessor<
218 : typename system::primitive_from_conservative>>>,
219 : Actions::UpdateU<system>>>,
220 : Limiters::Actions::SendData<EvolutionMetavars>,
221 : Limiters::Actions::Limit<EvolutionMetavars>,
222 : VariableFixing::Actions::FixVariables<
223 : RelativisticEuler::Valencia::FixConservatives<Dim>>,
224 : // Conservative `UpdatePrimitives` expects system to possess
225 : // list of recovery schemes so we use `MutateApply` instead.
226 : Actions::MutateApply<typename system::primitive_from_conservative>>>;
227 :
228 0 : using dg_registration_list =
229 : tmpl::list<observers::Actions::RegisterEventsWithObservers>;
230 :
231 0 : using initialization_actions = tmpl::list<
232 : Initialization::Actions::InitializeItems<
233 : Initialization::TimeStepping<EvolutionMetavars, TimeStepperBase>,
234 : evolution::dg::Initialization::Domain<Dim>,
235 : Initialization::TimeStepperHistory<EvolutionMetavars>>,
236 : Initialization::Actions::AddSimpleTags<
237 : evolution::dg::BackgroundGrVars<system, EvolutionMetavars, false>>,
238 : Initialization::Actions::ConservativeSystem<system>,
239 : evolution::Initialization::Actions::SetVariables<
240 : domain::Tags::Coordinates<Dim, Frame::ElementLogical>>,
241 : VariableFixing::Actions::FixVariables<
242 : VariableFixing::FixToAtmosphere<volume_dim>>,
243 : Initialization::Actions::AddComputeTags<
244 : tmpl::list<hydro::Tags::SoundSpeedSquaredCompute<DataVector>>>,
245 : Actions::UpdateConservatives,
246 : Initialization::Actions::AddComputeTags<
247 : StepChoosers::step_chooser_compute_tags<EvolutionMetavars,
248 : local_time_stepping>>,
249 : ::evolution::dg::Initialization::Mortars<volume_dim, system>,
250 : Initialization::Actions::Minmod<Dim>,
251 : evolution::Actions::InitializeRunEventsAndDenseTriggers,
252 : Parallel::Actions::TerminatePhase>;
253 :
254 0 : using dg_element_array = DgElementArray<
255 : EvolutionMetavars,
256 : tmpl::list<
257 : Parallel::PhaseActions<Parallel::Phase::Initialization,
258 : initialization_actions>,
259 :
260 : Parallel::PhaseActions<
261 : Parallel::Phase::InitializeTimeStepperHistory,
262 : SelfStart::self_start_procedure<step_actions, system>>,
263 :
264 : Parallel::PhaseActions<Parallel::Phase::Register,
265 : tmpl::list<dg_registration_list,
266 : Parallel::Actions::TerminatePhase>>,
267 :
268 : Parallel::PhaseActions<
269 : Parallel::Phase::Evolve,
270 : tmpl::list<VariableFixing::Actions::FixVariables<
271 : VariableFixing::FixToAtmosphere<volume_dim>>,
272 : Actions::UpdateConservatives,
273 : evolution::Actions::RunEventsAndTriggers,
274 : Actions::ChangeSlabSize, step_actions,
275 : Actions::AdvanceTime,
276 : PhaseControl::Actions::ExecutePhaseChange>>>>;
277 :
278 : struct registration
279 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
280 0 : using element_registrars =
281 : tmpl::map<tmpl::pair<dg_element_array, dg_registration_list>>;
282 : };
283 :
284 0 : using component_list =
285 : tmpl::list<observers::Observer<EvolutionMetavars>,
286 : observers::ObserverWriter<EvolutionMetavars>,
287 : dg_element_array>;
288 :
289 0 : using const_global_cache_tags =
290 : tmpl::list<initial_data_tag, equation_of_state_tag>;
291 :
292 : static constexpr Options::String help{
293 : "Evolve the Valencia formulation of RelativisticEuler system.\n\n"};
294 :
295 : static constexpr std::array<Parallel::Phase, 5> default_phase_order{
296 : {Parallel::Phase::Initialization,
297 : Parallel::Phase::InitializeTimeStepperHistory, Parallel::Phase::Register,
298 : Parallel::Phase::Evolve, Parallel::Phase::Exit}};
299 :
300 : // NOLINTNEXTLINE(google-runtime-references)
301 0 : void pup(PUP::er& /*p*/) {}
302 : };
|
