mrkiss_eerk_dormand_prince_5_4.f90

Go to the documentation of this file.

! -*- Mode:F90; Coding:us-ascii-unix; fill-column:129 -*-
!.!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!.H.S.!!
!>
!! @file      mrkiss_eerk_dormand_prince_5_4.f90
!! @author    Mitch Richling http://www.mitchr.me/
!! @brief     Butcher tableau for Dormand & Prince's 7 stage, Order (5,4) Runge-Kutta method.@EOL
!! @keywords  ode ivp differential equation initial value problem rk
!! @std       F2023
!! @see       https://github.com/richmit/MRKISS
!! @copyright
!!  @parblock
!!  Copyright (c) 2025, Mitchell Jay Richling <http://www.mitchr.me/> All rights reserved.
!!
!!  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
!!  conditions are met:
!!
!!  1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following
!!     disclaimer.
!!
!!  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the following
!!     disclaimer in the documentation and/or other materials provided with the distribution.
!!
!!  3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products
!!     derived from this software without specific prior written permission.
!!
!!  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
!!  INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
!!  DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
!!  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
!!  USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
!!  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
!!  OF THE POSSIBILITY OF SUCH DAMAGE.
!!  @endparblock
!.!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!.H.E.!!
 
!----------------------------------------------------------------------------------------------------------------------------------
!> Butcher tableau for Dormand & Prince's 7 stage, Order (5,4) Runge-Kutta method
!!
!! @image html eerk_dormand_prince_5_4-stab.png
!!
!! @par IMO
!! I include this method for historical reasons and for unit tests.  It's a good general use method with excellent principle
!! truncation error coefficients.  It has been very widely used, frequently as the default method, across many software packages
!! with good results.  It's a standard method to use for comparisons in the literature. Today it has largely been replaced by
!! newer methods.
!!
!! @par Known Aliases
!! 'The Dormand-Prince Method', 'RKDP', 'DOPRI', 'DP5' (OrdinaryDiffEq.jl), 'ode45' (MATLAB & Octave), 
!! 'RK5(4)7M' (Dormand & Prince), & DOPRI5 (Hairer), 'ARKODE_DORMAND_PRINCE_7_4_5' (SUNDIALS)
!!
!! @par Stability Image Links
!! <a href="eerk_dormand_prince_5_4-stab.png">  <img src="eerk_dormand_prince_5_4-stab.png"  width="256px"> </a>
!! <a href="eerk_dormand_prince_5_4-astab.png"> <img src="eerk_dormand_prince_5_4-astab.png" width="256px"> </a>
!! <a href="eerk_dormand_prince_5_4-star1.png"> <img src="eerk_dormand_prince_5_4-star1.png" width="256px"> </a>
!! <a href="eerk_dormand_prince_5_4-star2.png"> <img src="eerk_dormand_prince_5_4-star2.png" width="256px"> </a>
!!
!! @par References:
!!  - Dormand & Prince (1980); A family of embedded Runge-Kutta formulae; J. Comput. Appl. Math. 6, no. 1
!!  - Hairer, Norsett & Wanner (2009). Solving Ordinary Differential Equations. I: Nonstiff Problems. p178; 
!!    zotero://select/items/0_VLZWN2CT
!!  - Butcher (2016); Numerical Methods for Ordinary Differential Equations. 3ed; p224; zotero://select/items/0_V7UTIRPT
!!
module mrkiss_eerk_dormand_prince_5_4
  use mrkiss_config, only: rk
  implicit none
  public
  !> The order of the overall method
  integer,          parameter :: s      = 7
  !> Number of methods
  integer,          parameter :: m      = 2
  !> The @f$\mathbf{a}@f$ matrix for the Butcher Tableau. @hideinitializer @hideinlinesource
  real(kind=rk),    parameter :: a(s,s) = reshape([          0.0_rk,             0.0_rk,            0.0_rk,           0.0_rk,           0.0_rk,          0.0_rk,      0.0_rk, &
       &                                            3427256448.0_rk,             0.0_rk,            0.0_rk,           0.0_rk,           0.0_rk,          0.0_rk,      0.0_rk, &
       &                                            1285221168.0_rk,    3855663504.0_rk,            0.0_rk,           0.0_rk,           0.0_rk,          0.0_rk,      0.0_rk, &
       &                                           16755475968.0_rk,  -63975453696.0_rk,  60929003520.0_rk,           0.0_rk,           0.0_rk,          0.0_rk,      0.0_rk, &
       &                                           50596564480.0_rk, -198708787200.0_rk, 168327864320.0_rk, -4983390720.0_rk,           0.0_rk,          0.0_rk,      0.0_rk, &
       &                                           48774576060.0_rk, -184344854400.0_rk, 152622973440.0_rk,  4770896760.0_rk, -4687309620.0_rk,          0.0_rk,      0.0_rk, &
       &                                            1561900725.0_rk,             0.0_rk,   7698240000.0_rk, 11156433750.0_rk, -5524329195.0_rk, 2244036960.0_rk,      0.0_rk], [s, s]) / 17136282240.0_rk
  !> The @f$\mathbf{b}@f$ matrix for the Butcher Tableau. @hideinitializer @hideinlinesource
  real(kind=rk),    parameter :: b(s,m) = reshape([    1947750.0_rk,             0.0_rk,      9600000.0_rk,    13912500.0_rk,    -6889050.0_rk,    2798400.0_rk,      0.0_rk, &
       &                                               1921409.0_rk,             0.0_rk,      9690880.0_rk,    13122270.0_rk,    -5802111.0_rk,    1902912.0_rk, 534240.0_rk], [s, m]) /    21369600.0_rk
  !> The @f$\mathbf{c}@f$ matrix for the Butcher Tableau. @hideinitializer @hideinlinesource
  real(kind=rk),    parameter :: c(s)   = [                  0.0_rk,            18.0_rk,           27.0_rk,          72.0_rk,          80.0_rk,         90.0_rk,     90.0_rk]          /          90.0_rk
  !> The method orders
  integer,          parameter :: p(m)   = [5, 4]
  !> Number of stages for each method
  integer,          parameter :: se(m)  = [6, 7]
end module mrkiss_eerk_dormand_prince_5_4