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 :
8 : #include "DataStructures/DataBox/PrefixHelpers.hpp"
9 : #include "DataStructures/Tensor/EagerMath/Magnitude.hpp"
10 : #include "Domain/Creators/Factory3D.hpp"
11 : #include "Domain/RadiallyCompressedCoordinates.hpp"
12 : #include "Domain/Tags.hpp"
13 : #include "Elliptic/Actions/RunEventsAndTriggers.hpp"
14 : #include "Elliptic/BoundaryConditions/BoundaryCondition.hpp"
15 : #include "Elliptic/DiscontinuousGalerkin/DgElementArray.hpp"
16 : #include "Elliptic/Executables/Solver.hpp"
17 : #include "Elliptic/Systems/Xcts/BoundaryConditions/Factory.hpp"
18 : #include "Elliptic/Systems/Xcts/Events/ObserveAdmIntegrals.hpp"
19 : #include "Elliptic/Systems/Xcts/FirstOrderSystem.hpp"
20 : #include "Elliptic/Systems/Xcts/HydroQuantities.hpp"
21 : #include "Elliptic/Triggers/Factory.hpp"
22 : #include "IO/Observer/Actions/RegisterEvents.hpp"
23 : #include "IO/Observer/Helpers.hpp"
24 : #include "IO/Observer/ObserverComponent.hpp"
25 : #include "Options/Protocols/FactoryCreation.hpp"
26 : #include "Options/String.hpp"
27 : #include "Parallel/GlobalCache.hpp"
28 : #include "Parallel/Phase.hpp"
29 : #include "Parallel/PhaseControl/VisitAndReturn.hpp"
30 : #include "Parallel/PhaseDependentActionList.hpp"
31 : #include "Parallel/Protocols/RegistrationMetavariables.hpp"
32 : #include "Parallel/Reduction.hpp"
33 : #include "ParallelAlgorithms/Actions/TerminatePhase.hpp"
34 : #include "ParallelAlgorithms/Amr/Actions/SendAmrDiagnostics.hpp"
35 : #include "ParallelAlgorithms/Amr/Criteria/Factory.hpp"
36 : #include "ParallelAlgorithms/Amr/Protocols/AmrMetavariables.hpp"
37 : #include "ParallelAlgorithms/Amr/Tags.hpp"
38 : #include "ParallelAlgorithms/Events/Completion.hpp"
39 : #include "ParallelAlgorithms/Events/Factory.hpp"
40 : #include "ParallelAlgorithms/Events/Tags.hpp"
41 : #include "ParallelAlgorithms/EventsAndTriggers/Event.hpp"
42 : #include "ParallelAlgorithms/EventsAndTriggers/Trigger.hpp"
43 : #include "ParallelAlgorithms/LinearSolver/Multigrid/ElementsAllocator.hpp"
44 : #include "ParallelAlgorithms/LinearSolver/Multigrid/Tags.hpp"
45 : #include "PointwiseFunctions/AnalyticData/Xcts/Binary.hpp"
46 : #include "PointwiseFunctions/AnalyticData/Xcts/KerrSchildTeukolsky.hpp"
47 : #include "PointwiseFunctions/AnalyticSolutions/Xcts/Factory.hpp"
48 : #include "PointwiseFunctions/Hydro/LowerSpatialFourVelocity.hpp"
49 : #include "PointwiseFunctions/Hydro/Tags.hpp"
50 : #include "PointwiseFunctions/InitialDataUtilities/AnalyticSolution.hpp"
51 : #include "PointwiseFunctions/InitialDataUtilities/Background.hpp"
52 : #include "PointwiseFunctions/InitialDataUtilities/InitialGuess.hpp"
53 : #include "PointwiseFunctions/InitialDataUtilities/NumericData.hpp"
54 : #include "PointwiseFunctions/Xcts/SpacetimeQuantities.hpp"
55 : #include "Utilities/Functional.hpp"
56 : #include "Utilities/ProtocolHelpers.hpp"
57 : #include "Utilities/TMPL.hpp"
58 :
59 : /// \cond
60 : struct Metavariables {
61 : static constexpr size_t volume_dim = 3;
62 : static constexpr int conformal_matter_scale = 0;
63 : using system =
64 : Xcts::FirstOrderSystem<Xcts::Equations::HamiltonianLapseAndShift,
65 : Xcts::Geometry::Curved, conformal_matter_scale>;
66 : using solver = elliptic::Solver<Metavariables, volume_dim, system>;
67 :
68 : static constexpr Options::String help{
69 : "Find the solution to an XCTS problem."};
70 :
71 : using analytic_solution_fields = tmpl::append<typename system::primal_fields>;
72 : using spacetime_quantities_compute =
73 : Xcts::Tags::SpacetimeQuantitiesCompute<tmpl::list<
74 : Xcts::Tags::ConformalFactor<DataVector>,
75 : Xcts::Tags::LapseTimesConformalFactor<DataVector>,
76 : ::Tags::deriv<Xcts::Tags::ConformalFactor<DataVector>,
77 : tmpl::size_t<3>, Frame::Inertial>,
78 : gr::Tags::HamiltonianConstraint<DataVector>,
79 : gr::Tags::MomentumConstraint<DataVector, 3>,
80 : gr::Tags::SpatialMetric<DataVector, 3>,
81 : gr::Tags::InverseSpatialMetric<DataVector, 3>,
82 : ::Tags::deriv<gr::Tags::InverseSpatialMetric<DataVector, 3>,
83 : tmpl::size_t<3>, Frame::Inertial>,
84 : gr::Tags::SpatialChristoffelSecondKind<DataVector, 3>,
85 : gr::Tags::SpatialRicci<DataVector, 3>, gr::Tags::Lapse<DataVector>,
86 : ::Tags::deriv<gr::Tags::Lapse<DataVector>, tmpl::size_t<3>,
87 : Frame::Inertial>,
88 : gr::Tags::Shift<DataVector, 3>,
89 : ::Tags::deriv<gr::Tags::Shift<DataVector, 3>, tmpl::size_t<3>,
90 : Frame::Inertial>,
91 : gr::Tags::ExtrinsicCurvature<DataVector, 3>>>;
92 : using hydro_quantities_compute = Xcts::Tags::HydroQuantitiesCompute<
93 : tmpl::list<hydro::Tags::RestMassDensity<DataVector>,
94 : hydro::Tags::SpecificEnthalpy<DataVector>,
95 : hydro::Tags::Pressure<DataVector>,
96 : hydro::Tags::SpatialVelocity<DataVector, 3>,
97 : hydro::Tags::LorentzFactor<DataVector>,
98 : hydro::Tags::MagneticField<DataVector, 3>>>;
99 : using error_compute = ::Tags::ErrorsCompute<analytic_solution_fields>;
100 : using error_tags = db::wrap_tags_in<Tags::Error, analytic_solution_fields>;
101 : using observe_fields = tmpl::append<
102 : analytic_solution_fields, typename system::background_fields,
103 : typename spacetime_quantities_compute::tags_list,
104 : typename hydro_quantities_compute::tags_list, error_tags,
105 : typename solver::observe_fields,
106 : tmpl::list<domain::Tags::Coordinates<volume_dim, Frame::Inertial>,
107 : domain::Tags::RadiallyCompressedCoordinatesCompute<
108 : volume_dim, Frame::Inertial>,
109 : ::Tags::NonEuclideanMagnitude<
110 : Xcts::Tags::ShiftExcess<DataVector, 3, Frame::Inertial>,
111 : gr::Tags::SpatialMetric<DataVector, 3>>,
112 : hydro::Tags::LowerSpatialFourVelocityCompute>>;
113 : using observer_compute_tags = tmpl::list<
114 : ::Events::Tags::ObserverMeshCompute<volume_dim>,
115 : ::Events::Tags::ObserverDetInvJacobianCompute<Frame::ElementLogical,
116 : Frame::Inertial>,
117 : spacetime_quantities_compute, hydro_quantities_compute, error_compute>;
118 :
119 : // Collect all items to store in the cache.
120 : using const_global_cache_tags =
121 : tmpl::list<domain::Tags::RadiallyCompressedCoordinatesOptions>;
122 :
123 : struct factory_creation
124 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
125 : using analytic_solutions_and_data = tmpl::push_back<
126 : Xcts::Solutions::all_analytic_solutions,
127 : Xcts::AnalyticData::KerrSchildTeukolsky,
128 : Xcts::AnalyticData::Binary<elliptic::analytic_data::AnalyticSolution,
129 : Xcts::Solutions::all_analytic_solutions>,
130 : elliptic::analytic_data::NumericData>;
131 :
132 : using factory_classes = tmpl::map<
133 : tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
134 : tmpl::pair<elliptic::analytic_data::Background,
135 : analytic_solutions_and_data>,
136 : tmpl::pair<elliptic::analytic_data::InitialGuess,
137 : analytic_solutions_and_data>,
138 : tmpl::pair<elliptic::analytic_data::AnalyticSolution,
139 : Xcts::Solutions::all_analytic_solutions>,
140 : tmpl::pair<
141 : elliptic::BoundaryConditions::BoundaryCondition<volume_dim>,
142 : Xcts::BoundaryConditions::standard_boundary_conditions<system>>,
143 : tmpl::pair<::amr::Criterion,
144 : ::amr::Criteria::standard_criteria<
145 : volume_dim, typename system::primal_fields>>,
146 : tmpl::pair<Event,
147 : tmpl::flatten<tmpl::list<
148 : Events::Completion,
149 : Events::ObserveAdmIntegrals<::amr::Tags::IsFinestGrid>,
150 : dg::Events::field_observations<
151 : volume_dim, observe_fields, observer_compute_tags,
152 : ::amr::Tags::IsFinestGrid>>>>,
153 : tmpl::pair<Trigger, elliptic::Triggers::all_triggers<
154 : ::amr::OptionTags::AmrGroup>>,
155 : tmpl::pair<
156 : PhaseChange,
157 : tmpl::list<
158 : PhaseControl::VisitAndReturn<
159 : Parallel::Phase::EvaluateAmrCriteria>,
160 : PhaseControl::VisitAndReturn<Parallel::Phase::AdjustDomain>,
161 : PhaseControl::VisitAndReturn<Parallel::Phase::UpdateSections>,
162 : PhaseControl::VisitAndReturn<Parallel::Phase::CheckDomain>>>,
163 : tmpl::pair<
164 : grmhd::AnalyticData::InitialMagneticFields::InitialMagneticField,
165 : grmhd::AnalyticData::InitialMagneticFields::
166 : initial_magnetic_fields>>;
167 : };
168 :
169 : // Collect all reduction tags for observers
170 : using observed_reduction_data_tags =
171 : observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
172 : tmpl::at<factory_creation::factory_classes, Event>, solver>>>;
173 :
174 : using initialization_actions =
175 : tmpl::push_back<typename solver::initialization_actions,
176 : Parallel::Actions::TerminatePhase>;
177 :
178 : using register_actions =
179 : tmpl::push_back<typename solver::register_actions,
180 : observers::Actions::RegisterEventsWithObservers>;
181 :
182 : using solve_actions = typename solver::template solve_actions<tmpl::list<>>;
183 :
184 : using dg_element_array = elliptic::DgElementArray<
185 : Metavariables,
186 : tmpl::list<Parallel::PhaseActions<Parallel::Phase::Initialization,
187 : initialization_actions>,
188 : Parallel::PhaseActions<
189 : Parallel::Phase::Register,
190 : tmpl::push_back<register_actions,
191 : Parallel::Actions::TerminatePhase>>,
192 : Parallel::PhaseActions<
193 : Parallel::Phase::Restart,
194 : tmpl::push_back<register_actions,
195 : Parallel::Actions::TerminatePhase>>,
196 : Parallel::PhaseActions<Parallel::Phase::Solve, solve_actions>,
197 : Parallel::PhaseActions<
198 : Parallel::Phase::CheckDomain,
199 : tmpl::list<::amr::Actions::SendAmrDiagnostics,
200 : Parallel::Actions::TerminatePhase>>>,
201 : LinearSolver::multigrid::ElementsAllocator<
202 : volume_dim, typename solver::multigrid::options_group>>;
203 :
204 : struct amr : tt::ConformsTo<::amr::protocols::AmrMetavariables> {
205 : using element_array = dg_element_array;
206 : using projectors = typename solver::amr_projectors;
207 : static constexpr bool keep_coarse_grids = true;
208 : static constexpr bool p_refine_only_in_event = false;
209 : };
210 :
211 : struct registration
212 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
213 : using element_registrars =
214 : tmpl::map<tmpl::pair<dg_element_array, register_actions>>;
215 : };
216 :
217 : // Specify all parallel components that will execute actions at some point.
218 : using component_list = tmpl::flatten<
219 : tmpl::list<dg_element_array, typename solver::component_list,
220 : observers::Observer<Metavariables>,
221 : observers::ObserverWriter<Metavariables>>>;
222 :
223 : static constexpr std::array<Parallel::Phase, 6> default_phase_order{
224 : {Parallel::Phase::Initialization, Parallel::Phase::Register,
225 : Parallel::Phase::UpdateSections, Parallel::Phase::CheckDomain,
226 : Parallel::Phase::Solve, Parallel::Phase::Exit}};
227 :
228 : // NOLINTNEXTLINE(google-runtime-references)
229 : void pup(PUP::er& /*p*/) {}
230 : };
231 : /// \endcond
|
