SolvePoissonProblem.hpp
1 // 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/RegisterDerivedWithCharm.hpp"
10 #include "Domain/Tags.hpp"
11 #include "Elliptic/Actions/InitializeAnalyticSolution.hpp"
12 #include "Elliptic/Actions/InitializeSystem.hpp"
13 #include "Elliptic/DiscontinuousGalerkin/DgElementArray.hpp"
14 #include "Elliptic/DiscontinuousGalerkin/ImposeBoundaryConditions.hpp"
15 #include "Elliptic/DiscontinuousGalerkin/ImposeInhomogeneousBoundaryConditionsOnSource.hpp"
16 #include "Elliptic/DiscontinuousGalerkin/InitializeFirstOrderOperator.hpp"
17 #include "Elliptic/DiscontinuousGalerkin/NumericalFluxes/FirstOrderInternalPenalty.hpp"
18 #include "Elliptic/FirstOrderOperator.hpp"
20 #include "Elliptic/Tags.hpp"
21 #include "Elliptic/Triggers/EveryNIterations.hpp"
23 #include "IO/Observer/Actions/RegisterEvents.hpp"
24 #include "IO/Observer/Helpers.hpp"
25 #include "IO/Observer/ObserverComponent.hpp"
26 #include "NumericalAlgorithms/DiscontinuousGalerkin/BoundarySchemes/FirstOrder/FirstOrderScheme.hpp"
27 #include "NumericalAlgorithms/DiscontinuousGalerkin/Tags.hpp"
28 #include "Options/Options.hpp"
29 #include "Parallel/Actions/TerminatePhase.hpp"
30 #include "Parallel/GlobalCache.hpp"
31 #include "Parallel/InitializationFunctions.hpp"
32 #include "Parallel/PhaseDependentActionList.hpp"
33 #include "Parallel/Reduction.hpp"
35 #include "ParallelAlgorithms/Actions/MutateApply.hpp"
36 #include "ParallelAlgorithms/DiscontinuousGalerkin/CollectDataForFluxes.hpp"
37 #include "ParallelAlgorithms/DiscontinuousGalerkin/FluxCommunication.hpp"
38 #include "ParallelAlgorithms/DiscontinuousGalerkin/InitializeDomain.hpp"
39 #include "ParallelAlgorithms/DiscontinuousGalerkin/InitializeInterfaces.hpp"
40 #include "ParallelAlgorithms/DiscontinuousGalerkin/InitializeMortars.hpp"
41 #include "ParallelAlgorithms/Events/ObserveErrorNorms.hpp"
42 #include "ParallelAlgorithms/Events/ObserveFields.hpp"
43 #include "ParallelAlgorithms/EventsAndTriggers/Actions/RunEventsAndTriggers.hpp"
44 #include "ParallelAlgorithms/Initialization/Actions/RemoveOptionsAndTerminatePhase.hpp"
45 #include "ParallelAlgorithms/LinearSolver/Actions/TerminateIfConverged.hpp"
46 #include "ParallelAlgorithms/LinearSolver/Gmres/Gmres.hpp"
48 #include "PointwiseFunctions/AnalyticSolutions/Poisson/Lorentzian.hpp"
49 #include "PointwiseFunctions/AnalyticSolutions/Poisson/Moustache.hpp"
50 #include "PointwiseFunctions/AnalyticSolutions/Poisson/ProductOfSinusoids.hpp"
51 #include "PointwiseFunctions/AnalyticSolutions/Tags.hpp"
52 #include "Utilities/Blas.hpp"
53 #include "Utilities/Functional.hpp"
54 #include "Utilities/TMPL.hpp"
55 
56 namespace SolvePoissonProblem {
57 namespace OptionTags {
59  static std::string name() noexcept { return "LinearSolver"; }
60  static constexpr Options::String help =
61  "The iterative Krylov-subspace linear solver";
62 };
63 struct GmresGroup {
64  static std::string name() noexcept { return "GMRES"; }
65  static constexpr Options::String help = "Options for the GMRES linear solver";
66  using group = LinearSolverGroup;
67 };
68 } // namespace OptionTags
69 } // namespace SolvePoissonProblem
70 
71 /// \cond
72 template <typename System, typename InitialGuess, typename BoundaryConditions>
73 struct Metavariables {
74  using system = System;
75  static constexpr size_t volume_dim = system::volume_dim;
76  using initial_guess = InitialGuess;
77  using boundary_conditions = BoundaryConditions;
78 
79  static constexpr Options::String help{
80  "Find the solution to a Poisson problem."};
81 
82  using fluxes_computer_tag =
84 
85  // Only Dirichlet boundary conditions are currently supported, and they are
86  // are all imposed by analytic solutions right now.
87  // This will be generalized ASAP. We will also support numeric initial guesses
88  // and analytic initial guesses that aren't solutions ("analytic data").
89  using analytic_solution_tag = Tags::AnalyticSolution<boundary_conditions>;
90 
91  // The linear solver algorithm. We must use GMRES since the operator is
92  // not positive-definite for the first-order system.
93  using linear_solver = LinearSolver::gmres::Gmres<
94  Metavariables, typename system::fields_tag,
96  using linear_solver_iteration_id =
98  // For the GMRES linear solver we need to apply the DG operator to its
99  // internal "operand" in every iteration of the algorithm.
100  using linear_operand_tag = db::add_tag_prefix<LinearSolver::Tags::Operand,
101  typename system::fields_tag>;
102  using primal_variables = db::wrap_tags_in<LinearSolver::Tags::Operand,
103  typename system::primal_fields>;
104  using auxiliary_variables =
106  typename system::auxiliary_fields>;
107 
108  // Parse numerical flux parameters from the input file to store in the cache.
109  using normal_dot_numerical_flux = Tags::NumericalFlux<
111  volume_dim, fluxes_computer_tag, primal_variables,
112  auxiliary_variables>>;
113  // Specify the DG boundary scheme. We use the strong first-order scheme here
114  // that only requires us to compute normals dotted into the first-order
115  // fluxes.
116  using boundary_scheme =
117  dg::FirstOrderScheme::FirstOrderScheme<volume_dim, linear_operand_tag,
118  normal_dot_numerical_flux,
119  linear_solver_iteration_id>;
120 
121  // Collect events and triggers
122  // (public for use by the Charm++ registration code)
123  using observe_fields = typename system::fields_tag::tags_list;
124  using analytic_solution_fields = observe_fields;
125  using events =
127  volume_dim, linear_solver_iteration_id, observe_fields,
128  analytic_solution_fields>,
130  linear_solver_iteration_id, analytic_solution_fields>>;
131  using triggers = tmpl::list<elliptic::Triggers::Registrars::EveryNIterations<
132  linear_solver_iteration_id>>;
133 
134  // Collect all items to store in the cache.
135  using const_global_cache_tags =
136  tmpl::list<analytic_solution_tag, fluxes_computer_tag,
137  normal_dot_numerical_flux,
139 
140  // Collect all reduction tags for observers
141  using observed_reduction_data_tags =
142  observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
143  typename Event<events>::creatable_classes, linear_solver>>>;
144 
145  // Specify all global synchronization points.
146  enum class Phase { Initialization, RegisterWithObserver, Solve, Exit };
147 
148  using initialization_actions = tmpl::list<
155  typename linear_solver::initialize_element,
157  elliptic::Actions::InitializeAnalyticSolution<analytic_solution_tag,
158  analytic_solution_fields>,
160  Metavariables>,
163  volume_dim, typename system::fluxes, typename system::sources,
164  linear_operand_tag, primal_variables, auxiliary_variables>,
166 
167  using build_linear_operator_actions = tmpl::list<
173  linear_operand_tag>>,
175  linear_operand_tag, primal_variables>,
177  boundary_scheme,
181 
182  using register_actions =
184  // We prepare the linear solve here to avoid adding an extra
185  // phase. We can't do that before registration because the
186  // `prepare_solve` action may contribute to observers.
187  typename linear_solver::prepare_solve,
189 
190  using solve_actions = tmpl::list<Actions::RunEventsAndTriggers,
192  typename linear_solver::options_group>,
193  typename linear_solver::prepare_step,
194  build_linear_operator_actions,
195  typename linear_solver::perform_step>;
196 
197  using dg_element_array = elliptic::DgElementArray<
198  Metavariables,
199  tmpl::list<Parallel::PhaseActions<Phase, Phase::Initialization,
200  initialization_actions>,
201  Parallel::PhaseActions<Phase, Phase::RegisterWithObserver,
202  register_actions>,
204 
205  // Specify all parallel components that will execute actions at some point.
206  using component_list = tmpl::flatten<
207  tmpl::list<dg_element_array, typename linear_solver::component_list,
210 
211  // Specify the transitions between phases.
212  static Phase determine_next_phase(
213  const Phase& current_phase,
214  const Parallel::CProxy_GlobalCache<
215  Metavariables>& /*cache_proxy*/) noexcept {
216  switch (current_phase) {
217  case Phase::Initialization:
218  return Phase::RegisterWithObserver;
219  case Phase::RegisterWithObserver:
220  return Phase::Solve;
221  case Phase::Solve:
222  return Phase::Exit;
223  case Phase::Exit:
224  ERROR(
225  "Should never call determine_next_phase with the current phase "
226  "being 'Exit'");
227  default:
228  ERROR(
229  "Unknown type of phase. Did you static_cast<Phase> an integral "
230  "value?");
231  }
232  }
233 };
234 
235 static const std::vector<void (*)()> charm_init_node_funcs{
236  &setup_error_handling, &disable_openblas_multithreading,
237  &domain::creators::register_derived_with_charm,
242 static const std::vector<void (*)()> charm_init_proc_funcs{
244 /// \endcond
FloatingPointExceptions.hpp
elliptic::Actions::InitializeSystem
Initializes the DataBox tags related to the elliptic system.
Definition: InitializeSystem.hpp:47
RegisterDerivedClassesWithCharm.hpp
LinearSolver::Actions::TerminateIfConverged
Terminate the algorithm if the linear solver has converged.
Definition: TerminateIfConverged.hpp:33
LinearSolver::gmres::Gmres
A GMRES solver for nonsymmetric linear systems of equations .
Definition: Gmres.hpp:80
std::string
observers::Actions::RegisterEventsWithObservers
Registers this element of a parallel component with the local Observer parallel component for each tr...
Definition: RegisterEvents.hpp:98
elliptic::dg::Actions::ImposeInhomogeneousBoundaryConditionsOnSource
Adds boundary contributions to the sources.
Definition: ImposeInhomogeneousBoundaryConditionsOnSource.hpp:72
LinearSolver::Tags::OperatorAppliedTo
The linear operator applied to the data in Tag
Definition: Tags.hpp:70
GlobalCache.hpp
Options.hpp
LinearSolver::Tags::Operand
The operand that the local linear operator is applied to.
Definition: Tags.hpp:57
Tags.hpp
std::vector
std::system
T system(T... args)
elliptic::Actions::InitializeAnalyticSolution
Place the analytic solution of the system fields in the DataBox.
Definition: InitializeAnalyticSolution.hpp:46
LinearSolver::Tags::IterationId
Holds an IterationId that identifies a step in the linear solver algorithm.
Definition: Tags.hpp:84
db::add_tag_prefix
typename detail::add_tag_prefix_impl< Prefix, Tag, Args... >::type add_tag_prefix
Definition: PrefixHelpers.hpp:52
dg::Actions::SendDataForFluxes
Send local boundary data needed for fluxes to neighbors.
Definition: FluxCommunication.hpp:79
Initialization::Actions::RemoveOptionsAndTerminatePhase
Definition: RemoveOptionsAndTerminatePhase.hpp:27
dg::Initialization::face_compute_tags
tmpl::list< Tags... > face_compute_tags
Definition: InitializeInterfaces.hpp:42
Parallel::Actions::TerminatePhase
Terminate the algorithm to proceed to the next phase.
Definition: TerminatePhase.hpp:26
Tags::NumericalFlux
The global cache tag for the numerical flux.
Definition: Tags.hpp:85
dg::Initialization::slice_tags_to_face
tmpl::list< Tags... > slice_tags_to_face
Definition: InitializeInterfaces.hpp:32
disable_openblas_multithreading
void disable_openblas_multithreading() noexcept
Disable OpenBLAS multithreading since it conflicts with Charm++ parallelism.
Definition: Blas.cpp:15
domain::Tags::BoundaryDirectionsInterior
Definition: Tags.hpp:262
Tags.hpp
Registration::Registrar
A template for defining a registrar.
Definition: Registration.hpp:42
elliptic::FirstOrderOperator
Mutating DataBox invokable to compute the bulk contribution to the operator represented by the Operat...
Definition: FirstOrderOperator.hpp:201
enable_floating_point_exceptions
void enable_floating_point_exceptions()
Definition: FloatingPointExceptions.cpp:27
ERROR
#define ERROR(m)
prints an error message to the standard error stream and aborts the program.
Definition: Error.hpp:36
Parallel::PhaseActions
List of all the actions to be executed in the specified phase.
Definition: PhaseDependentActionList.hpp:16
observers::ObserverWriter
The nodegroup parallel component that is responsible for writing data to disk.
Definition: ObserverComponent.hpp:48
dg::Actions::InitializeInterfaces
Initialize items related to the interfaces between Elements and on external boundaries.
Definition: InitializeInterfaces.hpp:106
Event
Definition: Event.hpp:30
elliptic::DgElementArray
The parallel component responsible for managing the DG elements that compose the computational domain...
Definition: DgElementArray.hpp:37
dg::Actions::InitializeDomain
Initialize items related to the basic structure of the element.
Definition: InitializeDomain.hpp:64
FirstOrderSystem.hpp
cstddef
Actions::RunEventsAndTriggers
Run the events and triggers.
Definition: RunEventsAndTriggers.hpp:27
Actions::MutateApply
Apply the function Mutator::apply to the DataBox.
Definition: MutateApply.hpp:40
elliptic::Tags::FluxesComputer
Holds an object that computes the principal part of the elliptic PDEs.
Definition: Tags.hpp:27
Tags::AnalyticSolution
Definition: Tags.hpp:54
observers::Observer
The group parallel component that is responsible for reducing data to be observed.
Definition: ObserverComponent.hpp:27
Trigger
Definition: Trigger.hpp:34
dg::Actions::InitializeMortars
Initialize mortars between elements for exchanging fluxes.
Definition: InitializeMortars.hpp:75
dg::Actions::CollectDataForFluxes
Collect data that is needed to compute numerical fluxes and store it on mortars, projecting it if nec...
Definition: CollectDataForFluxes.hpp:68
dg::Events::Registrars::ObserveFields
Definition: ObserveFields.hpp:62
elliptic::dg::NumericalFluxes::FirstOrderInternalPenalty
The internal penalty flux for first-order elliptic equations.
Definition: FirstOrderInternalPenalty.hpp:168
Tags::EventsAndTriggers
Definition: Tags.hpp:57
dg::Initialization::exterior_compute_tags
tmpl::list< Tags... > exterior_compute_tags
Definition: InitializeInterfaces.hpp:47
SolvePoissonProblem::OptionTags::LinearSolverGroup
Definition: SolvePoissonProblem.hpp:58
Options::String
const char *const String
The string used in option structs.
Definition: Options.hpp:32
dg::FirstOrderScheme::FirstOrderScheme
Boundary contributions for a first-order DG scheme.
Definition: FirstOrderScheme.hpp:67
domain::Tags::InternalDirections
Definition: Tags.hpp:235
db::wrap_tags_in
tmpl::transform< TagList, tmpl::bind< Wrapper, tmpl::_1, tmpl::pin< Args >... > > wrap_tags_in
Create a new list of Tags by wrapping each tag in TagList using the Wrapper.
Definition: PrefixHelpers.hpp:30
Parallel::register_derived_classes_with_charm
void register_derived_classes_with_charm() noexcept
Register derived classes of the Base class.
Definition: RegisterDerivedClassesWithCharm.hpp:31
Blas.hpp
elliptic::dg::Actions::ImposeHomogeneousDirichletBoundaryConditions
Set field data on external boundaries so that they represent homogeneous (zero) Dirichlet boundary co...
Definition: ImposeBoundaryConditions.hpp:91
elliptic::dg::Actions::InitializeFirstOrderOperator
Initialize DataBox tags for building the first-order elliptic DG operator.
Definition: InitializeFirstOrderOperator.hpp:45
dg::Actions::ReceiveDataForFluxes
Receive boundary data needed for fluxes from neighbors.
Definition: FluxCommunication.hpp:177
TMPL.hpp
SolvePoissonProblem::OptionTags::GmresGroup
Definition: SolvePoissonProblem.hpp:63
dg::Initialization::slice_tags_to_exterior
tmpl::list< Tags... > slice_tags_to_exterior
Definition: InitializeInterfaces.hpp:37