SolveElasticityProblem.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"
19 #include "Elliptic/Systems/Elasticity/FirstOrderSystem.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/Elasticity/BentBeam.hpp"
49 #include "PointwiseFunctions/AnalyticSolutions/Tags.hpp"
50 #include "Utilities/Blas.hpp"
51 #include "Utilities/Functional.hpp"
52 #include "Utilities/TMPL.hpp"
53 
54 namespace SolveElasticityProblem {
55 namespace OptionTags {
57  static std::string name() noexcept { return "LinearSolver"; }
58  static constexpr Options::String help =
59  "The iterative Krylov-subspace linear solver";
60 };
61 struct GmresGroup {
62  static std::string name() noexcept { return "GMRES"; }
63  static constexpr Options::String help = "Options for the GMRES linear solver";
64  using group = LinearSolverGroup;
65 };
66 } // namespace OptionTags
67 } // namespace SolveElasticityProblem
68 
69 /// \cond
70 template <typename System, typename InitialGuess, typename BoundaryConditions>
71 struct Metavariables {
72  using system = System;
73  static constexpr size_t volume_dim = system::volume_dim;
74  using initial_guess = InitialGuess;
75  using boundary_conditions = BoundaryConditions;
76 
77  static constexpr Options::String help{
78  "Find the solution to a linear elasticity problem."};
79 
80  using fluxes_computer_tag =
82 
83  // Only Dirichlet boundary conditions are currently supported, and they are
84  // are all imposed by analytic solutions right now.
85  // We will add support for Neumann boundary conditions ASAP.
86  using analytic_solution = boundary_conditions;
87  using analytic_solution_tag = Tags::AnalyticSolution<analytic_solution>;
88 
89  // We retrieve the constitutive relation from the analytic solution
90  using constitutive_relation_type =
91  typename analytic_solution::constitutive_relation_type;
92  using constitutive_relation_provider_option_tag =
94 
95  // The linear solver algorithm. We must use GMRES since the operator is
96  // not positive-definite for the first-order system.
97  using linear_solver =
98  LinearSolver::gmres::Gmres<Metavariables, typename system::fields_tag,
100  false>;
101  using linear_solver_iteration_id =
103  // For the GMRES linear solver we need to apply the DG operator to its
104  // internal "operand" in every iteration of the algorithm.
105  using linear_operand_tag = db::add_tag_prefix<LinearSolver::Tags::Operand,
106  typename system::fields_tag>;
107  using primal_variables = db::wrap_tags_in<LinearSolver::Tags::Operand,
108  typename system::primal_fields>;
109  using auxiliary_variables =
111  typename system::auxiliary_fields>;
112 
113  // Parse numerical flux parameters from the input file to store in the cache.
114  using normal_dot_numerical_flux = Tags::NumericalFlux<
116  volume_dim, fluxes_computer_tag, primal_variables,
117  auxiliary_variables>>;
118  // Specify the DG boundary scheme. We use the strong first-order scheme here
119  // that only requires us to compute normals dotted into the first-order
120  // fluxes.
121  using boundary_scheme =
122  dg::FirstOrderScheme::FirstOrderScheme<volume_dim, linear_operand_tag,
123  normal_dot_numerical_flux,
124  linear_solver_iteration_id>;
125 
126  // Collect events and triggers
127  // (public for use by the Charm++ registration code)
128  using observe_fields = typename system::fields_tag::tags_list;
129  using analytic_solution_fields = observe_fields;
130  using events =
132  volume_dim, linear_solver_iteration_id, observe_fields,
133  analytic_solution_fields>,
135  linear_solver_iteration_id, analytic_solution_fields>>;
136  using triggers = tmpl::list<elliptic::Triggers::Registrars::EveryNIterations<
137  linear_solver_iteration_id>>;
138 
139  // Collect all items to store in the cache.
140  using const_global_cache_tags = tmpl::list<
141  analytic_solution_tag, fluxes_computer_tag, normal_dot_numerical_flux,
144 
145  // Collect all reduction tags for observers
146  using observed_reduction_data_tags =
147  observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
148  typename Event<events>::creatable_classes, linear_solver>>>;
149 
150  // Specify all global synchronization points.
151  enum class Phase { Initialization, RegisterWithObserver, Solve, Exit };
152 
153  using initialization_actions = tmpl::list<
161  typename linear_solver::initialize_element,
163  elliptic::Actions::InitializeAnalyticSolution<analytic_solution_tag,
164  analytic_solution_fields>,
166  Metavariables>,
169  volume_dim, typename system::fluxes, typename system::sources,
170  linear_operand_tag, primal_variables, auxiliary_variables>,
172 
173  using build_linear_operator_actions = tmpl::list<
179  linear_operand_tag>>,
181  linear_operand_tag, primal_variables>,
183  boundary_scheme,
187 
188  using register_actions =
190  // We prepare the linear solve here to avoid adding an extra
191  // phase. We can't do that before registration because the
192  // `prepare_solve` action may contribute to observers.
193  typename linear_solver::prepare_solve,
195 
196  using solve_actions = tmpl::list<Actions::RunEventsAndTriggers,
198  typename linear_solver::options_group>,
199  typename linear_solver::prepare_step,
200  build_linear_operator_actions,
201  typename linear_solver::perform_step>;
202 
203  using dg_element_array = elliptic::DgElementArray<
204  Metavariables,
205  tmpl::list<Parallel::PhaseActions<Phase, Phase::Initialization,
206  initialization_actions>,
207  Parallel::PhaseActions<Phase, Phase::RegisterWithObserver,
208  register_actions>,
210 
211  // Specify all parallel components that will execute actions at some point.
212  using component_list = tmpl::flatten<
213  tmpl::list<dg_element_array, typename linear_solver::component_list,
216 
217  // Specify the transitions between phases.
218  static Phase determine_next_phase(
219  const Phase& current_phase,
220  const Parallel::CProxy_GlobalCache<
221  Metavariables>& /*cache_proxy*/) noexcept {
222  switch (current_phase) {
223  case Phase::Initialization:
224  return Phase::RegisterWithObserver;
225  case Phase::RegisterWithObserver:
226  return Phase::Solve;
227  case Phase::Solve:
228  return Phase::Exit;
229  case Phase::Exit:
230  ERROR(
231  "Should never call determine_next_phase with the current phase "
232  "being 'Exit'");
233  default:
234  ERROR(
235  "Unknown type of phase. Did you static_cast<Phase> an integral "
236  "value?");
237  }
238  }
239 };
240 
241 static const std::vector<void (*)()> charm_init_node_funcs{
242  &setup_error_handling, &disable_openblas_multithreading,
243  &domain::creators::register_derived_with_charm,
248 static const std::vector<void (*)()> charm_init_proc_funcs{
250 /// \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
SolveElasticityProblem::OptionTags::GmresGroup
Definition: SolveElasticityProblem.hpp:61
observers::ObserverWriter
The nodegroup parallel component that is responsible for writing data to disk.
Definition: ObserverComponent.hpp:48
SolveElasticityProblem::OptionTags::LinearSolverGroup
Definition: SolveElasticityProblem.hpp:56
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
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
Elasticity::Tags::ConstitutiveRelation
The elastic material's constitutive relation.
Definition: Tags.hpp:28
dg::Initialization::exterior_compute_tags
tmpl::list< Tags... > exterior_compute_tags
Definition: InitializeInterfaces.hpp:47
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
OptionTags::AnalyticSolution
Definition: Tags.hpp:25
dg::Actions::ReceiveDataForFluxes
Receive boundary data needed for fluxes from neighbors.
Definition: FluxCommunication.hpp:177
TMPL.hpp
domain::Tags::BoundaryCoordinates
Definition: InterfaceComputeTags.hpp:250
dg::Initialization::slice_tags_to_exterior
tmpl::list< Tags... > slice_tags_to_exterior
Definition: InitializeInterfaces.hpp:37