TimeStep.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 <spdlog/fmt/ostr.h>
 
#include <cstddef>
#include <limits>
 
#include "Time.h"
 
namespace NumLib
{
class TimeStep final
{
public:
    explicit TimeStep(Time const& current_time)
        : _previous(current_time),
          _current(current_time),
          _dt(0.0),
          _time_step_number(0)
    {
    }

    TimeStep(Time const& previous_time, Time const& current_time, std::size_t n)
        : _previous(previous_time),
          _current(current_time),
          _dt(_current() - _previous()),
          _time_step_number(n)
    {
    }

    TimeStep(const TimeStep& src) = default;

    TimeStep& operator=(const TimeStep& src) = default;

    TimeStep& operator+=(const double dt)
    {
        _previous = _current;
        _current += dt;
        _dt = dt;
        _time_step_number++;
        return *this;
    }

    Time previous() const { return _previous; }
    Time current() const { return _current; }
    double dt() const { return _dt; }
    std::size_t timeStepNumber() const { return _time_step_number; }
 
    void setAccepted(bool const accepted) { _is_accepted = accepted; }
    bool isAccepted() const { return _is_accepted; }
 
    friend inline std::ostream& operator<<(std::ostream& os, TimeStep const& ts)
    {
        return os << "previous: " << ts.previous()
                  << " | current: " << ts.current() << " | dt: " << ts.dt()
                  << " | timestep number: " << ts.timeStepNumber()
                  << " | is_accepted: " << ts.isAccepted();
    }
 
private:
    Time _previous;
    Time _current;
    double _dt;
    std::size_t _time_step_number;
    bool _is_accepted = true;
};
 
inline void updateTimeSteps(double const dt, TimeStep& previous_timestep,
                            TimeStep& current_timestep)
{
    previous_timestep = current_timestep;
    current_timestep += dt;
}
 
}  // namespace NumLib
 
template <>
struct fmt::formatter<NumLib::TimeStep> : fmt::ostream_formatter
{
};