SpECTRE Documentation Coverage Report
Current view: top level - Time/TimeSteppers - Rk5Tsitouras.hpp Hit Total Coverage
Commit: 9b01d30df5d2e946e7e38cc43c008be18ae9b1d2 Lines: 4 18 22.2 %
Date: 2024-04-23 04:54:49
Legend: Lines: hit not hit

          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 "Options/String.hpp"
       9             : #include "Time/TimeSteppers/RungeKutta.hpp"
      10             : #include "Utilities/Serialization/CharmPupable.hpp"
      11             : #include "Utilities/TMPL.hpp"
      12             : 
      13             : namespace TimeSteppers {
      14             : /*!
      15             :  * \ingroup TimeSteppersGroup
      16             :  * \brief A fifth order RK method constructed with fewer restrictions
      17             :  * on its coefficients than is common.  On a standard test suite, it
      18             :  * was found to be roughly 10% more efficient than
      19             :  * DormandPrince5.\cite Tsitouras2011.
      20             :  *
      21             :  * The CFL stable step size is 1.7534234969024887.
      22             :  */
      23           1 : class Rk5Tsitouras : public RungeKutta {
      24             :  public:
      25           0 :   using options = tmpl::list<>;
      26           0 :   static constexpr Options::String help = {
      27             :       "An efficient 5th-order Runge-Kutta time stepper."};
      28             : 
      29           0 :   Rk5Tsitouras() = default;
      30           0 :   Rk5Tsitouras(const Rk5Tsitouras&) = default;
      31           0 :   Rk5Tsitouras& operator=(const Rk5Tsitouras&) = default;
      32           0 :   Rk5Tsitouras(Rk5Tsitouras&&) = default;
      33           0 :   Rk5Tsitouras& operator=(Rk5Tsitouras&&) = default;
      34           0 :   ~Rk5Tsitouras() override = default;
      35             : 
      36           1 :   size_t order() const override;
      37             : 
      38           1 :   size_t error_estimate_order() const override;
      39             : 
      40           1 :   double stable_step() const override;
      41             : 
      42           0 :   WRAPPED_PUPable_decl_template(Rk5Tsitouras);  // NOLINT
      43             : 
      44           0 :   explicit Rk5Tsitouras(CkMigrateMessage* /*msg*/);
      45             : 
      46           0 :   const ButcherTableau& butcher_tableau() const override;
      47             : };
      48             : 
      49           0 : inline bool constexpr operator==(const Rk5Tsitouras& /*lhs*/,
      50             :                                  const Rk5Tsitouras& /*rhs*/) {
      51             :   return true;
      52             : }
      53             : 
      54           0 : inline bool constexpr operator!=(const Rk5Tsitouras& /*lhs*/,
      55             :                                  const Rk5Tsitouras& /*rhs*/) {
      56             :   return false;
      57             : }
      58             : }  // namespace TimeSteppers

Generated by: LCOV version 1.14