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