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 <ryujin/base/compile_time_options.h>
#include <ryujin/base/convenience_macros.h>
#include <ryujin/base/mpi_ensemble.h>
#include <ryujin/base/observer_pointer.h>
#include <ryujin/discretization/offline_data.h>
#include <ryujin/interface/hyperbolic_module.h>
#include <ryujin/linear_algebra/sparse_matrix.h>
#include <ryujin/linear_algebra/state_vector.h>
#include <ryujin/typed/initial_values.h>
 
#include <deal.II/base/parameter_acceptor.h>
#include <deal.II/lac/sparse_matrix.templates.h>
#include <deal.II/lac/vector.h>
 
#include <limits>
#include <ostream>
#include <utility>
 
namespace ryujin
{
  template <typename HyperbolicDescription, int dim, typename Number = double>
  class HyperbolicModule final : public Interface::HyperbolicModule<dim, Number>
  {
  public:
 
    using StageVectors =
        typename Interface::HyperbolicModule<dim, Number>::StageVectors;
 
    using StageWeights =
        typename Interface::HyperbolicModule<dim, Number>::StageWeights;
 
    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() override;
 
 
 
    void reinit_state_vector(StateVector<Number> &state_vector) const override;
 
    void prepare_state_vector(StateVector<Number> &state_vector,
                              Number t) const override;
 
    void
    fill_precomputed_values(StateVector<Number> &state_vector) const override;
 
    Number forward_euler_step(
        const StateVector<Number> &old_state_vector,
        StageVectors stage_state_vectors,
        StageWeights stage_weights,
        StateVector<Number> &new_state_vector,
        Number t,
        Number tau,
        Number tau_max = std::numeric_limits<Number>::max()) const override;
 
 
 
    void print_solver_statistics(std::ostream & /*output*/) const override
    {
      // do nothing
    }
 
    ACCESSOR_READ_ONLY(offline_data)
 
    
    ACCESSOR_READ_ONLY(hyperbolic_system)
 
    
    ACCESSOR_READ_ONLY(initial_precomputed)
 
    
    ACCESSOR_READ_ONLY(alpha)
 
  private:
 
 
    template <int stages>
    Number forward_euler_step(const StateVector<Number> &old_state_vector,
                              StageVectors stage_state_vectors,
                              StageWeights stage_weights,
                              StateVector<Number> &new_state_vector,
                              Number t,
                              Number tau,
                              Number tau_max) const;
 
    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_;
 
    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 buffer holding all boundary states of the hyperbolic state vector. */
    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