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 "Domain/Creators/AlignedLattice.hpp"
10 : #include "Domain/RadiallyCompressedCoordinates.hpp"
11 : #include "Domain/Tags.hpp"
12 : #include "Elliptic/Actions/RunEventsAndTriggers.hpp"
13 : #include "Elliptic/BoundaryConditions/BoundaryCondition.hpp"
14 : #include "Elliptic/DiscontinuousGalerkin/DgElementArray.hpp"
15 : #include "Elliptic/Executables/Solver.hpp"
16 : #include "Elliptic/Systems/SelfForce/GeneralRelativity/Actions/InitializeEffectiveSource.hpp"
17 : #include "Elliptic/Systems/SelfForce/GeneralRelativity/AnalyticData/CircularOrbit.hpp"
18 : #include "Elliptic/Systems/SelfForce/GeneralRelativity/BoundaryConditions/Angular.hpp"
19 : #include "Elliptic/Systems/SelfForce/GeneralRelativity/BoundaryConditions/Sommerfeld.hpp"
20 : #include "Elliptic/Systems/SelfForce/GeneralRelativity/FirstOrderSystem.hpp"
21 : #include "Elliptic/Systems/SelfForce/GeneralRelativity/Tags.hpp"
22 : #include "Elliptic/Triggers/Factory.hpp"
23 : #include "IO/Observer/Actions/RegisterEvents.hpp"
24 : #include "IO/Observer/Helpers.hpp"
25 : #include "IO/Observer/ObserverComponent.hpp"
26 : #include "Options/Protocols/FactoryCreation.hpp"
27 : #include "Options/String.hpp"
28 : #include "Parallel/Phase.hpp"
29 : #include "Parallel/PhaseControl/ExecutePhaseChange.hpp"
30 : #include "Parallel/PhaseControl/VisitAndReturn.hpp"
31 : #include "Parallel/PhaseDependentActionList.hpp"
32 : #include "Parallel/Protocols/RegistrationMetavariables.hpp"
33 : #include "Parallel/Reduction.hpp"
34 : #include "ParallelAlgorithms/Actions/TerminatePhase.hpp"
35 : #include "ParallelAlgorithms/Amr/Actions/SendAmrDiagnostics.hpp"
36 : #include "ParallelAlgorithms/Amr/Criteria/Factory.hpp"
37 : #include "ParallelAlgorithms/Amr/Protocols/AmrMetavariables.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/InitialDataUtilities/AnalyticSolution.hpp"
46 : #include "PointwiseFunctions/InitialDataUtilities/Background.hpp"
47 : #include "PointwiseFunctions/InitialDataUtilities/InitialGuess.hpp"
48 : #include "PointwiseFunctions/MathFunctions/Factory.hpp"
49 : #include "Utilities/ProtocolHelpers.hpp"
50 : #include "Utilities/TMPL.hpp"
51 :
52 : /// \cond
53 : namespace PUP {
54 : class er;
55 : } // namespace PUP
56 :
57 : struct Metavariables {
58 : static constexpr Options::String help{
59 : "Find the self force for a point mass by solving a 2D elliptic "
60 : "problem."};
61 :
62 : using system = GrSelfForce::FirstOrderSystem;
63 : static constexpr size_t volume_dim = system::volume_dim;
64 : using solver = elliptic::Solver<Metavariables, volume_dim, system>;
65 :
66 : using observe_fields = tmpl::append<
67 : typename system::primal_fields, typename system::background_fields,
68 : tmpl::list<GrSelfForce::Tags::SingularField,
69 : GrSelfForce::Tags::BoyerLindquistRadius>,
70 : typename solver::observe_fields,
71 : tmpl::list<domain::Tags::Coordinates<volume_dim, Frame::Inertial>>>;
72 : using observer_compute_tags =
73 : tmpl::list<::Events::Tags::ObserverMeshCompute<volume_dim>,
74 : ::Events::Tags::ObserverDetInvJacobianCompute<
75 : Frame::ElementLogical, Frame::Inertial>>;
76 :
77 : // Collect all items to store in the cache.
78 : using const_global_cache_tags = tmpl::list<>;
79 :
80 : struct factory_creation
81 : : tt::ConformsTo<Options::protocols::FactoryCreation> {
82 : using factory_classes = tmpl::map<
83 : tmpl::pair<DomainCreator<volume_dim>,
84 : tmpl::list<domain::creators::AlignedLattice<2>>>,
85 : tmpl::pair<elliptic::analytic_data::Background,
86 : tmpl::list<GrSelfForce::AnalyticData::CircularOrbit>>,
87 : tmpl::pair<elliptic::analytic_data::InitialGuess,
88 : tmpl::list<GrSelfForce::AnalyticData::CircularOrbit>>,
89 : tmpl::pair<elliptic::analytic_data::AnalyticSolution, tmpl::list<>>,
90 : tmpl::pair<elliptic::BoundaryConditions::BoundaryCondition<volume_dim>,
91 : tmpl::list<GrSelfForce::BoundaryConditions::Angular,
92 : GrSelfForce::BoundaryConditions::Sommerfeld>>,
93 : tmpl::pair<::amr::Criterion,
94 : ::amr::Criteria::standard_criteria<
95 : volume_dim, typename system::primal_fields>>,
96 : tmpl::pair<Event,
97 : tmpl::flatten<tmpl::list<
98 : Events::Completion,
99 : dg::Events::field_observations<
100 : volume_dim, observe_fields, observer_compute_tags,
101 : amr::Tags::IsFinestGrid>>>>,
102 : tmpl::pair<Trigger, elliptic::Triggers::all_triggers<
103 : ::amr::OptionTags::AmrGroup>>,
104 : tmpl::pair<
105 : PhaseChange,
106 : tmpl::list<
107 : // Phases for AMR
108 : PhaseControl::VisitAndReturn<
109 : Parallel::Phase::EvaluateAmrCriteria>,
110 : PhaseControl::VisitAndReturn<Parallel::Phase::AdjustDomain>,
111 : PhaseControl::VisitAndReturn<Parallel::Phase::UpdateSections>,
112 : PhaseControl::VisitAndReturn<Parallel::Phase::CheckDomain>>>>;
113 : };
114 :
115 : // Collect all reduction tags for observers
116 : using observed_reduction_data_tags =
117 : observers::collect_reduction_data_tags<tmpl::push_back<
118 : tmpl::at<typename factory_creation::factory_classes, Event>, solver>>;
119 :
120 : using initialization_actions =
121 : tmpl::push_back<typename solver::initialization_actions,
122 : Parallel::Actions::TerminatePhase>;
123 :
124 : using register_actions =
125 : tmpl::push_back<typename solver::register_actions,
126 : observers::Actions::RegisterEventsWithObservers>;
127 :
128 : using solve_actions = typename solver::template solve_actions<tmpl::list<>>;
129 :
130 : using dg_element_array = elliptic::DgElementArray<
131 : Metavariables,
132 : tmpl::list<
133 : Parallel::PhaseActions<
134 : Parallel::Phase::Initialization,
135 : tmpl::replace<initialization_actions,
136 : elliptic::Actions::InitializeFixedSources<
137 : system, typename solver::background_tag>,
138 : GrSelfForce::Actions::InitializeEffectiveSource<
139 : system, typename solver::background_tag>>>,
140 : Parallel::PhaseActions<
141 : Parallel::Phase::Register,
142 : tmpl::push_back<register_actions,
143 : Parallel::Actions::TerminatePhase>>,
144 : Parallel::PhaseActions<
145 : Parallel::Phase::Restart,
146 : tmpl::push_back<register_actions,
147 : Parallel::Actions::TerminatePhase>>,
148 : Parallel::PhaseActions<Parallel::Phase::Solve, solve_actions>,
149 : Parallel::PhaseActions<
150 : Parallel::Phase::CheckDomain,
151 : tmpl::list<::amr::Actions::SendAmrDiagnostics,
152 : Parallel::Actions::TerminatePhase>>>,
153 : LinearSolver::multigrid::ElementsAllocator<
154 : volume_dim, typename solver::multigrid::options_group>>;
155 :
156 : struct amr : tt::ConformsTo<::amr::protocols::AmrMetavariables> {
157 : using element_array = dg_element_array;
158 : using projectors =
159 : tmpl::replace<typename solver::amr_projectors,
160 : elliptic::Actions::InitializeFixedSources<
161 : system, typename solver::background_tag>,
162 : GrSelfForce::Actions::InitializeEffectiveSource<
163 : system, typename solver::background_tag>>;
164 : static constexpr bool keep_coarse_grids = true;
165 : static constexpr bool p_refine_only_in_event = false;
166 : };
167 :
168 : struct registration
169 : : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
170 : using element_registrars =
171 : tmpl::map<tmpl::pair<dg_element_array, register_actions>>;
172 : };
173 :
174 : // Specify all parallel components that will execute actions at some point.
175 : using component_list = tmpl::flatten<
176 : tmpl::list<dg_element_array, typename solver::component_list,
177 : observers::Observer<Metavariables>,
178 : observers::ObserverWriter<Metavariables>>>;
179 :
180 : static constexpr std::array<Parallel::Phase, 6> default_phase_order{
181 : {Parallel::Phase::Initialization, Parallel::Phase::Register,
182 : Parallel::Phase::UpdateSections, Parallel::Phase::CheckDomain,
183 : Parallel::Phase::Solve, Parallel::Phase::Exit}};
184 :
185 : // NOLINTNEXTLINE(google-runtime-references)
186 : void pup(PUP::er& /*p*/) {}
187 : };
188 : /// \endcond
|