hyperbolic_module.h

Go to the documentation of this file.

//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// Copyright (C) 2020 - 2026 by the ryujin authors
//
 
#pragma once
 
#include <compile_time_options.h>
 
#include "convenience_macros.h"
#include "initial_values.h"
#include "mpi_ensemble.h"
#include "observer_pointer.h"
#include "offline_data.h"
#include "sparse_matrix.h"
#include "state_vector.h"
 
#include <deal.II/base/parameter_acceptor.h>
#include <deal.II/lac/sparse_matrix.templates.h>
#include <deal.II/lac/vector.h>
 
#include <functional>
#include <utility>
 
namespace ryujin
{
  enum class IDViolationStrategy : std::uint8_t {
    warn,
 
    raise_exception,
  };
 
 
  class Restart final
  {
  public:
    double suggested_tau_max;
  };
 
 
  class Correction final
  {
  };
 
 
  template <typename HyperbolicDescription, int dim, typename Number = double>
  class HyperbolicModule final : public dealii::ParameterAcceptor
  {
  public:
 
    using HyperbolicSystem = typename HyperbolicDescription::HyperbolicSystem;
 
    using View = typename HyperbolicSystem::template View<dim, Number>;
 
    using Indicator =
        typename HyperbolicDescription::template Indicator<Number>;
 
    using Limiter = typename HyperbolicDescription::template Limiter<Number>;
 
    using WaveSpeedEstimator =
        typename HyperbolicDescription::template WaveSpeedEstimator<Number>;
 
    static constexpr auto problem_dimension = View::problem_dimension;
 
    using state_type = typename View::state_type;
 
    static constexpr auto n_precomputed_values = View::n_precomputed_values;
 
    using precomputed_type = typename View::precomputed_type;
 
    static constexpr auto n_initial_precomputed_values =
        View::n_initial_precomputed_values;
 
    using initial_precomputed_type = typename View::initial_precomputed_type;
 
 
 
    HyperbolicModule(
        const MPIEnsemble &mpi_ensemble,
        const OfflineData<dim, Number> &offline_data,
        const HyperbolicSystem &hyperbolic_system,
        const InitialValues<HyperbolicDescription, dim, Number> &initial_values,
        const std::string &subsection = "/HyperbolicModule");
 
    void prepare();
 
 
 
    void reinit_state_vector(StateVector<Number> &state_vector) const;
 
    void prepare_state_vector(StateVector<Number> &state_vector,
                              Number t) const;
 
    template <int stages>
    Number step(const StateVector<Number> &old_state_vector,
                std::array<std::reference_wrapper<const StateVector<Number>>,
                           stages> stage_state_vectors,
                const std::array<Number, stages> stage_weights,
                StateVector<Number> &new_state_vector,
                Number tau = Number(0.),
                Number tau_max = std::numeric_limits<Number>::max()) const;
 
    void set_cfl(Number new_cfl) const
    {
      Assert(cfl_ > Number(0.), dealii::ExcInternalError());
      cfl_ = new_cfl;
    }
 
    void set_acceptable_tau_max_ratio(Number new_acceptable_tau_max_ratio) const
    {
      Assert(new_acceptable_tau_max_ratio >= Number(1.),
             dealii::ExcInternalError());
      acceptable_tau_max_ratio_ = new_acceptable_tau_max_ratio;
    }
 
    void set_id_violation_strategy(const IDViolationStrategy &strategy) const
    {
      id_violation_strategy_ = strategy;
    }
 
 
 
    ACCESSOR_READ_ONLY(cfl)
 
    
    ACCESSOR_READ_ONLY(acceptable_tau_max_ratio)
 
    ACCESSOR_READ_ONLY(offline_data)
 
    ACCESSOR_READ_ONLY(hyperbolic_system)
 
    ACCESSOR_READ_ONLY(initial_precomputed)
 
    ACCESSOR_READ_ONLY(alpha)
 
    ACCESSOR_READ_ONLY(n_restarts)
 
    ACCESSOR_READ_ONLY(n_corrections)
 
    ACCESSOR_READ_ONLY(n_warnings)
 
  private:
 
 
    template <typename MemorySpace>
    void apply_boundary_conditions(MultiComponentVector<Number> &U,
                                   const Number t) const;
 
 
    Indicator indicator_;
 
    Limiter limiter_;
 
    WaveSpeedEstimator wave_speed_estimator_;
 
 
 
    const MPIEnsemble &mpi_ensemble_;
 
    dealii::ObserverPointer<const OfflineData<dim, Number>> offline_data_;
    dealii::ObserverPointer<const HyperbolicSystem> hyperbolic_system_;
    dealii::ObserverPointer<
        const InitialValues<HyperbolicDescription, dim, Number>>
        initial_values_;
 
    mutable Number cfl_;
    mutable Number acceptable_tau_max_ratio_;
 
    mutable IDViolationStrategy id_violation_strategy_;
 
    mutable unsigned int n_restarts_;
    mutable unsigned int n_corrections_;
    mutable unsigned int n_warnings_;
 
    MultiComponentVector<Number> initial_precomputed_;
 
    mutable ScalarVector<Number> alpha_;
 
    static constexpr auto n_bounds =
        decltype(std::declval<const Limiter &>()
                     .template view<dim, Number>())::n_bounds;
    mutable MultiComponentVector<Number> bounds_;
 
    mutable MultiComponentVector<Number> r_;
 
    /*
     * A compact buffer holding all boundary states of the hyperbolic state
     * vector, see apply_boundary_conditions().
     */
    mutable Mirrored<Number *> boundary_states_{
        "hyperbolic_module_boundary_states"};
 
    mutable SparseMatrix<Number> dij_matrix_;
    mutable SparseMatrix<Number> lij_matrix_;
    mutable SparseMatrix<Number> lij_matrix_next_;
    mutable SparseMatrix<Number, problem_dimension> pij_matrix_;
 
  };
 
} /* namespace ryujin */