hyperbolic_module.h

Go to the documentation of this file.

//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
// Copyright (C) 2026 by the ryujin authors
//
 
#pragma once
 
#include <ryujin/base/compile_time_options.h>
#include <ryujin/base/convenience_macros.h>
#include <ryujin/interface/module.h>
#include <ryujin/linear_algebra/state_vector.h>
 
#include <deal.II/base/exceptions.h>
 
#include <limits>
#include <string>
 
namespace ryujin
{
  namespace Interface
  {
    template <int dim, typename Number = double>
    class HyperbolicModule : public Module<dim, Number>
    {
    public:
 
      using typename Module<dim, Number>::StageVectors;
 
      using typename Module<dim, Number>::StageWeights;
 
 
 
      virtual void
      fill_precomputed_values(StateVector<Number> &state_vector) const = 0;
 
      virtual Number
      step(const StateVector<Number> &old_state_vector,
           StageVectors stage_state_vectors,
           StageWeights stage_weights,
           StateVector<Number> &new_state_vector,
           Number tau = Number(0.),
           Number tau_max = std::numeric_limits<Number>::max()) const = 0;
 
      void set_cfl(Number new_cfl) const
      {
        Assert(new_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;
      }
 
 
 
      ACCESSOR_READ_ONLY(cfl)
 
      
      ACCESSOR_READ_ONLY(acceptable_tau_max_ratio)
 
      
      ACCESSOR_READ_ONLY(problem_dimension)
 
      
      ACCESSOR_READ_ONLY(n_precomputed_values)
 
      //@}
 
    protected:
      HyperbolicModule(const unsigned int problem_dimension,
                       const unsigned int n_precomputed_values,
                       const std::string &subsection)
          : Module<dim, Number>(subsection)
          , cfl_(Number(0.2))
          , acceptable_tau_max_ratio_(Number(1.e6))
          , problem_dimension_(problem_dimension)
          , n_precomputed_values_(n_precomputed_values)
      {
      }
 
      mutable Number cfl_;
      mutable Number acceptable_tau_max_ratio_;
 
    private:
      const unsigned int problem_dimension_;
      const unsigned int n_precomputed_values_;
    };
  } // namespace Interface
} // namespace ryujin