Line data    Source code

       1           0 : // Distributed under the MIT License.
       2             : // See LICENSE.txt for details.
       3             : 
       4             : #pragma once
       5             : 
       6             : #include <array>
       7             : #include <cstddef>
       8             : #include <type_traits>
       9             : #include <vector>
      10             : 
      11             : #include "DataStructures/DataBox/PrefixHelpers.hpp"
      12             : #include "DataStructures/Tensor/TypeAliases.hpp"
      13             : #include "Domain/Creators/DomainCreator.hpp"
      14             : #include "Domain/Creators/Factory3D.hpp"
      15             : #include "Domain/Tags.hpp"
      16             : #include "Evolution/Actions/RunEventsAndDenseTriggers.hpp"
      17             : #include "Evolution/Actions/RunEventsAndTriggers.hpp"
      18             : #include "Evolution/BoundaryCorrection.hpp"
      19             : #include "Evolution/ComputeTags.hpp"
      20             : #include "Evolution/DiscontinuousGalerkin/Actions/ApplyBoundaryCorrections.hpp"
      21             : #include "Evolution/DiscontinuousGalerkin/Actions/ComputeTimeDerivative.hpp"
      22             : #include "Evolution/DiscontinuousGalerkin/BackgroundGrVars.hpp"
      23             : #include "Evolution/DiscontinuousGalerkin/CleanMortarHistory.hpp"
      24             : #include "Evolution/DiscontinuousGalerkin/DgElementArray.hpp"
      25             : #include "Evolution/DiscontinuousGalerkin/EqualRateLts/ChangeFixedLtsRatio.hpp"
      26             : #include "Evolution/DiscontinuousGalerkin/EqualRateLts/FixedLtsRatio.hpp"
      27             : #include "Evolution/DiscontinuousGalerkin/EqualRateLts/NonconformingEqualRateRegions.hpp"
      28             : #include "Evolution/DiscontinuousGalerkin/Initialization/Mortars.hpp"
      29             : #include "Evolution/DiscontinuousGalerkin/Initialization/SetupEqualRateRegions.hpp"
      30             : #include "Evolution/DiscontinuousGalerkin/Initialization/SpectralFilters.hpp"
      31             : #include "Evolution/Initialization/ConservativeSystem.hpp"
      32             : #include "Evolution/Initialization/DgDomain.hpp"
      33             : #include "Evolution/Initialization/Evolution.hpp"
      34             : #include "Evolution/Initialization/SetVariables.hpp"
      35             : #include "Evolution/Systems/ForceFree/BoundaryConditions/BoundaryCondition.hpp"
      36             : #include "Evolution/Systems/ForceFree/BoundaryConditions/Factory.hpp"
      37             : #include "Evolution/Systems/ForceFree/BoundaryCorrections/Factory.hpp"
      38             : #include "Evolution/Systems/ForceFree/ElectricCurrentDensity.hpp"
      39             : #include "Evolution/Systems/ForceFree/ElectromagneticVariables.hpp"
      40             : #include "Evolution/Systems/ForceFree/MaskNeutronStarInterior.hpp"
      41             : #include "Evolution/Systems/ForceFree/System.hpp"
      42             : #include "Evolution/Systems/ForceFree/Tags.hpp"
      43             : #include "IO/Observer/Actions/RegisterEvents.hpp"
      44             : #include "IO/Observer/Actions/RegisterWithObservers.hpp"
      45             : #include "IO/Observer/Helpers.hpp"
      46             : #include "IO/Observer/ObserverComponent.hpp"
      47             : #include "NumericalAlgorithms/LinearOperators/Filters/Factory.hpp"
      48             : #include "NumericalAlgorithms/LinearOperators/Filters/Tag.hpp"
      49             : #include "Options/Options.hpp"
      50             : #include "Options/Protocols/FactoryCreation.hpp"
      51             : #include "Parallel/Local.hpp"
      52             : #include "Parallel/Phase.hpp"
      53             : #include "Parallel/PhaseControl/CheckpointAndExitAfterWallclock.hpp"
      54             : #include "Parallel/PhaseControl/ExecutePhaseChange.hpp"
      55             : #include "Parallel/PhaseControl/PhaseChange.hpp"
      56             : #include "Parallel/PhaseControl/VisitAndReturn.hpp"
      57             : #include "Parallel/PhaseDependentActionList.hpp"
      58             : #include "Parallel/Protocols/RegistrationMetavariables.hpp"
      59             : #include "ParallelAlgorithms/Actions/AddComputeTags.hpp"
      60             : #include "ParallelAlgorithms/Actions/AddSimpleTags.hpp"
      61             : #include "ParallelAlgorithms/Actions/InitializeItems.hpp"
      62             : #include "ParallelAlgorithms/Actions/MutateApply.hpp"
      63             : #include "ParallelAlgorithms/Actions/SpectralFilter.hpp"
      64             : #include "ParallelAlgorithms/Actions/TerminatePhase.hpp"
      65             : #include "ParallelAlgorithms/Events/ChangeFixedLtsRatio.hpp"
      66             : #include "ParallelAlgorithms/Events/Completion.hpp"
      67             : #include "ParallelAlgorithms/Events/Factory.hpp"
      68             : #include "ParallelAlgorithms/Events/Tags.hpp"
      69             : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTrigger.hpp"
      70             : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTriggers/Factory.hpp"
      71             : #include "ParallelAlgorithms/EventsAndTriggers/Event.hpp"
      72             : #include "ParallelAlgorithms/EventsAndTriggers/EventsAndTriggers.hpp"
      73             : #include "ParallelAlgorithms/EventsAndTriggers/LogicalTriggers.hpp"
      74             : #include "ParallelAlgorithms/EventsAndTriggers/Trigger.hpp"
      75             : #include "PointwiseFunctions/AnalyticData/ForceFree/AnalyticData.hpp"
      76             : #include "PointwiseFunctions/AnalyticData/ForceFree/Factory.hpp"
      77             : #include "PointwiseFunctions/AnalyticSolutions/ForceFree/Factory.hpp"
      78             : #include "PointwiseFunctions/AnalyticSolutions/Tags.hpp"
      79             : #include "PointwiseFunctions/InitialDataUtilities/InitialData.hpp"
      80             : #include "Time/Actions/SelfStartActions.hpp"
      81             : #include "Time/AdvanceTime.hpp"
      82             : #include "Time/ChangeSlabSize/Action.hpp"
      83             : #include "Time/ChangeTimeStepperOrder.hpp"
      84             : #include "Time/CleanHistory.hpp"
      85             : #include "Time/RecordTimeStepperData.hpp"
      86             : #include "Time/StepChoosers/Factory.hpp"
      87             : #include "Time/StepChoosers/StepChooser.hpp"
      88             : #include "Time/Tags/Time.hpp"
      89             : #include "Time/Tags/TimeStepId.hpp"
      90             : #include "Time/TimeSequence.hpp"
      91             : #include "Time/TimeSteppers/Factory.hpp"
      92             : #include "Time/TimeSteppers/LtsTimeStepper.hpp"
      93             : #include "Time/TimeSteppers/TimeStepper.hpp"
      94             : #include "Time/Triggers/TimeTriggers.hpp"
      95             : #include "Time/UpdateU.hpp"
      96             : #include "Utilities/ProtocolHelpers.hpp"
      97             : #include "Utilities/TMPL.hpp"
      98             : 
      99             : /// \cond
     100             : namespace PUP {
     101             : class er;
     102             : }  // namespace PUP
     103             : namespace Parallel {
     104             : template <typename Metavariables>
     105             : class CProxy_GlobalCache;
     106             : }  // namespace Parallel
     107             : /// \endcond
     108             : 
     109             : struct EvolutionMetavars {
     110             :   static constexpr size_t volume_dim = 3;
     111           0 :   using system = ForceFree::System;
     112           0 :   using temporal_id = Tags::TimeStepId;
     113           0 :   using TimeStepperBase = TimeStepper;
     114             : 
     115             :   static constexpr bool local_time_stepping =
     116             :       TimeStepperBase::local_time_stepping;
     117             :   static constexpr bool use_dg_element_collection = false;
     118             : 
     119           0 :   using initial_data_list = tmpl::append<ForceFree::Solutions::all_solutions,
     120             :                                          ForceFree::AnalyticData::all_data>;
     121             : 
     122           0 :   using analytic_variables_tags = typename system::variables_tag::tags_list;
     123             : 
     124           0 :   using analytic_compute = evolution::Tags::AnalyticSolutionsCompute<
     125             :       volume_dim, analytic_variables_tags, false, initial_data_list>;
     126             : 
     127           0 :   using error_compute = Tags::ErrorsCompute<analytic_variables_tags>;
     128             : 
     129           0 :   using error_tags = db::wrap_tags_in<Tags::Error, analytic_variables_tags>;
     130             : 
     131           0 :   using observe_fields = tmpl::push_back<
     132             :       tmpl::append<typename system::variables_tag::tags_list, error_tags>,
     133             :       domain::Tags::Coordinates<volume_dim, Frame::Grid>,
     134             :       domain::Tags::Coordinates<volume_dim, Frame::Inertial>,
     135             :       ForceFree::Tags::ElectricFieldCompute,
     136             :       ForceFree::Tags::MagneticFieldCompute,
     137             :       ForceFree::Tags::ChargeDensityCompute,
     138             :       ForceFree::Tags::ElectricCurrentDensityCompute>;
     139             : 
     140           0 :   using non_tensor_compute_tags =
     141             :       tmpl::list<::Events::Tags::ObserverMeshCompute<volume_dim>,
     142             :                  ::Events::Tags::ObserverDetInvJacobianCompute<
     143             :                      Frame::ElementLogical, Frame::Inertial>,
     144             :                  analytic_compute, error_compute>;
     145             : 
     146             :   struct factory_creation
     147             :       : tt::ConformsTo<Options::protocols::FactoryCreation> {
     148           0 :     using factory_classes = tmpl::map<
     149             :         tmpl::pair<ForceFree::BoundaryConditions::BoundaryCondition,
     150             :                    ForceFree::BoundaryConditions::standard_boundary_conditions>,
     151             :         tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
     152             :         tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
     153             :         tmpl::pair<Event,
     154             :                    tmpl::flatten<tmpl::list<
     155             :                        Events::Completion,
     156             :                        dg::Events::field_observations<
     157             :                            volume_dim, observe_fields, non_tensor_compute_tags>,
     158             :                        Events::time_events<system>,
     159             :                        dg::Events::ChangeFixedLtsRatio<volume_dim>>>>,
     160             :         tmpl::pair<
     161             :             evolution::BoundaryCorrection,
     162             :             ForceFree::BoundaryCorrections::standard_boundary_corrections>,
     163             :         tmpl::pair<evolution::initial_data::InitialData, initial_data_list>,
     164             :         tmpl::pair<LtsTimeStepper, TimeSteppers::lts_time_steppers>,
     165             :         tmpl::pair<PhaseChange,
     166             :                    tmpl::list<PhaseControl::VisitAndReturn<
     167             :                                   Parallel::Phase::LoadBalancing>,
     168             :                               PhaseControl::CheckpointAndExitAfterWallclock>>,
     169             :         tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
     170             :                    StepChoosers::standard_step_choosers<system>>,
     171             :         tmpl::pair<StepChooser<StepChooserUse::Slab>,
     172             :                    tmpl::push_back<
     173             :                        StepChoosers::standard_slab_choosers<system>,
     174             :                        evolution::dg::StepChoosers::FixedLtsRatio<volume_dim>>>,
     175             :         tmpl::pair<TimeSequence<double>,
     176             :                    TimeSequences::all_time_sequences<double>>,
     177             :         tmpl::pair<TimeSequence<std::uint64_t>,
     178             :                    TimeSequences::all_time_sequences<std::uint64_t>>,
     179             :         tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
     180             :         tmpl::pair<Trigger, tmpl::append<Triggers::logical_triggers,
     181             :                                          Triggers::time_triggers>>,
     182             :         tmpl::pair<Filters::Filter<volume_dim,
     183             :                                    typename system::variables_tag::tags_list>,
     184             :                    Filters::all_filters<
     185             :                        volume_dim, typename system::variables_tag::tags_list>>>;
     186             :   };
     187             : 
     188           0 :   using observed_reduction_data_tags =
     189             :       observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
     190             :           tmpl::at<typename factory_creation::factory_classes, Event>>>>;
     191             : 
     192           0 :   using dg_step_actions = tmpl::flatten<tmpl::list<
     193             :       Actions::MutateApply<
     194             :           evolution::dg::BackgroundGrVars<system, EvolutionMetavars>>,
     195             :       evolution::dg::Actions::ComputeTimeDerivative<
     196             :           volume_dim, system, AllStepChoosers, local_time_stepping,
     197             :           use_dg_element_collection>,
     198             :       evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
     199             :           volume_dim, use_dg_element_collection>,
     200             :       Actions::MutateApply<RecordTimeStepperData<system>>,
     201             :       evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<
     202             :           evolution::dg::ApplyLtsDenseBoundaryCorrections<EvolutionMetavars>>>,
     203             :       Actions::MutateApply<UpdateU<system, local_time_stepping>>,
     204             :       evolution::dg::Actions::ApplyLtsBoundaryCorrections<
     205             :           volume_dim, use_dg_element_collection>,
     206             :       tmpl::conditional_t<
     207             :           local_time_stepping,
     208             :           tmpl::list<Actions::MutateApply<ChangeTimeStepperOrder<system>>>,
     209             :           tmpl::list<>>,
     210             :       Actions::MutateApply<CleanHistory<system>>,
     211             :       Actions::MutateApply<evolution::dg::CleanMortarHistory<volume_dim>>,
     212             : 
     213             :       dg::Actions::SpectralFilter>>;
     214             : 
     215           0 :   using const_global_cache_tags =
     216             :       tmpl::list<evolution::initial_data::Tags::InitialData,
     217             :                  ForceFree::Tags::KappaPsi, ForceFree::Tags::KappaPhi,
     218             :                  ForceFree::Tags::ParallelConductivity>;
     219             : 
     220           0 :   using dg_registration_list =
     221             :       tmpl::list<observers::Actions::RegisterEventsWithObservers>;
     222             : 
     223           0 :   using equal_rate_regions =
     224             :       tmpl::list<evolution::dg::NonconformingEqualRateRegions<volume_dim>>;
     225             : 
     226           0 :   using initialization_actions = tmpl::list<
     227             :       Initialization::Actions::InitializeItems<
     228             :           Initialization::TimeStepping<EvolutionMetavars, TimeStepperBase,
     229             :                                        false, local_time_stepping>,
     230             :           evolution::dg::Initialization::Domain<EvolutionMetavars>,
     231             :           Initialization::TimeStepperHistory<EvolutionMetavars>>,
     232             :       Initialization::Actions::AddSimpleTags<
     233             :           evolution::dg::BackgroundGrVars<system, EvolutionMetavars>>,
     234             :       Initialization::Actions::ConservativeSystem<system>,
     235             :       evolution::Initialization::Actions::SetVariables<
     236             :           domain::Tags::Coordinates<3, Frame::ElementLogical>>,
     237             : 
     238             :       Initialization::Actions::AddSimpleTags<
     239             :           ForceFree::MaskNeutronStarInterior<EvolutionMetavars, false>>,
     240             : 
     241             :       Initialization::Actions::AddComputeTags<
     242             :           tmpl::list<ForceFree::Tags::ComputeTildeJ>>,
     243             : 
     244             :       Initialization::Actions::AddComputeTags<
     245             :           StepChoosers::step_chooser_compute_tags<EvolutionMetavars>>,
     246             :       ::evolution::dg::Initialization::Mortars<volume_dim>,
     247             :       evolution::dg::Initialization::Actions::SetupEqualRateRegions<
     248             :           EvolutionMetavars, volume_dim, equal_rate_regions>,
     249             :       evolution::Actions::InitializeRunEventsAndDenseTriggers,
     250             :       Initialization::Actions::InitializeItems<
     251             :           evolution::dg::Initialization::SpectralFilters<
     252             :               volume_dim, typename system::variables_tag::tags_list>>,
     253             :       Parallel::Actions::TerminatePhase>;
     254             : 
     255           0 :   using dg_element_array_component = DgElementArray<
     256             :       EvolutionMetavars,
     257             :       tmpl::list<
     258             :           Parallel::PhaseActions<Parallel::Phase::Initialization,
     259             :                                  initialization_actions>,
     260             : 
     261             :           Parallel::PhaseActions<Parallel::Phase::Register,
     262             :                                  tmpl::list<dg_registration_list,
     263             :                                             Parallel::Actions::TerminatePhase>>,
     264             : 
     265             :           Parallel::PhaseActions<Parallel::Phase::Restart,
     266             :                                  tmpl::list<dg_registration_list,
     267             :                                             Parallel::Actions::TerminatePhase>>,
     268             : 
     269             :           Parallel::PhaseActions<
     270             :               Parallel::Phase::WriteCheckpoint,
     271             :               tmpl::list<evolution::Actions::RunEventsAndTriggers<
     272             :                              Triggers::WhenToCheck::AtCheckpoints>,
     273             :                          Parallel::Actions::TerminatePhase>>,
     274             : 
     275             :           Parallel::PhaseActions<
     276             :               Parallel::Phase::InitializeTimeStepperHistory,
     277             :               SelfStart::self_start_procedure<dg_step_actions, system>>,
     278             : 
     279             :           Parallel::PhaseActions<
     280             :               Parallel::Phase::Evolve,
     281             :               tmpl::flatten<tmpl::list<
     282             :                   std::conditional_t<local_time_stepping,
     283             :                                      evolution::Actions::RunEventsAndTriggers<
     284             :                                          Triggers::WhenToCheck::AtSteps>,
     285             :                                      tmpl::list<>>,
     286             :                   evolution::Actions::RunEventsAndTriggers<
     287             :                       Triggers::WhenToCheck::AtSlabs>,
     288             :                   Actions::ChangeSlabSize,
     289             :                   evolution::dg::Actions::ChangeFixedLtsRatio, dg_step_actions,
     290             :                   Actions::MutateApply<AdvanceTime<>>,
     291             :                   PhaseControl::Actions::ExecutePhaseChange>>>>>;
     292             : 
     293             :   struct registration
     294             :       : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
     295           0 :     using element_registrars =
     296             :         tmpl::map<tmpl::pair<dg_element_array_component, dg_registration_list>>;
     297             :   };
     298             : 
     299           0 :   using component_list =
     300             :       tmpl::list<observers::Observer<EvolutionMetavars>,
     301             :                  observers::ObserverWriter<EvolutionMetavars>,
     302             :                  dg_element_array_component>;
     303             : 
     304             :   static constexpr Options::String help{
     305             :       "Evolve the GRFFE system with divergence cleaning.\n"};
     306             : 
     307             :   static constexpr std::array<Parallel::Phase, 5> default_phase_order{
     308             :       {Parallel::Phase::Initialization,
     309             :        Parallel::Phase::InitializeTimeStepperHistory, Parallel::Phase::Register,
     310             :        Parallel::Phase::Evolve, Parallel::Phase::Exit}};
     311             : 
     312             :   // NOLINTNEXTLINE(google-runtime-references)
     313           0 :   void pup(PUP::er& /*p*/) {}
     314             : };