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