SpECTRE Documentation Coverage Report
Current view: top level - Elliptic/Executables/Elasticity - SolveElasticity.hpp Hit Total Coverage
Commit: 1f2210958b4f38fdc0400907ee7c6d5af5111418 Lines: 0 1 0.0 %
Date: 2025-12-05 05:03:31
Legend: Lines: hit not hit

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

Generated by: LCOV version 1.14