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/linear_algebra/state_vector.h>
 
#include <deal.II/base/parameter_acceptor.h>
 
#include <cstdint>
#include <functional>
#include <initializer_list>
#include <ostream>
#include <string>
 
namespace ryujin
{
  enum class IDViolationStrategy : std::uint8_t {
    warn,
 
    raise_exception,
  };
 
 
  class Restart final
  {
  public:
    double suggested_tau_max;
  };
 
 
  class Correction final
  {
  };
 
 
  namespace Interface
  {
    template <int dim, typename Number = double>
    class Module : public dealii::ParameterAcceptor
    {
    public:
 
      using StageVectors = std::initializer_list<
          std::reference_wrapper<const StateVector<Number>>>;
 
      using StageWeights = std::initializer_list<Number>;
 
 
 
      virtual void prepare() = 0;
 
      virtual void
      reinit_state_vector(StateVector<Number> &state_vector) const = 0;
 
      virtual void prepare_state_vector(StateVector<Number> &state_vector,
                                        Number t) const = 0;
 
      void set_id_violation_strategy(const IDViolationStrategy &strategy) const
      {
        id_violation_strategy_ = strategy;
      }
 
 
 
      virtual void print_solver_statistics(std::ostream &output) const = 0;
 
      ACCESSOR_READ_ONLY(n_restarts)
 
      
      ACCESSOR_READ_ONLY(n_corrections)
 
      
      ACCESSOR_READ_ONLY(n_warnings)
 
      //@}
 
    protected:
      explicit Module(const std::string &subsection)
          : ParameterAcceptor(subsection)
          , id_violation_strategy_(IDViolationStrategy::warn)
          , n_restarts_(0)
          , n_corrections_(0)
          , n_warnings_(0)
      {
      }
 
      mutable IDViolationStrategy id_violation_strategy_;
 
      mutable unsigned int n_restarts_;
      mutable unsigned int n_corrections_;
      mutable unsigned int n_warnings_;
    };
  } // namespace Interface
} // namespace ryujin