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             : #include <cstdint>
       8             : #include <vector>
       9             : 
      10             : #include "Domain/Creators/Factory1D.hpp"
      11             : #include "Domain/Tags.hpp"
      12             : #include "Evolution/Actions/RunEventsAndDenseTriggers.hpp"
      13             : #include "Evolution/Actions/RunEventsAndTriggers.hpp"
      14             : #include "Evolution/ComputeTags.hpp"
      15             : #include "Evolution/DgSubcell/Actions/Initialize.hpp"
      16             : #include "Evolution/DgSubcell/Actions/Labels.hpp"
      17             : #include "Evolution/DgSubcell/Actions/ReconstructionCommunication.hpp"
      18             : #include "Evolution/DgSubcell/Actions/SelectNumericalMethod.hpp"
      19             : #include "Evolution/DgSubcell/Actions/TakeTimeStep.hpp"
      20             : #include "Evolution/DgSubcell/Actions/TciAndRollback.hpp"
      21             : #include "Evolution/DgSubcell/Actions/TciAndSwitchToDg.hpp"
      22             : #include "Evolution/DgSubcell/GetTciDecision.hpp"
      23             : #include "Evolution/DgSubcell/NeighborReconstructedFaceSolution.hpp"
      24             : #include "Evolution/DgSubcell/NeighborTciDecision.hpp"
      25             : #include "Evolution/DgSubcell/PrepareNeighborData.hpp"
      26             : #include "Evolution/DgSubcell/Tags/ObserverCoordinates.hpp"
      27             : #include "Evolution/DgSubcell/Tags/ObserverMesh.hpp"
      28             : #include "Evolution/DgSubcell/Tags/TciStatus.hpp"
      29             : #include "Evolution/DiscontinuousGalerkin/Actions/ApplyBoundaryCorrections.hpp"
      30             : #include "Evolution/DiscontinuousGalerkin/Actions/ComputeTimeDerivative.hpp"
      31             : #include "Evolution/DiscontinuousGalerkin/DgElementArray.hpp"
      32             : #include "Evolution/DiscontinuousGalerkin/Initialization/Mortars.hpp"
      33             : #include "Evolution/DiscontinuousGalerkin/Initialization/QuadratureTag.hpp"
      34             : #include "Evolution/DiscontinuousGalerkin/Limiters/Minmod.hpp"
      35             : #include "Evolution/DiscontinuousGalerkin/Limiters/Tags.hpp"
      36             : #include "Evolution/Initialization/ConservativeSystem.hpp"
      37             : #include "Evolution/Initialization/DgDomain.hpp"
      38             : #include "Evolution/Initialization/Evolution.hpp"
      39             : #include "Evolution/Initialization/Limiter.hpp"
      40             : #include "Evolution/Initialization/SetVariables.hpp"
      41             : #include "Evolution/Systems/Burgers/BoundaryConditions/Factory.hpp"
      42             : #include "Evolution/Systems/Burgers/BoundaryCorrections/Factory.hpp"
      43             : #include "Evolution/Systems/Burgers/FiniteDifference/Factory.hpp"
      44             : #include "Evolution/Systems/Burgers/FiniteDifference/Tags.hpp"
      45             : #include "Evolution/Systems/Burgers/Subcell/GhostData.hpp"
      46             : #include "Evolution/Systems/Burgers/Subcell/NeighborPackagedData.hpp"
      47             : #include "Evolution/Systems/Burgers/Subcell/SetInitialRdmpData.hpp"
      48             : #include "Evolution/Systems/Burgers/Subcell/TciOnDgGrid.hpp"
      49             : #include "Evolution/Systems/Burgers/Subcell/TciOnFdGrid.hpp"
      50             : #include "Evolution/Systems/Burgers/Subcell/TimeDerivative.hpp"
      51             : #include "Evolution/Systems/Burgers/System.hpp"
      52             : #include "IO/Observer/Actions/RegisterEvents.hpp"
      53             : #include "IO/Observer/Helpers.hpp"
      54             : #include "IO/Observer/ObserverComponent.hpp"
      55             : #include "NumericalAlgorithms/DiscontinuousGalerkin/Formulation.hpp"
      56             : #include "NumericalAlgorithms/DiscontinuousGalerkin/Tags.hpp"
      57             : #include "Options/Protocols/FactoryCreation.hpp"
      58             : #include "Options/String.hpp"
      59             : #include "Parallel/Local.hpp"
      60             : #include "Parallel/Phase.hpp"
      61             : #include "Parallel/PhaseControl/CheckpointAndExitAfterWallclock.hpp"
      62             : #include "Parallel/PhaseControl/ExecutePhaseChange.hpp"
      63             : #include "Parallel/PhaseControl/Factory.hpp"
      64             : #include "Parallel/PhaseControl/VisitAndReturn.hpp"
      65             : #include "Parallel/PhaseDependentActionList.hpp"
      66             : #include "Parallel/Protocols/RegistrationMetavariables.hpp"
      67             : #include "ParallelAlgorithms/Actions/AddComputeTags.hpp"
      68             : #include "ParallelAlgorithms/Actions/InitializeItems.hpp"
      69             : #include "ParallelAlgorithms/Actions/LimiterActions.hpp"
      70             : #include "ParallelAlgorithms/Actions/MutateApply.hpp"
      71             : #include "ParallelAlgorithms/Actions/TerminatePhase.hpp"
      72             : #include "ParallelAlgorithms/Events/Factory.hpp"
      73             : #include "ParallelAlgorithms/Events/Tags.hpp"
      74             : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTrigger.hpp"
      75             : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTriggers/Factory.hpp"
      76             : #include "ParallelAlgorithms/EventsAndTriggers/Completion.hpp"
      77             : #include "ParallelAlgorithms/EventsAndTriggers/Event.hpp"
      78             : #include "ParallelAlgorithms/EventsAndTriggers/EventsAndTriggers.hpp"
      79             : #include "ParallelAlgorithms/EventsAndTriggers/LogicalTriggers.hpp"
      80             : #include "ParallelAlgorithms/EventsAndTriggers/Trigger.hpp"
      81             : #include "PointwiseFunctions/AnalyticData/AnalyticData.hpp"
      82             : #include "PointwiseFunctions/AnalyticData/Burgers/Factory.hpp"
      83             : #include "PointwiseFunctions/AnalyticData/Burgers/Sinusoid.hpp"
      84             : #include "PointwiseFunctions/AnalyticSolutions/AnalyticSolution.hpp"
      85             : #include "PointwiseFunctions/AnalyticSolutions/Burgers/Bump.hpp"
      86             : #include "PointwiseFunctions/AnalyticSolutions/Burgers/Factory.hpp"
      87             : #include "PointwiseFunctions/AnalyticSolutions/Burgers/Linear.hpp"
      88             : #include "PointwiseFunctions/AnalyticSolutions/Burgers/Step.hpp"
      89             : #include "PointwiseFunctions/AnalyticSolutions/Tags.hpp"
      90             : #include "Time/Actions/AdvanceTime.hpp"
      91             : #include "Time/Actions/RecordTimeStepperData.hpp"
      92             : #include "Time/Actions/SelfStartActions.hpp"
      93             : #include "Time/Actions/UpdateU.hpp"
      94             : #include "Time/ChangeSlabSize/Action.hpp"
      95             : #include "Time/StepChoosers/Factory.hpp"
      96             : #include "Time/StepChoosers/StepChooser.hpp"
      97             : #include "Time/Tags/Time.hpp"
      98             : #include "Time/Tags/TimeStepId.hpp"
      99             : #include "Time/TimeSequence.hpp"
     100             : #include "Time/TimeSteppers/Factory.hpp"
     101             : #include "Time/TimeSteppers/LtsTimeStepper.hpp"
     102             : #include "Time/TimeSteppers/TimeStepper.hpp"
     103             : #include "Time/Triggers/TimeTriggers.hpp"
     104             : #include "Utilities/ProtocolHelpers.hpp"
     105             : #include "Utilities/TMPL.hpp"
     106             : 
     107             : // IWYU pragma: no_include <pup.h>
     108             : 
     109             : /// \cond
     110             : namespace PUP {
     111             : class er;
     112             : }  // namespace PUP
     113             : namespace Parallel {
     114             : template <typename Metavariables>
     115             : class CProxy_GlobalCache;
     116             : }  // namespace Parallel
     117             : /// \endcond
     118             : 
     119           0 : struct EvolutionMetavars {
     120           0 :   static constexpr size_t volume_dim = 1;
     121           0 :   using system = Burgers::System;
     122           0 :   using temporal_id = Tags::TimeStepId;
     123           0 :   using TimeStepperBase = TimeStepper;
     124             : 
     125           0 :   static constexpr bool local_time_stepping =
     126             :       TimeStepperBase::local_time_stepping;
     127             : 
     128             :   // The use_dg_subcell flag controls whether to use "standard" limiting (false)
     129             :   // or a DG-FD hybrid scheme (true).
     130           0 :   static constexpr bool use_dg_subcell = true;
     131             : 
     132           0 :   using initial_data_list = tmpl::append<Burgers::Solutions::all_solutions,
     133             :                                          Burgers::AnalyticData::all_data>;
     134             : 
     135           0 :   using limiter =
     136             :       Tags::Limiter<Limiters::Minmod<1, system::variables_tag::tags_list>>;
     137             : 
     138           0 :   using analytic_variables_tags = typename system::variables_tag::tags_list;
     139           0 :   using analytic_compute = evolution::Tags::AnalyticSolutionsCompute<
     140             :       volume_dim, analytic_variables_tags, use_dg_subcell, initial_data_list>;
     141           0 :   using error_compute = Tags::ErrorsCompute<analytic_variables_tags>;
     142           0 :   using error_tags = db::wrap_tags_in<Tags::Error, analytic_variables_tags>;
     143           0 :   using observe_fields = tmpl::push_back<
     144             :       tmpl::append<
     145             :           typename system::variables_tag::tags_list, error_tags,
     146             :           tmpl::conditional_t<use_dg_subcell,
     147             :                               tmpl::list<evolution::dg::subcell::Tags::
     148             :                                              TciStatusCompute<volume_dim>>,
     149             :                               tmpl::list<>>>,
     150             :       ::Events::Tags::ObserverDetInvJacobianCompute<Frame::ElementLogical,
     151             :                                                     Frame::Inertial>,
     152             :       tmpl::conditional_t<
     153             :           use_dg_subcell,
     154             :           evolution::dg::subcell::Tags::ObserverCoordinatesCompute<volume_dim,
     155             :                                                                    Frame::Grid>,
     156             :           domain::Tags::Coordinates<volume_dim, Frame::Grid>>,
     157             :       tmpl::conditional_t<
     158             :           use_dg_subcell,
     159             :           evolution::dg::subcell::Tags::ObserverCoordinatesCompute<
     160             :               volume_dim, Frame::Inertial>,
     161             :           domain::Tags::Coordinates<volume_dim, Frame::Inertial>>>;
     162           0 :   using non_tensor_compute_tags = tmpl::list<
     163             :       tmpl::conditional_t<
     164             :           use_dg_subcell,
     165             :           evolution::dg::subcell::Tags::ObserverMeshCompute<volume_dim>,
     166             :           ::Events::Tags::ObserverMeshCompute<volume_dim>>,
     167             :       analytic_compute, error_compute>;
     168             : 
     169           0 :   struct factory_creation
     170             :       : tt::ConformsTo<Options::protocols::FactoryCreation> {
     171           0 :     using factory_classes = tmpl::map<
     172             :         tmpl::pair<Burgers::BoundaryConditions::BoundaryCondition,
     173             :                    Burgers::BoundaryConditions::standard_boundary_conditions>,
     174             :         tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
     175             :         tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
     176             :         tmpl::pair<Event,
     177             :                    tmpl::flatten<tmpl::list<
     178             :                        Events::Completion,
     179             :                        dg::Events::field_observations<
     180             :                            volume_dim, observe_fields, non_tensor_compute_tags>,
     181             :                        Events::time_events<system>>>>,
     182             :         tmpl::pair<evolution::initial_data::InitialData, initial_data_list>,
     183             :         tmpl::pair<PhaseChange, PhaseControl::factory_creatable_classes>,
     184             :         tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
     185             :                    StepChoosers::standard_step_choosers<system>>,
     186             :         tmpl::pair<
     187             :             StepChooser<StepChooserUse::Slab>,
     188             :             StepChoosers::standard_slab_choosers<system, local_time_stepping>>,
     189             :         tmpl::pair<TimeSequence<double>,
     190             :                    TimeSequences::all_time_sequences<double>>,
     191             :         tmpl::pair<TimeSequence<std::uint64_t>,
     192             :                    TimeSequences::all_time_sequences<std::uint64_t>>,
     193             :         tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
     194             :         tmpl::pair<Trigger, tmpl::append<Triggers::logical_triggers,
     195             :                                          Triggers::time_triggers>>>;
     196             :   };
     197             : 
     198           0 :   struct SubcellOptions {
     199           0 :     static constexpr bool subcell_enabled = use_dg_subcell;
     200           0 :     static constexpr bool subcell_enabled_at_external_boundary = true;
     201             : 
     202             :     // We send `ghost_zone_size` cell-centered grid points for variable
     203             :     // reconstruction, of which we need `ghost_zone_size-1` for reconstruction
     204             :     // to the internal side of the element face, and `ghost_zone_size` for
     205             :     // reconstruction to the external side of the element face.
     206             :     template <typename DbTagsList>
     207           0 :     static constexpr size_t ghost_zone_size(
     208             :         const db::DataBox<DbTagsList>& box) {
     209             :       return db::get<Burgers::fd::Tags::Reconstructor>(box).ghost_zone_size();
     210             :     }
     211             : 
     212           0 :     using DgComputeSubcellNeighborPackagedData =
     213             :         Burgers::subcell::NeighborPackagedData;
     214             : 
     215           0 :     using GhostVariables = Burgers::subcell::GhostVariables;
     216             :   };
     217             : 
     218           0 :   using observed_reduction_data_tags =
     219             :       observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
     220             :           tmpl::at<typename factory_creation::factory_classes, Event>>>>;
     221             : 
     222           0 :   using dg_step_actions = tmpl::flatten<tmpl::list<
     223             :       evolution::dg::Actions::ComputeTimeDerivative<
     224             :           volume_dim, system, AllStepChoosers, local_time_stepping>,
     225             :       tmpl::conditional_t<
     226             :           local_time_stepping,
     227             :           tmpl::list<evolution::Actions::RunEventsAndDenseTriggers<
     228             :                          tmpl::list<evolution::dg::ApplyBoundaryCorrections<
     229             :                              local_time_stepping, system, volume_dim, true>>>,
     230             :                      evolution::dg::Actions::ApplyLtsBoundaryCorrections<
     231             :                          system, volume_dim, false>>,
     232             :           tmpl::list<
     233             :               evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
     234             :                   system, volume_dim, false>,
     235             :               Actions::RecordTimeStepperData<system>,
     236             :               evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<>>,
     237             :               Actions::UpdateU<system>>>,
     238             :       Limiters::Actions::SendData<EvolutionMetavars>,
     239             :       Limiters::Actions::Limit<EvolutionMetavars>>>;
     240             : 
     241           0 :   using dg_subcell_step_actions = tmpl::flatten<tmpl::list<
     242             :       evolution::dg::subcell::Actions::SelectNumericalMethod,
     243             :       Actions::Label<evolution::dg::subcell::Actions::Labels::BeginDg>,
     244             :       evolution::dg::Actions::ComputeTimeDerivative<
     245             :           volume_dim, system, AllStepChoosers, local_time_stepping>,
     246             :       evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
     247             :           system, volume_dim, false>,
     248             :       tmpl::conditional_t<
     249             :           local_time_stepping, tmpl::list<>,
     250             :           tmpl::list<
     251             :               Actions::RecordTimeStepperData<system>,
     252             :               evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<>>,
     253             :               Actions::UpdateU<system>>>,
     254             :       evolution::dg::subcell::Actions::TciAndRollback<
     255             :           Burgers::subcell::TciOnDgGrid>,
     256             :       Actions::Goto<evolution::dg::subcell::Actions::Labels::EndOfSolvers>,
     257             :       Actions::Label<evolution::dg::subcell::Actions::Labels::BeginSubcell>,
     258             :       evolution::dg::subcell::Actions::SendDataForReconstruction<
     259             :           volume_dim, Burgers::subcell::GhostVariables, local_time_stepping>,
     260             :       evolution::dg::subcell::Actions::ReceiveDataForReconstruction<volume_dim>,
     261             :       Actions::Label<
     262             :           evolution::dg::subcell::Actions::Labels::BeginSubcellAfterDgRollback>,
     263             :       evolution::dg::subcell::fd::Actions::TakeTimeStep<
     264             :           Burgers::subcell::TimeDerivative>,
     265             :       Actions::RecordTimeStepperData<system>,
     266             :       evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<>>,
     267             :       Actions::UpdateU<system>,
     268             :       evolution::dg::subcell::Actions::TciAndSwitchToDg<
     269             :           Burgers::subcell::TciOnFdGrid>,
     270             :       Actions::Label<evolution::dg::subcell::Actions::Labels::EndOfSolvers>>>;
     271             : 
     272           0 :   using step_actions =
     273             :       tmpl::conditional_t<use_dg_subcell, dg_subcell_step_actions,
     274             :                           dg_step_actions>;
     275             : 
     276           0 :   using const_global_cache_tags = tmpl::list<
     277             :       evolution::initial_data::Tags::InitialData,
     278             :       tmpl::conditional_t<use_dg_subcell,
     279             :                           tmpl::list<Burgers::fd::Tags::Reconstructor>,
     280             :                           tmpl::list<>>>;
     281             : 
     282           0 :   using dg_registration_list =
     283             :       tmpl::list<observers::Actions::RegisterEventsWithObservers>;
     284             : 
     285           0 :   using initialization_actions = tmpl::list<
     286             :       Initialization::Actions::InitializeItems<
     287             :           Initialization::TimeStepping<EvolutionMetavars, TimeStepperBase>,
     288             :           evolution::dg::Initialization::Domain<1>,
     289             :           Initialization::TimeStepperHistory<EvolutionMetavars>>,
     290             :       Initialization::Actions::ConservativeSystem<system>,
     291             : 
     292             :       tmpl::conditional_t<
     293             :           use_dg_subcell,
     294             :           tmpl::list<
     295             :               evolution::dg::subcell::Actions::SetSubcellGrid<volume_dim,
     296             :                                                               system, false>,
     297             :               evolution::dg::subcell::Actions::SetAndCommunicateInitialRdmpData<
     298             :                   volume_dim, Burgers::subcell::SetInitialRdmpData>,
     299             :               evolution::dg::subcell::Actions::ComputeAndSendTciOnInitialGrid<
     300             :                   volume_dim, system, Burgers::subcell::TciOnFdGrid>,
     301             :               evolution::dg::subcell::Actions::SetInitialGridFromTciData<
     302             :                   volume_dim, system>>,
     303             :           tmpl::list<evolution::Initialization::Actions::SetVariables<
     304             :               domain::Tags::Coordinates<1, Frame::ElementLogical>>>>,
     305             : 
     306             :       Initialization::Actions::AddComputeTags<
     307             :           StepChoosers::step_chooser_compute_tags<EvolutionMetavars,
     308             :                                                   local_time_stepping>>,
     309             :       ::evolution::dg::Initialization::Mortars<volume_dim, system>,
     310             :       Initialization::Actions::Minmod<1>,
     311             :       evolution::Actions::InitializeRunEventsAndDenseTriggers,
     312             :       Parallel::Actions::TerminatePhase>;
     313             : 
     314           0 :   using dg_element_array = DgElementArray<
     315             :       EvolutionMetavars,
     316             :       tmpl::list<
     317             :           Parallel::PhaseActions<Parallel::Phase::Initialization,
     318             :                                  initialization_actions>,
     319             : 
     320             :           Parallel::PhaseActions<Parallel::Phase::Register,
     321             :                                  tmpl::list<dg_registration_list,
     322             :                                             Parallel::Actions::TerminatePhase>>,
     323             : 
     324             :           Parallel::PhaseActions<
     325             :               Parallel::Phase::InitializeTimeStepperHistory,
     326             :               SelfStart::self_start_procedure<step_actions, system>>,
     327             : 
     328             :           Parallel::PhaseActions<
     329             :               Parallel::Phase::Evolve,
     330             :               tmpl::list<evolution::Actions::RunEventsAndTriggers,
     331             :                          Actions::ChangeSlabSize, step_actions,
     332             :                          Actions::AdvanceTime,
     333             :                          PhaseControl::Actions::ExecutePhaseChange>>>>;
     334             : 
     335           0 :   struct registration
     336             :       : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
     337           0 :     using element_registrars =
     338             :         tmpl::map<tmpl::pair<dg_element_array, dg_registration_list>>;
     339             :   };
     340             : 
     341           0 :   using component_list =
     342             :       tmpl::list<observers::Observer<EvolutionMetavars>,
     343             :                  observers::ObserverWriter<EvolutionMetavars>,
     344             :                  dg_element_array>;
     345             : 
     346           0 :   static constexpr Options::String help{
     347             :       "Evolve the Burgers equation.\n\n"
     348             :       "The analytic solution is: Linear\n"
     349             :       "The numerical flux is:    LocalLaxFriedrichs\n"};
     350             : 
     351           0 :   static constexpr std::array<Parallel::Phase, 5> default_phase_order{
     352             :       {Parallel::Phase::Initialization,
     353             :        Parallel::Phase::InitializeTimeStepperHistory, Parallel::Phase::Register,
     354             :        Parallel::Phase::Evolve, Parallel::Phase::Exit}};
     355             : 
     356             :   // NOLINTNEXTLINE(google-runtime-references)
     357           0 :   void pup(PUP::er& /*p*/) {}
     358             : };