time_loop.h

// ---------------------------------------------------------------------
//
// Copyright (C) 2020 by the hyper.deal authors
//
// This file is part of the hyper.deal library.
//
// The hyper.deal library is free software; you can use it, redistribute
// it, and/or modify it under the terms of the GNU Lesser General
// Public License as published by the Free Software Foundation; either
// version 3.0 of the License, or (at your option) any later version.
// The full text of the license can be found in the file LICENSE.MD at
// the top level directory of hyper.deal.
//
// ---------------------------------------------------------------------
 
#ifndef HYPERDEAL_FUNCTIONALITIES_TIME_LOOP
#define HYPERDEAL_FUNCTIONALITIES_TIME_LOOP
 
#include <hyper.deal/base/config.h>
 
#include <hyper.deal/base/time_loop_parameters.h>
 
#include <functional>
 
namespace hyperdeal
{
  template <typename Number, typename VectorType>
  class TimeLoop
  {
  public:
    void
    reinit(const TimeLoopParamters<Number> &parameters);
 
    int
    loop(
      VectorType &solution,
      const std::function<
        void(VectorType &,
             const Number,
             const Number,
             const std::function<
               void(const VectorType &, VectorType &, const Number)> &)>
        &time_integrator,
      const std::function<void(const VectorType &, VectorType &, const Number)>
        &                                      runnable,
      const std::function<void(const Number)> &diagnostics);
 
    Number time_step;
 
    Number start_time;
 
    Number final_time;
 
    unsigned int max_time_step_number;
  };
} // namespace hyperdeal
 
#endif