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/TimeStepper.hpp"
      93             : #include "Time/Triggers/TimeTriggers.hpp"
      94             : #include "Time/UpdateU.hpp"
      95             : #include "Utilities/ProtocolHelpers.hpp"
      96             : #include "Utilities/TMPL.hpp"
      97             : 
      98             : /// \cond
      99             : namespace PUP {
     100             : class er;
     101             : }  // namespace PUP
     102             : namespace Parallel {
     103             : template <typename Metavariables>
     104             : class CProxy_GlobalCache;
     105             : }  // namespace Parallel
     106             : /// \endcond
     107             : 
     108             : struct EvolutionMetavars {
     109             :   static constexpr size_t volume_dim = 3;
     110           0 :   using system = ForceFree::System;
     111           0 :   using temporal_id = Tags::TimeStepId;
     112             : 
     113             :   static constexpr bool use_dg_element_collection = false;
     114             : 
     115           0 :   using initial_data_list = tmpl::append<ForceFree::Solutions::all_solutions,
     116             :                                          ForceFree::AnalyticData::all_data>;
     117             : 
     118           0 :   using analytic_variables_tags = typename system::variables_tag::tags_list;
     119             : 
     120           0 :   using analytic_compute = evolution::Tags::AnalyticSolutionsCompute<
     121             :       volume_dim, analytic_variables_tags, false, initial_data_list>;
     122             : 
     123           0 :   using error_compute = Tags::ErrorsCompute<analytic_variables_tags>;
     124             : 
     125           0 :   using error_tags = db::wrap_tags_in<Tags::Error, analytic_variables_tags>;
     126             : 
     127           0 :   using observe_fields = tmpl::push_back<
     128             :       tmpl::append<typename system::variables_tag::tags_list, error_tags>,
     129             :       domain::Tags::Coordinates<volume_dim, Frame::Grid>,
     130             :       domain::Tags::Coordinates<volume_dim, Frame::Inertial>,
     131             :       ForceFree::Tags::ElectricFieldCompute,
     132             :       ForceFree::Tags::MagneticFieldCompute,
     133             :       ForceFree::Tags::ChargeDensityCompute,
     134             :       ForceFree::Tags::ElectricCurrentDensityCompute>;
     135             : 
     136           0 :   using non_tensor_compute_tags =
     137             :       tmpl::list<::Events::Tags::ObserverMeshCompute<volume_dim>,
     138             :                  ::Events::Tags::ObserverDetInvJacobianCompute<
     139             :                      Frame::ElementLogical, Frame::Inertial>,
     140             :                  analytic_compute, error_compute>;
     141             : 
     142             :   struct factory_creation
     143             :       : tt::ConformsTo<Options::protocols::FactoryCreation> {
     144           0 :     using factory_classes = tmpl::map<
     145             :         tmpl::pair<ForceFree::BoundaryConditions::BoundaryCondition,
     146             :                    ForceFree::BoundaryConditions::standard_boundary_conditions>,
     147             :         tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
     148             :         tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
     149             :         tmpl::pair<Event,
     150             :                    tmpl::flatten<tmpl::list<
     151             :                        Events::Completion,
     152             :                        dg::Events::field_observations<
     153             :                            volume_dim, observe_fields, non_tensor_compute_tags>,
     154             :                        Events::time_events<system>,
     155             :                        dg::Events::ChangeFixedLtsRatio<volume_dim>>>>,
     156             :         tmpl::pair<
     157             :             evolution::BoundaryCorrection,
     158             :             ForceFree::BoundaryCorrections::standard_boundary_corrections>,
     159             :         tmpl::pair<evolution::initial_data::InitialData, initial_data_list>,
     160             :         tmpl::pair<PhaseChange,
     161             :                    tmpl::list<PhaseControl::VisitAndReturn<
     162             :                                   Parallel::Phase::LoadBalancing>,
     163             :                               PhaseControl::CheckpointAndExitAfterWallclock>>,
     164             :         tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
     165             :                    StepChoosers::standard_step_choosers<system>>,
     166             :         tmpl::pair<StepChooser<StepChooserUse::Slab>,
     167             :                    tmpl::push_back<
     168             :                        StepChoosers::standard_slab_choosers<system>,
     169             :                        evolution::dg::StepChoosers::FixedLtsRatio<volume_dim>>>,
     170             :         tmpl::pair<TimeSequence<double>,
     171             :                    TimeSequences::all_time_sequences<double>>,
     172             :         tmpl::pair<TimeSequence<std::uint64_t>,
     173             :                    TimeSequences::all_time_sequences<std::uint64_t>>,
     174             :         tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
     175             :         tmpl::pair<Trigger, tmpl::append<Triggers::logical_triggers,
     176             :                                          Triggers::time_triggers>>,
     177             :         tmpl::pair<Filters::Filter<volume_dim,
     178             :                                    typename system::variables_tag::tags_list>,
     179             :                    Filters::all_filters<
     180             :                        volume_dim, typename system::variables_tag::tags_list>>>;
     181             :   };
     182             : 
     183           0 :   using observed_reduction_data_tags =
     184             :       observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
     185             :           tmpl::at<typename factory_creation::factory_classes, Event>>>>;
     186             : 
     187           0 :   using dg_step_actions = tmpl::flatten<tmpl::list<
     188             :       Actions::MutateApply<
     189             :           evolution::dg::BackgroundGrVars<system, EvolutionMetavars>>,
     190             :       evolution::dg::Actions::ComputeTimeDerivative<
     191             :           volume_dim, system, AllStepChoosers, use_dg_element_collection>,
     192             :       evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
     193             :           volume_dim, use_dg_element_collection>,
     194             :       Actions::MutateApply<RecordTimeStepperData<system>>,
     195             :       evolution::Actions::RunEventsAndDenseTriggers<tmpl::list<
     196             :           evolution::dg::ApplyLtsDenseBoundaryCorrections<EvolutionMetavars>>>,
     197             :       Actions::MutateApply<UpdateU<system>>,
     198             :       evolution::dg::Actions::ApplyLtsBoundaryCorrections<
     199             :           volume_dim, use_dg_element_collection>,
     200             :       Actions::MutateApply<ChangeTimeStepperOrder<system>>,
     201             :       Actions::MutateApply<CleanHistory<system>>,
     202             :       Actions::MutateApply<evolution::dg::CleanMortarHistory<volume_dim>>,
     203             : 
     204             :       dg::Actions::SpectralFilter<volume_dim,
     205             :                                   typename system::variables_tag::tags_list>>>;
     206             : 
     207           0 :   using const_global_cache_tags =
     208             :       tmpl::list<evolution::initial_data::Tags::InitialData,
     209             :                  ForceFree::Tags::KappaPsi, ForceFree::Tags::KappaPhi,
     210             :                  ForceFree::Tags::ParallelConductivity>;
     211             : 
     212           0 :   using dg_registration_list =
     213             :       tmpl::list<observers::Actions::RegisterEventsWithObservers>;
     214             : 
     215           0 :   using equal_rate_regions =
     216             :       tmpl::list<evolution::dg::NonconformingEqualRateRegions<volume_dim>>;
     217             : 
     218           0 :   using initialization_actions = tmpl::list<
     219             :       Initialization::Actions::InitializeItems<
     220             :           Initialization::TimeStepping<EvolutionMetavars, TimeStepper, false,
     221             :                                        true>,
     222             :           evolution::dg::Initialization::Domain<EvolutionMetavars>>,
     223             :       Initialization::Actions::AddSimpleTags<
     224             :           evolution::dg::BackgroundGrVars<system, EvolutionMetavars>>,
     225             :       Initialization::Actions::ConservativeSystem<system>,
     226             :       Initialization::Actions::InitializeItems<
     227             :           Initialization::TimeStepperHistory<system>>,
     228             :       evolution::Initialization::Actions::SetVariables<
     229             :           domain::Tags::Coordinates<3, Frame::ElementLogical>>,
     230             : 
     231             :       Initialization::Actions::AddSimpleTags<
     232             :           ForceFree::MaskNeutronStarInterior<EvolutionMetavars, false>>,
     233             : 
     234             :       Initialization::Actions::AddComputeTags<
     235             :           tmpl::list<ForceFree::Tags::ComputeTildeJ>>,
     236             : 
     237             :       Initialization::Actions::AddComputeTags<
     238             :           StepChoosers::step_chooser_compute_tags<EvolutionMetavars>>,
     239             :       ::evolution::dg::Initialization::Mortars<volume_dim>,
     240             :       evolution::dg::Initialization::Actions::SetupEqualRateRegions<
     241             :           EvolutionMetavars, volume_dim, equal_rate_regions>,
     242             :       evolution::Actions::InitializeRunEventsAndDenseTriggers,
     243             :       Initialization::Actions::InitializeItems<
     244             :           evolution::dg::Initialization::SpectralFilters<
     245             :               volume_dim, typename system::variables_tag::tags_list>>,
     246             :       Parallel::Actions::TerminatePhase>;
     247             : 
     248           0 :   using dg_element_array_component = DgElementArray<
     249             :       EvolutionMetavars,
     250             :       tmpl::list<
     251             :           Parallel::PhaseActions<Parallel::Phase::Initialization,
     252             :                                  initialization_actions>,
     253             : 
     254             :           Parallel::PhaseActions<Parallel::Phase::Register,
     255             :                                  tmpl::list<dg_registration_list,
     256             :                                             Parallel::Actions::TerminatePhase>>,
     257             : 
     258             :           Parallel::PhaseActions<Parallel::Phase::Restart,
     259             :                                  tmpl::list<dg_registration_list,
     260             :                                             Parallel::Actions::TerminatePhase>>,
     261             : 
     262             :           Parallel::PhaseActions<
     263             :               Parallel::Phase::WriteCheckpoint,
     264             :               tmpl::list<evolution::Actions::RunEventsAndTriggers<
     265             :                              Triggers::WhenToCheck::AtCheckpoints>,
     266             :                          Parallel::Actions::TerminatePhase>>,
     267             : 
     268             :           Parallel::PhaseActions<
     269             :               Parallel::Phase::InitializeTimeStepperHistory,
     270             :               SelfStart::self_start_procedure<dg_step_actions, system>>,
     271             : 
     272             :           Parallel::PhaseActions<
     273             :               Parallel::Phase::Evolve,
     274             :               tmpl::flatten<tmpl::list<
     275             :                   evolution::Actions::RunEventsAndTriggers<
     276             :                       Triggers::WhenToCheck::AtSteps>,
     277             :                   evolution::Actions::RunEventsAndTriggers<
     278             :                       Triggers::WhenToCheck::AtSlabs>,
     279             :                   Actions::ChangeSlabSize,
     280             :                   evolution::dg::Actions::ChangeFixedLtsRatio, dg_step_actions,
     281             :                   Actions::MutateApply<AdvanceTime<>>,
     282             :                   PhaseControl::Actions::ExecutePhaseChange>>>>>;
     283             : 
     284             :   struct registration
     285             :       : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
     286           0 :     using element_registrars =
     287             :         tmpl::map<tmpl::pair<dg_element_array_component, dg_registration_list>>;
     288             :   };
     289             : 
     290           0 :   using component_list =
     291             :       tmpl::list<observers::Observer<EvolutionMetavars>,
     292             :                  observers::ObserverWriter<EvolutionMetavars>,
     293             :                  dg_element_array_component>;
     294             : 
     295             :   static constexpr Options::String help{
     296             :       "Evolve the GRFFE system with divergence cleaning.\n"};
     297             : 
     298             :   static constexpr std::array<Parallel::Phase, 5> default_phase_order{
     299             :       {Parallel::Phase::Initialization,
     300             :        Parallel::Phase::InitializeTimeStepperHistory, Parallel::Phase::Register,
     301             :        Parallel::Phase::Evolve, Parallel::Phase::Exit}};
     302             : 
     303             :   // NOLINTNEXTLINE(google-runtime-references)
     304           0 :   void pup(PUP::er& /*p*/) {}
     305             : };