TimeStepAlgorithm.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (c) OpenGeoSys Community (opengeosys.org)
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <cmath>
#include <tuple>
#include <vector>
 
#include "BaseLib/Error.h"
#include "NumLib/TimeStepping/TimeStep.h"
 
namespace NumLib
{
struct Time;

class TimeStepAlgorithm
{
public:
    TimeStepAlgorithm(const double t0, const double t_end)
        : _t_initial(t0), _t_end(t_end)
    {
    }
 
    virtual ~TimeStepAlgorithm() = default;

    Time begin() const { return _t_initial; }
    Time end() const { return _t_end; }

    virtual double next(const double solution_error,
                        int number_iterations,
                        NumLib::TimeStep& ts_previous,
                        NumLib::TimeStep& ts_current) = 0;

    virtual bool isSolutionErrorComputationNeeded() const { return false; }

    virtual bool canReduceTimestepSize(
        NumLib::TimeStep const& /*timestep_previous*/,
        NumLib::TimeStep const& /*timestep_current*/) const
    {
        return false;
    }
 
protected:
    const Time _t_initial;
    const Time _t_end;
};

double possiblyClampDtToNextFixedTime(
    Time const& t, double const dt,
    std::vector<double> const& fixed_output_times);
 
bool canReduceTimestepSize(TimeStep const& timestep_previous,
                           TimeStep const& timestep_current,
                           double const min_dt);
}  // namespace NumLib