time_integrator.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 <limits>
#include <string>
 
namespace ryujin
{
  namespace Interface
  {
    template <int dim, typename Number = double>
    class TimeIntegrator : public dealii::ParameterAcceptor
    {
    public:
 
      virtual void prepare() = 0;
 
 
 
      virtual void prepare_state_vector(StateVector<Number> &state_vector,
                                        Number t) const = 0;
 
      virtual Number
      step(StateVector<Number> &state_vector,
           Number t,
           Number tau,
           Number tau_max = std::numeric_limits<Number>::max()) = 0;
 
 
 
      ACCESSOR_READ_ONLY(time_stepping_scheme_name)
 
      
      ACCESSOR_READ_ONLY(efficiency)
 
      //@}
 
    protected:
      explicit TimeIntegrator(const std::string &subsection)
          : ParameterAcceptor(subsection)
          , efficiency_(Number(1.))
      {
      }
 
      std::string time_stepping_scheme_name_;
      Number efficiency_;
    };
  } // namespace Interface
} // namespace ryujin