hyperbolic_module.h

Go to the documentation of this file.

//
// SPDX-License-Identifier: MIT
// Copyright (C) 2020 - 2023 by the ryujin authors
//
 
#pragma once
 
#include <compile_time_options.h>
 
#include "convenience_macros.h"
#include "initial_values.h"
#include "offline_data.h"
#include "simd.h"
#include "sparse_matrix_simd.h"
 
#include <deal.II/base/parameter_acceptor.h>
#include <deal.II/base/timer.h>
#include <deal.II/lac/sparse_matrix.templates.h>
#include <deal.II/lac/vector.h>
 
#include <functional>
 
namespace ryujin
{
  enum class IDViolationStrategy {
    warn,
 
    raise_exception,
  };
 
 
  class Restart final
  {
  };
 
 
  template <typename Description, int dim, typename Number = double>
  class HyperbolicModule final : public dealii::ParameterAcceptor
  {
  public:
    using HyperbolicSystem = typename Description::HyperbolicSystem;
 
    using HyperbolicSystemView =
        typename HyperbolicSystem::template View<dim, Number>;
 
    static constexpr unsigned int problem_dimension =
        HyperbolicSystemView::problem_dimension;
 
    using state_type = typename HyperbolicSystemView::state_type;
 
    using flux_type = typename HyperbolicSystemView::flux_type;
 
    using scalar_type = typename OfflineData<dim, Number>::scalar_type;
 
    using vector_type = typename HyperbolicSystemView::vector_type;
 
    static constexpr unsigned int n_precomputed_values =
        HyperbolicSystemView::n_precomputed_values;
 
    static constexpr unsigned int n_precomputation_cycles =
        HyperbolicSystemView::n_precomputation_cycles;
 
    using precomputed_vector_type =
        typename HyperbolicSystemView::precomputed_vector_type;
 
    static constexpr unsigned int n_precomputed_initial_values =
        HyperbolicSystemView::n_precomputed_initial_values;
 
    using precomputed_initial_vector_type =
        typename HyperbolicSystemView::precomputed_initial_vector_type;
 
 
    HyperbolicModule(
        const MPI_Comm &mpi_communicator,
        std::map<std::string, dealii::Timer> &computing_timer,
        const OfflineData<dim, Number> &offline_data,
        const HyperbolicSystem &hyperbolic_system,
        const InitialValues<Description, dim, Number> &initial_values,
        const std::string &subsection = "/HyperbolicModule");
 
    void prepare();
 
 
    template <int stages>
    Number
    step(const vector_type &old_U,
         std::array<std::reference_wrapper<const vector_type>, stages> stage_U,
         std::array<std::reference_wrapper<const precomputed_vector_type>,
                    stages> stage_precomputed,
         const std::array<Number, stages> stage_weights,
         vector_type &new_U,
         precomputed_vector_type &new_precomputed,
         Number tau = Number(0.)) const;
 
    void apply_boundary_conditions(vector_type &U, Number t) const;
 
    void cfl(Number new_cfl) const
    {
      Assert(cfl_ > Number(0.), dealii::ExcInternalError());
      cfl_ = new_cfl;
    }
 
    ACCESSOR_READ_ONLY(cfl)
 
    
    ACCESSOR_READ_ONLY(offline_data)
 
    ACCESSOR_READ_ONLY(hyperbolic_system)
 
    ACCESSOR_READ_ONLY(precomputed_initial)
 
    ACCESSOR_READ_ONLY(alpha)
 
    ACCESSOR_READ_ONLY(n_restarts)
 
    ACCESSOR_READ_ONLY(n_warnings)
 
    // FIXME: refactor to function
    mutable bool precompute_only_;
 
    // FIXME: refactor to function
    mutable IDViolationStrategy id_violation_strategy_;
 
  private:
 
 
    unsigned int limiter_iter_;
    Number limiter_newton_tolerance_;
    unsigned int limiter_newton_max_iter_;
    Number limiter_relaxation_factor_;
 
    bool cfl_with_boundary_dofs_;
 
 
 
 
    const MPI_Comm &mpi_communicator_;
    std::map<std::string, dealii::Timer> &computing_timer_;
 
    dealii::SmartPointer<const OfflineData<dim, Number>> offline_data_;
    dealii::SmartPointer<const HyperbolicSystem> hyperbolic_system_;
    dealii::SmartPointer<const InitialValues<Description, dim, Number>>
        initial_values_;
 
    mutable Number cfl_;
 
    mutable unsigned int n_restarts_;
 
    mutable unsigned int n_warnings_;
 
    precomputed_initial_vector_type precomputed_initial_;
 
    mutable scalar_type alpha_;
 
    static constexpr auto n_bounds =
        Description::template Limiter<dim, Number>::n_bounds;
    mutable MultiComponentVector<Number, n_bounds> bounds_;
 
    mutable vector_type source_;
 
    mutable vector_type r_;
    mutable vector_type source_r_;
 
    mutable SparseMatrixSIMD<Number> dij_matrix_;
    mutable SparseMatrixSIMD<Number> lij_matrix_;
    mutable SparseMatrixSIMD<Number> lij_matrix_next_;
    mutable SparseMatrixSIMD<Number, problem_dimension> pij_matrix_;
    mutable SparseMatrixSIMD<Number, problem_dimension> qij_matrix_;
 
  };
 
} /* namespace ryujin */