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 <string>
8 : #include <vector>
9 :
10 : #include "ControlSystem/Actions/InitializeMeasurements.hpp"
11 : #include "ControlSystem/Component.hpp"
12 : #include "ControlSystem/ControlErrors/Size/Factory.hpp"
13 : #include "ControlSystem/ControlErrors/Size/State.hpp"
14 : #include "ControlSystem/Measurements/SingleHorizon.hpp"
15 : #include "ControlSystem/Metafunctions.hpp"
16 : #include "ControlSystem/Systems/Shape.hpp"
17 : #include "ControlSystem/Systems/Size.hpp"
18 : #include "ControlSystem/Systems/Translation.hpp"
19 : #include "ControlSystem/Trigger.hpp"
20 : #include "Domain/Structure/ObjectLabel.hpp"
21 : #include "Evolution/Actions/RunEventsAndTriggers.hpp"
22 : #include "Evolution/DiscontinuousGalerkin/InboxTags.hpp"
23 : #include "Evolution/Executables/GeneralizedHarmonic/Deadlock.hpp"
24 : #include "Evolution/Executables/GeneralizedHarmonic/GeneralizedHarmonicBase.hpp"
25 : #include "Evolution/Systems/Cce/Callbacks/DumpBondiSachsOnWorldtube.hpp"
26 : #include "Evolution/Systems/GeneralizedHarmonic/Actions/SetInitialData.hpp"
27 : #include "Options/FactoryHelpers.hpp"
28 : #include "Options/Protocols/FactoryCreation.hpp"
29 : #include "Options/String.hpp"
30 : #include "Parallel/ArrayCollection/DgElementCollection.hpp"
31 : #include "Parallel/GlobalCache.hpp"
32 : #include "Parallel/Invoke.hpp"
33 : #include "Parallel/MemoryMonitor/MemoryMonitor.hpp"
34 : #include "Parallel/PhaseControl/ExecutePhaseChange.hpp"
35 : #include "Parallel/Protocols/RegistrationMetavariables.hpp"
36 : #include "ParallelAlgorithms/Actions/FunctionsOfTimeAreReady.hpp"
37 : #include "ParallelAlgorithms/Amr/Projectors/CopyFromCreatorOrLeaveAsIs.hpp"
38 : #include "ParallelAlgorithms/ApparentHorizonFinder/Callbacks/ErrorOnFailedApparentHorizon.hpp"
39 : #include "ParallelAlgorithms/ApparentHorizonFinder/Callbacks/FindApparentHorizon.hpp"
40 : #include "ParallelAlgorithms/ApparentHorizonFinder/Callbacks/IgnoreFailedApparentHorizon.hpp"
41 : #include "ParallelAlgorithms/ApparentHorizonFinder/ComputeExcisionBoundaryVolumeQuantities.hpp"
42 : #include "ParallelAlgorithms/ApparentHorizonFinder/ComputeExcisionBoundaryVolumeQuantities.tpp"
43 : #include "ParallelAlgorithms/ApparentHorizonFinder/ComputeHorizonVolumeQuantities.hpp"
44 : #include "ParallelAlgorithms/ApparentHorizonFinder/ComputeHorizonVolumeQuantities.tpp"
45 : #include "ParallelAlgorithms/ApparentHorizonFinder/HorizonAliases.hpp"
46 : #include "ParallelAlgorithms/ApparentHorizonFinder/InterpolationTarget.hpp"
47 : #include "ParallelAlgorithms/EventsAndTriggers/Actions/RunEventsOnFailure.hpp"
48 : #include "ParallelAlgorithms/Interpolation/Actions/CleanUpInterpolator.hpp"
49 : #include "ParallelAlgorithms/Interpolation/Actions/ElementInitInterpPoints.hpp"
50 : #include "ParallelAlgorithms/Interpolation/Actions/InitializeInterpolationTarget.hpp"
51 : #include "ParallelAlgorithms/Interpolation/Actions/InterpolationTargetReceiveVars.hpp"
52 : #include "ParallelAlgorithms/Interpolation/Actions/InterpolatorReceivePoints.hpp"
53 : #include "ParallelAlgorithms/Interpolation/Actions/InterpolatorReceiveVolumeData.hpp"
54 : #include "ParallelAlgorithms/Interpolation/Actions/InterpolatorRegisterElement.hpp"
55 : #include "ParallelAlgorithms/Interpolation/Actions/TryToInterpolate.hpp"
56 : #include "ParallelAlgorithms/Interpolation/Callbacks/ObserveSurfaceData.hpp"
57 : #include "ParallelAlgorithms/Interpolation/Callbacks/ObserveTimeSeriesOnSurface.hpp"
58 : #include "ParallelAlgorithms/Interpolation/Events/Interpolate.hpp"
59 : #include "ParallelAlgorithms/Interpolation/Events/InterpolateWithoutInterpComponent.hpp"
60 : #include "ParallelAlgorithms/Interpolation/InterpolationTarget.hpp"
61 : #include "ParallelAlgorithms/Interpolation/Interpolator.hpp"
62 : #include "ParallelAlgorithms/Interpolation/Protocols/InterpolationTargetTag.hpp"
63 : #include "ParallelAlgorithms/Interpolation/Tags.hpp"
64 : #include "ParallelAlgorithms/Interpolation/Targets/Sphere.hpp"
65 : #include "PointwiseFunctions/GeneralRelativity/DetAndInverseSpatialMetric.hpp"
66 : #include "PointwiseFunctions/GeneralRelativity/Surfaces/Tags.hpp"
67 : #include "Time/Actions/SelfStartActions.hpp"
68 : #include "Time/ChangeSlabSize/Action.hpp"
69 : #include "Time/ChangeSlabSize/Tags.hpp"
70 : #include "Time/StepChoosers/Factory.hpp"
71 : #include "Time/Tags/StepperErrors.hpp"
72 : #include "Time/Tags/Time.hpp"
73 : #include "Utilities/Algorithm.hpp"
74 : #include "Utilities/ErrorHandling/Error.hpp"
75 : #include "Utilities/PrettyType.hpp"
76 : #include "Utilities/ProtocolHelpers.hpp"
77 :
78 : template <bool UseLts>
79 : struct EvolutionMetavars : public GeneralizedHarmonicTemplateBase<3, UseLts> {
80 : static constexpr bool local_time_stepping = UseLts;
81 : static constexpr size_t volume_dim = 3;
82 0 : using gh_base = GeneralizedHarmonicTemplateBase<volume_dim, UseLts>;
83 0 : using typename gh_base::initialize_initial_data_dependent_quantities_actions;
84 0 : using typename gh_base::system;
85 :
86 : static constexpr Options::String help{
87 : "Evolve the Einstein field equations using the Generalized Harmonic "
88 : "formulation,\n"
89 : "on a domain with a single horizon and corresponding excised region"};
90 :
91 0 : struct ApparentHorizon
92 : : tt::ConformsTo<intrp::protocols::InterpolationTargetTag> {
93 0 : using temporal_id = ::Tags::Time;
94 0 : using tags_to_observe = ::ah::tags_for_observing<Frame::Inertial>;
95 0 : using surface_tags_to_observe = ::ah::surface_tags_for_observing;
96 0 : using compute_vars_to_interpolate = ah::ComputeHorizonVolumeQuantities;
97 0 : using vars_to_interpolate_to_target =
98 : ::ah::vars_to_interpolate_to_target<volume_dim, ::Frame::Inertial>;
99 0 : using compute_items_on_target =
100 : ::ah::compute_items_on_target<volume_dim, Frame::Inertial>;
101 0 : using compute_target_points =
102 : ah::TargetPoints::ApparentHorizon<ApparentHorizon, ::Frame::Inertial>;
103 0 : using post_interpolation_callbacks =
104 : tmpl::list<intrp::callbacks::FindApparentHorizon<ApparentHorizon,
105 : ::Frame::Inertial>>;
106 0 : using horizon_find_failure_callbacks =
107 : tmpl::list<intrp::callbacks::IgnoreFailedApparentHorizon>;
108 0 : using post_horizon_find_callbacks = tmpl::list<
109 : intrp::callbacks::ObserveTimeSeriesOnSurface<tags_to_observe,
110 : ApparentHorizon>,
111 : intrp::callbacks::ObserveSurfaceData<
112 : surface_tags_to_observe, ApparentHorizon, ::Frame::Inertial>>;
113 : };
114 :
115 : struct ExcisionBoundary
116 : : tt::ConformsTo<intrp::protocols::InterpolationTargetTag> {
117 0 : using temporal_id = ::Tags::Time;
118 0 : using tags_to_observe =
119 : tmpl::list<gr::Tags::Lapse<DataVector>,
120 : gr::Tags::Shift<DataVector, 3, Frame::Grid>>;
121 0 : using compute_vars_to_interpolate =
122 : ah::ComputeExcisionBoundaryVolumeQuantities;
123 0 : using vars_to_interpolate_to_target = tags_to_observe;
124 0 : using compute_items_on_source = tmpl::list<>;
125 0 : using compute_items_on_target = tmpl::list<>;
126 0 : using compute_target_points =
127 : intrp::TargetPoints::Sphere<ExcisionBoundary, ::Frame::Grid>;
128 0 : using post_interpolation_callbacks =
129 : tmpl::list<intrp::callbacks::ObserveSurfaceData<
130 : tags_to_observe, ExcisionBoundary, ::Frame::Grid>>;
131 : // run_callbacks
132 : template <typename metavariables>
133 0 : using interpolating_component = typename metavariables::gh_dg_element_array;
134 : };
135 :
136 0 : using control_systems =
137 : tmpl::list<control_system::Systems::Shape<
138 : ::domain::ObjectLabel::None, 2,
139 : control_system::measurements::SingleHorizon<
140 : ::domain::ObjectLabel::None>>,
141 : control_system::Systems::Translation<
142 : 2,
143 : control_system::measurements::SingleHorizon<
144 : ::domain::ObjectLabel::None>,
145 : 1>,
146 : control_system::Systems::Size<::domain::ObjectLabel::None, 2>>;
147 :
148 : static constexpr bool use_control_systems =
149 : tmpl::size<control_systems>::value > 0;
150 :
151 : struct BondiSachs;
152 :
153 0 : using interpolation_target_tags = tmpl::push_back<
154 : control_system::metafunctions::interpolation_target_tags<control_systems>,
155 : ApparentHorizon, ExcisionBoundary, BondiSachs>;
156 0 : using interpolator_source_vars = ::ah::source_vars<volume_dim>;
157 0 : using source_vars_no_deriv =
158 : tmpl::list<gr::Tags::SpacetimeMetric<DataVector, volume_dim>,
159 : gh::Tags::Pi<DataVector, volume_dim>,
160 : gh::Tags::Phi<DataVector, volume_dim>>;
161 :
162 : struct BondiSachs : tt::ConformsTo<intrp::protocols::InterpolationTargetTag> {
163 0 : static std::string name() { return "BondiSachsInterpolation"; }
164 0 : using temporal_id = ::Tags::Time;
165 0 : using vars_to_interpolate_to_target = source_vars_no_deriv;
166 0 : using compute_target_points =
167 : intrp::TargetPoints::Sphere<BondiSachs, ::Frame::Inertial>;
168 0 : using post_interpolation_callbacks =
169 : tmpl::list<intrp::callbacks::DumpBondiSachsOnWorldtube<BondiSachs>>;
170 0 : using compute_items_on_target = tmpl::list<>;
171 : template <typename Metavariables>
172 0 : using interpolating_component = typename Metavariables::gh_dg_element_array;
173 : };
174 :
175 : // The interpolator_source_vars need to be the same in both the Interpolate
176 : // event and the InterpolateWithoutInterpComponent event. The Interpolate
177 : // event interpolates to the horizon, and the
178 : // InterpolateWithoutInterpComponent event interpolates to the excision
179 : // boundary. Every Target gets the same interpolator_source_vars, so they need
180 : // to be made the same. Otherwise a static assert is triggered.
181 : struct factory_creation
182 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
183 0 : using factory_classes = Options::add_factory_classes<
184 : // Restrict to monotonic time steppers in LTS to avoid control
185 : // systems deadlocking.
186 : tmpl::insert<
187 : tmpl::erase<typename gh_base::factory_creation::factory_classes,
188 : LtsTimeStepper>,
189 : tmpl::pair<LtsTimeStepper,
190 : TimeSteppers::monotonic_lts_time_steppers>>,
191 : tmpl::pair<Event,
192 : tmpl::flatten<tmpl::list<
193 : intrp::Events::Interpolate<3, ApparentHorizon,
194 : interpolator_source_vars>,
195 : control_system::metafunctions::control_system_events<
196 : control_systems>,
197 : intrp::Events::InterpolateWithoutInterpComponent<
198 : 3, BondiSachs, source_vars_no_deriv>,
199 : intrp::Events::InterpolateWithoutInterpComponent<
200 : 3, ExcisionBoundary, interpolator_source_vars>>>>,
201 : tmpl::pair<DenseTrigger,
202 : control_system::control_system_triggers<control_systems>>,
203 : tmpl::pair<control_system::size::State,
204 : control_system::size::States::factory_creatable_states>>;
205 : };
206 :
207 0 : using typename gh_base::const_global_cache_tags;
208 :
209 0 : using observed_reduction_data_tags =
210 : observers::collect_reduction_data_tags<tmpl::push_back<
211 : tmpl::at<typename factory_creation::factory_classes, Event>,
212 : typename ApparentHorizon::post_horizon_find_callbacks,
213 : typename ExcisionBoundary::post_interpolation_callbacks>>;
214 :
215 0 : using dg_registration_list =
216 : tmpl::push_back<typename gh_base::dg_registration_list,
217 : intrp::Actions::RegisterElementWithInterpolator>;
218 :
219 0 : using step_actions = typename gh_base::template step_actions<control_systems>;
220 :
221 0 : using initialization_actions = tmpl::push_back<
222 : tmpl::pop_back<typename gh_base::template initialization_actions<
223 : EvolutionMetavars, use_control_systems>>,
224 : control_system::Actions::InitializeMeasurements<control_systems>,
225 : intrp::Actions::ElementInitInterpPoints<
226 : intrp::Tags::InterpPointInfo<EvolutionMetavars>>,
227 : tmpl::back<typename gh_base::template initialization_actions<
228 : EvolutionMetavars, use_control_systems>>>;
229 :
230 0 : using gh_dg_element_array = DgElementArray<
231 : EvolutionMetavars,
232 : tmpl::flatten<tmpl::list<
233 : Parallel::PhaseActions<Parallel::Phase::Initialization,
234 : initialization_actions>,
235 : Parallel::PhaseActions<
236 : Parallel::Phase::RegisterWithElementDataReader,
237 : tmpl::list<importers::Actions::RegisterWithElementDataReader,
238 : Parallel::Actions::TerminatePhase>>,
239 : Parallel::PhaseActions<
240 : Parallel::Phase::ImportInitialData,
241 : tmpl::list<gh::Actions::SetInitialData,
242 : gh::Actions::ReceiveNumericInitialData,
243 : Parallel::Actions::TerminatePhase>>,
244 : Parallel::PhaseActions<
245 : Parallel::Phase::InitializeInitialDataDependentQuantities,
246 : initialize_initial_data_dependent_quantities_actions>,
247 : Parallel::PhaseActions<
248 : Parallel::Phase::InitializeTimeStepperHistory,
249 : SelfStart::self_start_procedure<step_actions, system>>,
250 : Parallel::PhaseActions<Parallel::Phase::Register,
251 : tmpl::list<dg_registration_list,
252 : Parallel::Actions::TerminatePhase>>,
253 : Parallel::PhaseActions<Parallel::Phase::Restart,
254 : tmpl::list<dg_registration_list,
255 : Parallel::Actions::TerminatePhase>>,
256 : Parallel::PhaseActions<Parallel::Phase::CheckDomain,
257 : tmpl::list<::amr::Actions::SendAmrDiagnostics,
258 : Parallel::Actions::TerminatePhase>>,
259 : Parallel::PhaseActions<
260 : Parallel::Phase::Evolve,
261 : tmpl::list<
262 : ::domain::Actions::CheckFunctionsOfTimeAreReady<volume_dim>,
263 : evolution::Actions::RunEventsAndTriggers<local_time_stepping>,
264 : Actions::ChangeSlabSize, step_actions, Actions::AdvanceTime,
265 : PhaseControl::Actions::ExecutePhaseChange>>,
266 : Parallel::PhaseActions<
267 : Parallel::Phase::PostFailureCleanup,
268 : tmpl::list<Actions::RunEventsOnFailure<::Tags::Time>,
269 : Parallel::Actions::TerminatePhase>>>>>;
270 :
271 : struct amr : tt::ConformsTo<::amr::protocols::AmrMetavariables> {
272 0 : using element_array = gh_dg_element_array;
273 0 : using projectors = tmpl::list<
274 : Initialization::ProjectTimeStepping<volume_dim>,
275 : evolution::dg::Initialization::ProjectDomain<volume_dim>,
276 : Initialization::ProjectTimeStepperHistory<EvolutionMetavars>,
277 : ::amr::projectors::ProjectVariables<volume_dim,
278 : typename system::variables_tag>,
279 : evolution::dg::Initialization::ProjectMortars<EvolutionMetavars>,
280 : evolution::Actions::ProjectRunEventsAndDenseTriggers,
281 : ::amr::projectors::DefaultInitialize<
282 : Initialization::Tags::InitialTimeDelta,
283 : Initialization::Tags::InitialSlabSize<gh_base::local_time_stepping>,
284 : ::domain::Tags::InitialExtents<volume_dim>,
285 : ::domain::Tags::InitialRefinementLevels<volume_dim>,
286 : evolution::dg::Tags::Quadrature,
287 : Tags::StepperErrors<typename system::variables_tag>,
288 : SelfStart::Tags::InitialValue<typename system::variables_tag>,
289 : SelfStart::Tags::InitialValue<Tags::TimeStep>,
290 : evolution::dg::Tags::BoundaryData<volume_dim>>,
291 : ::amr::projectors::CopyFromCreatorOrLeaveAsIs<tmpl::push_back<
292 : typename control_system::Actions::InitializeMeasurements<
293 : control_systems>::simple_tags,
294 : intrp::Tags::InterpPointInfo<EvolutionMetavars>,
295 : Tags::ChangeSlabSize::NumberOfExpectedMessages,
296 : Tags::ChangeSlabSize::NewSlabSize>>>;
297 : static constexpr bool keep_coarse_grids = false;
298 : };
299 :
300 : struct registration
301 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
302 0 : using element_registrars =
303 : tmpl::map<tmpl::pair<gh_dg_element_array, dg_registration_list>>;
304 : };
305 :
306 0 : using control_components =
307 : control_system::control_components<EvolutionMetavars, control_systems>;
308 :
309 0 : static void run_deadlock_analysis_simple_actions(
310 : Parallel::GlobalCache<EvolutionMetavars>& cache,
311 : const std::vector<std::string>& deadlocked_components) {
312 : gh::deadlock::run_deadlock_analysis_simple_actions<
313 : gh_dg_element_array, control_components, interpolation_target_tags>(
314 : cache, deadlocked_components);
315 : }
316 :
317 0 : using component_list = tmpl::flatten<tmpl::list<
318 : ::amr::Component<EvolutionMetavars>,
319 : observers::Observer<EvolutionMetavars>,
320 : observers::ObserverWriter<EvolutionMetavars>,
321 : mem_monitor::MemoryMonitor<EvolutionMetavars>,
322 : importers::ElementDataReader<EvolutionMetavars>, gh_dg_element_array,
323 : intrp::Interpolator<EvolutionMetavars>, control_components,
324 : tmpl::transform<interpolation_target_tags,
325 : tmpl::bind<intrp::InterpolationTarget,
326 : tmpl::pin<EvolutionMetavars>, tmpl::_1>>>>;
327 : };
|