Line data    Source code

       1           0 : // Distributed under the MIT License.
       2             : // See LICENSE.txt for details.
       3             : 
       4             : #pragma once
       5             : 
       6             : #include <cstddef>
       7             : 
       8             : #include "Time/Time.hpp"
       9             : 
      10             : /// \cond
      11             : namespace PUP {
      12             : class er;
      13             : }  // namespace PUP
      14             : /// \endcond
      15             : 
      16             : /// \ingroup TimeGroup
      17             : /// Estimate of the TimeStepper truncation error.
      18           1 : struct StepperErrorEstimate {
      19             :   /// Start of the step the estimate is for.
      20           1 :   Time step_time{};
      21             :   /// Size of the step the estimate is for.
      22           1 :   TimeDelta step_size{};
      23             :   /// Order of accuracy of the estimate.  The estimated error should
      24             :   /// scale approximately as $(\Delta t)^{\text{order} + 1}$.
      25           1 :   size_t order{};
      26             :   /// Error estimate.
      27           1 :   double error{};
      28             : 
      29           0 :   void pup(PUP::er& p);
      30             : };