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

Generated by: LCOV version 2.0-1