SpECTRE Documentation Coverage Report
Current view: top level - Evolution/Executables/RadiationTransport/M1Grey - EvolveM1Grey.hpp Hit Total Coverage
Commit: 1f2210958b4f38fdc0400907ee7c6d5af5111418 Lines: 0 23 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 <cstdint>
       7             : #include <vector>
       8             : 
       9             : #include "Domain/Creators/Factory3D.hpp"
      10             : #include "Domain/Tags.hpp"
      11             : #include "Evolution/Actions/RunEventsAndDenseTriggers.hpp"
      12             : #include "Evolution/Actions/RunEventsAndTriggers.hpp"
      13             : #include "Evolution/BoundaryCorrection.hpp"
      14             : #include "Evolution/ComputeTags.hpp"
      15             : #include "Evolution/DiscontinuousGalerkin/Actions/ApplyBoundaryCorrections.hpp"
      16             : #include "Evolution/DiscontinuousGalerkin/Actions/ComputeTimeDerivative.hpp"
      17             : #include "Evolution/DiscontinuousGalerkin/Actions/VolumeTermsImpl.tpp"
      18             : #include "Evolution/DiscontinuousGalerkin/BackgroundGrVars.hpp"
      19             : #include "Evolution/DiscontinuousGalerkin/CleanMortarHistory.hpp"
      20             : #include "Evolution/DiscontinuousGalerkin/DgElementArray.hpp"
      21             : #include "Evolution/DiscontinuousGalerkin/Initialization/Mortars.hpp"
      22             : #include "Evolution/DiscontinuousGalerkin/Initialization/QuadratureTag.hpp"
      23             : #include "Evolution/DiscontinuousGalerkin/Limiters/Minmod.hpp"
      24             : #include "Evolution/DiscontinuousGalerkin/Limiters/Tags.hpp"
      25             : #include "Evolution/Imex/Actions/DoImplicitStep.hpp"
      26             : #include "Evolution/Imex/Actions/RecordTimeStepperData.hpp"
      27             : #include "Evolution/Imex/CleanHistory.hpp"
      28             : #include "Evolution/Imex/ImplicitDenseOutput.hpp"
      29             : #include "Evolution/Imex/Initialize.hpp"
      30             : #include "Evolution/Initialization/ConservativeSystem.hpp"
      31             : #include "Evolution/Initialization/DgDomain.hpp"
      32             : #include "Evolution/Initialization/Evolution.hpp"
      33             : #include "Evolution/Initialization/Limiter.hpp"
      34             : #include "Evolution/Initialization/SetVariables.hpp"
      35             : #include "Evolution/Systems/RadiationTransport/M1Grey/BoundaryConditions/Factory.hpp"
      36             : #include "Evolution/Systems/RadiationTransport/M1Grey/BoundaryCorrections/Factory.hpp"
      37             : #include "Evolution/Systems/RadiationTransport/M1Grey/Initialize.hpp"
      38             : #include "Evolution/Systems/RadiationTransport/M1Grey/M1Closure.hpp"
      39             : #include "Evolution/Systems/RadiationTransport/M1Grey/M1HydroCoupling.hpp"
      40             : #include "Evolution/Systems/RadiationTransport/M1Grey/System.hpp"
      41             : #include "Evolution/Systems/RadiationTransport/M1Grey/Tags.hpp"
      42             : #include "Evolution/Systems/RadiationTransport/Tags.hpp"
      43             : #include "IO/Observer/Actions/RegisterEvents.hpp"
      44             : #include "IO/Observer/Helpers.hpp"
      45             : #include "IO/Observer/ObserverComponent.hpp"
      46             : #include "NumericalAlgorithms/DiscontinuousGalerkin/Formulation.hpp"
      47             : #include "NumericalAlgorithms/DiscontinuousGalerkin/Tags.hpp"
      48             : #include "Options/Protocols/FactoryCreation.hpp"
      49             : #include "Options/String.hpp"
      50             : #include "Parallel/Local.hpp"
      51             : #include "Parallel/Phase.hpp"
      52             : #include "Parallel/PhaseControl/CheckpointAndExitAfterWallclock.hpp"
      53             : #include "Parallel/PhaseControl/ExecutePhaseChange.hpp"
      54             : #include "Parallel/PhaseControl/Factory.hpp"
      55             : #include "Parallel/PhaseControl/VisitAndReturn.hpp"
      56             : #include "Parallel/PhaseDependentActionList.hpp"
      57             : #include "Parallel/Protocols/RegistrationMetavariables.hpp"
      58             : #include "ParallelAlgorithms/Actions/AddComputeTags.hpp"
      59             : #include "ParallelAlgorithms/Actions/AddSimpleTags.hpp"
      60             : #include "ParallelAlgorithms/Actions/InitializeItems.hpp"
      61             : #include "ParallelAlgorithms/Actions/LimiterActions.hpp"
      62             : #include "ParallelAlgorithms/Actions/MutateApply.hpp"
      63             : #include "ParallelAlgorithms/Actions/TerminatePhase.hpp"
      64             : #include "ParallelAlgorithms/Events/Factory.hpp"
      65             : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTrigger.hpp"
      66             : #include "ParallelAlgorithms/EventsAndDenseTriggers/DenseTriggers/Factory.hpp"
      67             : #include "ParallelAlgorithms/EventsAndTriggers/Completion.hpp"
      68             : #include "ParallelAlgorithms/EventsAndTriggers/Event.hpp"
      69             : #include "ParallelAlgorithms/EventsAndTriggers/EventsAndTriggers.hpp"
      70             : #include "ParallelAlgorithms/EventsAndTriggers/LogicalTriggers.hpp"
      71             : #include "ParallelAlgorithms/EventsAndTriggers/Trigger.hpp"
      72             : #include "PointwiseFunctions/AnalyticData/AnalyticData.hpp"
      73             : #include "PointwiseFunctions/AnalyticData/RadiationTransport/M1Grey/AnalyticData.hpp"
      74             : #include "PointwiseFunctions/AnalyticData/RadiationTransport/M1Grey/Factory.hpp"
      75             : #include "PointwiseFunctions/AnalyticData/Tags.hpp"
      76             : #include "PointwiseFunctions/AnalyticSolutions/AnalyticSolution.hpp"
      77             : #include "PointwiseFunctions/AnalyticSolutions/RadiationTransport/M1Grey/ConstantM1.hpp"
      78             : #include "PointwiseFunctions/AnalyticSolutions/RadiationTransport/M1Grey/Factory.hpp"
      79             : #include "PointwiseFunctions/AnalyticSolutions/Tags.hpp"
      80             : #include "PointwiseFunctions/Hydro/Tags.hpp"
      81             : #include "PointwiseFunctions/InitialDataUtilities/InitialData.hpp"
      82             : #include "Time/Actions/SelfStartActions.hpp"
      83             : #include "Time/AdvanceTime.hpp"
      84             : #include "Time/ChangeSlabSize/Action.hpp"
      85             : #include "Time/ChangeTimeStepperOrder.hpp"
      86             : #include "Time/CleanHistory.hpp"
      87             : #include "Time/RecordTimeStepperData.hpp"
      88             : #include "Time/StepChoosers/Factory.hpp"
      89             : #include "Time/StepChoosers/StepChooser.hpp"
      90             : #include "Time/Tags/Time.hpp"
      91             : #include "Time/Tags/TimeStepId.hpp"
      92             : #include "Time/TimeSequence.hpp"
      93             : #include "Time/TimeSteppers/Factory.hpp"
      94             : #include "Time/TimeSteppers/ImexTimeStepper.hpp"
      95             : #include "Time/TimeSteppers/LtsTimeStepper.hpp"
      96             : #include "Time/TimeSteppers/TimeStepper.hpp"
      97             : #include "Time/Triggers/TimeTriggers.hpp"
      98             : #include "Time/UpdateU.hpp"
      99             : #include "Utilities/Functional.hpp"
     100             : #include "Utilities/ProtocolHelpers.hpp"
     101             : #include "Utilities/TMPL.hpp"
     102             : 
     103             : /// \cond
     104             : namespace Frame {
     105             : struct Inertial;
     106             : }  // namespace Frame
     107             : namespace PUP {
     108             : class er;
     109             : }  // namespace PUP
     110             : namespace Parallel {
     111             : template <typename Metavariables>
     112             : class CProxy_GlobalCache;
     113             : }  // namespace Parallel
     114             : /// \endcond
     115             : 
     116             : struct EvolutionMetavars {
     117             :   static constexpr size_t volume_dim = 3;
     118             : 
     119             :   // Set list of neutrino species to be used by M1 code
     120           0 :   using neutrino_species = tmpl::list<neutrinos::ElectronNeutrinos<1>>;
     121             : 
     122           0 :   using system = RadiationTransport::M1Grey::System<neutrino_species>;
     123           0 :   using temporal_id = Tags::TimeStepId;
     124           0 :   using TimeStepperBase = ImexTimeStepper;
     125             : 
     126             :   static constexpr bool local_time_stepping =
     127             :       TimeStepperBase::local_time_stepping;
     128             :   static constexpr bool use_dg_element_collection = false;
     129             : 
     130           0 :   using initial_data_list =
     131             :       tmpl::append<RadiationTransport::M1Grey::AnalyticData::all_data,
     132             :                    RadiationTransport::M1Grey::Solutions::all_solutions>;
     133             : 
     134           0 :   using analytic_variables_tags = typename system::variables_tag::tags_list;
     135           0 :   using limiter = Tags::Limiter<
     136             :       Limiters::Minmod<3, typename system::variables_tag::tags_list>>;
     137             : 
     138           0 :   using analytic_compute = evolution::Tags::AnalyticSolutionsCompute<
     139             :       volume_dim, analytic_variables_tags, false, initial_data_list>;
     140           0 :   using error_compute = Tags::ErrorsCompute<analytic_variables_tags>;
     141           0 :   using error_tags = db::wrap_tags_in<Tags::Error, analytic_variables_tags>;
     142           0 :   using observe_fields = tmpl::push_back<
     143             :       tmpl::append<typename system::variables_tag::tags_list,
     144             :                    typename system::primitive_variables_tag::tags_list,
     145             :                    error_tags>,
     146             :       domain::Tags::Coordinates<volume_dim, Frame::Grid>,
     147             :       domain::Tags::Coordinates<volume_dim, Frame::Inertial>>;
     148           0 :   using non_tensor_compute_tags =
     149             :       tmpl::list<::Events::Tags::ObserverMeshCompute<volume_dim>,
     150             :                  ::Events::Tags::ObserverDetInvJacobianCompute<
     151             :                      Frame::ElementLogical, Frame::Inertial>,
     152             :                  analytic_compute, error_compute>;
     153             : 
     154             :   struct factory_creation
     155             :       : tt::ConformsTo<Options::protocols::FactoryCreation> {
     156           0 :     using factory_classes = tmpl::map<
     157             :         tmpl::pair<DenseTrigger, DenseTriggers::standard_dense_triggers>,
     158             :         tmpl::pair<DomainCreator<volume_dim>, domain_creators<volume_dim>>,
     159             :         tmpl::pair<Event,
     160             :                    tmpl::flatten<tmpl::list<
     161             :                        Events::Completion,
     162             :                        dg::Events::field_observations<
     163             :                            volume_dim, observe_fields, non_tensor_compute_tags>,
     164             :                        Events::time_events<system>>>>,
     165             :         tmpl::pair<evolution::BoundaryCorrection,
     166             :                    RadiationTransport::M1Grey::BoundaryCorrections::
     167             :                        standard_boundary_corrections<neutrino_species>>,
     168             :         tmpl::pair<ImexTimeStepper, TimeSteppers::imex_time_steppers>,
     169             :         tmpl::pair<PhaseChange, PhaseControl::factory_creatable_classes>,
     170             :         tmpl::pair<RadiationTransport::M1Grey::BoundaryConditions::
     171             :                        BoundaryCondition<neutrino_species>,
     172             :                    RadiationTransport::M1Grey::BoundaryConditions::
     173             :                        standard_boundary_conditions<neutrino_species>>,
     174             :         tmpl::pair<StepChooser<StepChooserUse::LtsStep>,
     175             :                    StepChoosers::standard_step_choosers<system, false>>,
     176             :         tmpl::pair<StepChooser<StepChooserUse::Slab>,
     177             :                    StepChoosers::standard_slab_choosers<
     178             :                        system, local_time_stepping, false>>,
     179             :         tmpl::pair<TimeSequence<double>,
     180             :                    TimeSequences::all_time_sequences<double>>,
     181             :         tmpl::pair<TimeSequence<std::uint64_t>,
     182             :                    TimeSequences::all_time_sequences<std::uint64_t>>,
     183             :         tmpl::pair<TimeStepper, TimeSteppers::time_steppers>,
     184             :         tmpl::pair<Trigger, tmpl::append<Triggers::logical_triggers,
     185             :                                          Triggers::time_triggers>>,
     186             :         tmpl::pair<evolution::initial_data::InitialData, initial_data_list>>;
     187             :   };
     188             : 
     189           0 :   using observed_reduction_data_tags =
     190             :       observers::collect_reduction_data_tags<tmpl::flatten<tmpl::list<
     191             :           tmpl::at<typename factory_creation::factory_classes, Event>>>>;
     192             : 
     193             :   static_assert(not local_time_stepping);
     194           0 :   using step_actions = tmpl::flatten<tmpl::list<
     195             :       Actions::MutateApply<
     196             :           evolution::dg::BackgroundGrVars<system, EvolutionMetavars>>,
     197             :       evolution::dg::Actions::ComputeTimeDerivative<
     198             :           volume_dim, system, AllStepChoosers, local_time_stepping,
     199             :           use_dg_element_collection>,
     200             :       tmpl::conditional_t<
     201             :           local_time_stepping,
     202             :           tmpl::list<Actions::MutateApply<RecordTimeStepperData<system>>,
     203             :                      evolution::Actions::RunEventsAndDenseTriggers<
     204             :                          tmpl::list<evolution::dg::ApplyBoundaryCorrections<
     205             :                              local_time_stepping, EvolutionMetavars, volume_dim,
     206             :                              true>>>,
     207             :                      Actions::MutateApply<UpdateU<system, local_time_stepping>>,
     208             :                      evolution::dg::Actions::ApplyLtsBoundaryCorrections<
     209             :                          volume_dim, false, use_dg_element_collection>,
     210             :                      Actions::MutateApply<ChangeTimeStepperOrder<system>>>,
     211             :           tmpl::list<
     212             :               evolution::dg::Actions::ApplyBoundaryCorrectionsToTimeDerivative<
     213             :                   volume_dim, false, use_dg_element_collection>,
     214             :               Actions::MutateApply<RecordTimeStepperData<system>>,
     215             :               imex::Actions::RecordTimeStepperData<system>,
     216             :               evolution::Actions::RunEventsAndDenseTriggers<
     217             :                   tmpl::list<imex::ImplicitDenseOutput<system>>>,
     218             :               Actions::MutateApply<UpdateU<system, local_time_stepping>>>>,
     219             :       imex::Actions::DoImplicitStep<system>,
     220             :       Actions::MutateApply<CleanHistory<system>>,
     221             :       Actions::MutateApply<imex::CleanHistory<system>>,
     222             :       tmpl::conditional_t<
     223             :           local_time_stepping,
     224             :           Actions::MutateApply<evolution::dg::CleanMortarHistory<system>>,
     225             :           tmpl::list<>>,
     226             :       Limiters::Actions::SendData<EvolutionMetavars>,
     227             :       Limiters::Actions::Limit<EvolutionMetavars>,
     228             :       Actions::MutateApply<typename RadiationTransport::M1Grey::
     229             :                                ComputeM1Closure<neutrino_species>>>>;
     230             : 
     231           0 :   using dg_registration_list =
     232             :       tmpl::list<observers::Actions::RegisterEventsWithObservers>;
     233             : 
     234           0 :   using initialization_actions = tmpl::list<
     235             :       Initialization::Actions::InitializeItems<
     236             :           Initialization::TimeStepping<EvolutionMetavars, TimeStepperBase>,
     237             :           evolution::dg::Initialization::Domain<EvolutionMetavars>,
     238             :           Initialization::TimeStepperHistory<EvolutionMetavars>>,
     239             :       Initialization::Actions::AddSimpleTags<
     240             :           evolution::dg::BackgroundGrVars<system, EvolutionMetavars>>,
     241             :       Initialization::Actions::ConservativeSystem<system>,
     242             :       evolution::Initialization::Actions::SetVariables<
     243             :           domain::Tags::Coordinates<volume_dim, Frame::ElementLogical>>,
     244             :       RadiationTransport::M1Grey::Actions::InitializeM1Tags<system>,
     245             :       Initialization::Actions::InitializeItems<imex::Initialize<system>>,
     246             :       Actions::MutateApply<typename RadiationTransport::M1Grey::
     247             :                                ComputeM1Closure<neutrino_species>>,
     248             :       Initialization::Actions::AddComputeTags<
     249             :           StepChoosers::step_chooser_compute_tags<EvolutionMetavars,
     250             :                                                   local_time_stepping>>,
     251             :       ::evolution::dg::Initialization::Mortars<volume_dim, system>,
     252             :       Initialization::Actions::Minmod<3>,
     253             :       evolution::Actions::InitializeRunEventsAndDenseTriggers,
     254             :       Parallel::Actions::TerminatePhase>;
     255             : 
     256           0 :   using dg_element_array = DgElementArray<
     257             :       EvolutionMetavars,
     258             :       tmpl::list<
     259             :           Parallel::PhaseActions<Parallel::Phase::Initialization,
     260             :                                  initialization_actions>,
     261             : 
     262             :           Parallel::PhaseActions<
     263             :               Parallel::Phase::InitializeTimeStepperHistory,
     264             :               SelfStart::self_start_procedure<step_actions, system>>,
     265             : 
     266             :           Parallel::PhaseActions<Parallel::Phase::Register,
     267             :                                  tmpl::list<dg_registration_list,
     268             :                                             Parallel::Actions::TerminatePhase>>,
     269             : 
     270             :           Parallel::PhaseActions<Parallel::Phase::Restart,
     271             :                                  tmpl::list<dg_registration_list,
     272             :                                             Parallel::Actions::TerminatePhase>>,
     273             :           Parallel::PhaseActions<
     274             :               Parallel::Phase::WriteCheckpoint,
     275             :               tmpl::list<evolution::Actions::RunEventsAndTriggers<
     276             :                              Triggers::WhenToCheck::AtCheckpoints>,
     277             :                          Parallel::Actions::TerminatePhase>>,
     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, step_actions,
     289             :                   Actions::MutateApply<AdvanceTime>,
     290             :                   PhaseControl::Actions::ExecutePhaseChange>>>>>;
     291             : 
     292             :   struct registration
     293             :       : tt::ConformsTo<Parallel::protocols::RegistrationMetavariables> {
     294           0 :     using element_registrars =
     295             :         tmpl::map<tmpl::pair<dg_element_array, dg_registration_list>>;
     296             :   };
     297             : 
     298           0 :   using component_list =
     299             :       tmpl::list<observers::Observer<EvolutionMetavars>,
     300             :                  observers::ObserverWriter<EvolutionMetavars>,
     301             :                  dg_element_array>;
     302             : 
     303           0 :   using const_global_cache_tags =
     304             :       tmpl::list<evolution::initial_data::Tags::InitialData>;
     305             : 
     306             :   static constexpr Options::String help{"Evolve the M1Grey system. \n\n"};
     307             : 
     308             :   static constexpr std::array<Parallel::Phase, 5> default_phase_order{
     309             :       {Parallel::Phase::Initialization,
     310             :        Parallel::Phase::InitializeTimeStepperHistory, Parallel::Phase::Register,
     311             :        Parallel::Phase::Evolve, Parallel::Phase::Exit}};
     312             : 
     313             :   // NOLINTNEXTLINE(google-runtime-references)
     314           0 :   void pup(PUP::er& /*p*/) {}
     315             : };

Generated by: LCOV version 1.14