Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/new tables #359

Merged
merged 12 commits into from
Oct 28, 2023
Merged

Feature/new tables #359

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
63fee13
Add 3rd order Shu-Osher method
Steven-Roberts Oct 26, 2023
7472714
Added high-order embedded ERK methods by Verner, and fixed some minor…
drreynolds Oct 27, 2023
8fddce4
Merged with upstream changes from develop
drreynolds Oct 27, 2023
fcebce2
Fixed RCONST(1) to RCONST(1.0)
drreynolds Oct 27, 2023
3b1dda5
Updated answers git revision
drreynolds Oct 27, 2023
3656428
Updated erkStep_SetButcherTable and arkStep_SetButcherTables to refle…
drreynolds Oct 27, 2023
19a729c
Replaced color scheme in new stability plots; replaced rational coeff…
drreynolds Oct 27, 2023
d2576c2
update orders provided in docs
gardner48 Oct 27, 2023
50e5e60
Merge branch 'develop' into feature/new-tables
gardner48 Oct 27, 2023
f24995c
Update CHANGELOG.md
gardner48 Oct 28, 2023
9fe56c8
Update Introduction.rst
gardner48 Oct 28, 2023
7cbfaa3
update answers submodule
gardner48 Oct 28, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,11 @@ CMake targets.
Fixed the build system support for MAGMA when using a NVIDIA HPC SDK installation of CUDA
and fixed the targets used for rocBLAS and rocSPARSE.

Added the fourth order ERK method `ARKODE_SOFRONIOU_SPALETTA_5_3_4`.
Added the third order ERK method `ARKODE_SHU_OSHER_3_2_3` the fourth order
gardner48 marked this conversation as resolved.
Show resolved Hide resolved
ERK method `ARKODE_SOFRONIOU_SPALETTA_5_3_4`, the sixth order ERK method
`ARKODE_VERNER_9_5_6`, the seventh order ERK method `ARKODE_VERNER_10_6_7`,
the eighth order ERK method `ARKODE_VERNER_13_7_8`, and the ninth order ERK
method `ARKODE_VERNER_16_8_9`.
drreynolds marked this conversation as resolved.
Show resolved Hide resolved

## Changes to SUNDIALS in release 6.6.1

Expand Down
492 changes: 392 additions & 100 deletions doc/arkode/guide/source/Butcher.rst
View file
Open in desktop

Large diffs are not rendered by default.

22 changes: 22 additions & 0 deletions doc/arkode/guide/source/Constants.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,16 @@ contains the ARKODE output constants.
+-----------------------------------------------+------------------------------------------------------------+
| :index:`ARKODE_ARK548L2SAb_ERK_8_4_5` | Use the ARK-8-4-5b ERK method. |
+-----------------------------------------------+------------------------------------------------------------+
| :index:`ARKODE_SHU_OSHER_3_2_3` | Use the Shu-Osher-3-2-3 ERK method. |
+-----------------------------------------------+------------------------------------------------------------+
| :index:`ARKODE_VERNER_9_5_6` | Use the Verner-9-5-6 ERK method. |
+-----------------------------------------------+------------------------------------------------------------+
| :index:`ARKODE_VERNER_10_6_7` | Use the Verner-10-6-7 ERK method. |
+-----------------------------------------------+------------------------------------------------------------+
| :index:`ARKODE_VERNER_13_7_8` | Use the Verner-13-7-8 ERK method. |
+-----------------------------------------------+------------------------------------------------------------+
| :index:`ARKODE_VERNER_16_8_9` | Use the Verner-16-8-9 ERK method. |
+-----------------------------------------------+------------------------------------------------------------+
| :index:`ARKSTEP_DEFAULT_ERK_2` | Use ARKStep's default second-order ERK method |
| | (ARKODE_HEUN_EULER_2_1_2). |
+-----------------------------------------------+------------------------------------------------------------+
Expand All @@ -121,9 +131,15 @@ contains the ARKODE output constants.
| :index:`ARKSTEP_DEFAULT_ERK_6` | Use ARKStep's default sixth-order ERK method |
| | (ARKODE_VERNER_8_5_6). |
+-----------------------------------------------+------------------------------------------------------------+
| :index:`ARKSTEP_DEFAULT_ERK_7` | Use ARKStep's default seventh-order ERK method |
| | (ARKODE_VERNER_10_6_7). |
+-----------------------------------------------+------------------------------------------------------------+
| :index:`ARKSTEP_DEFAULT_ERK_8` | Use ARKStep's default eighth-order ERK method |
| | (ARKODE_FEHLBERG_13_7_8). |
+-----------------------------------------------+------------------------------------------------------------+
| :index:`ARKSTEP_DEFAULT_ERK_9` | Use ARKStep's default ninth-order ERK method |
| | (ARKODE_VERNER_16_8_9). |
+-----------------------------------------------+------------------------------------------------------------+
| :index:`ERKSTEP_DEFAULT_2` | Use ERKStep's default second-order ERK method |
| | (ARKODE_HEUN_EULER_2_1_2). |
+-----------------------------------------------+------------------------------------------------------------+
Expand All @@ -139,9 +155,15 @@ contains the ARKODE output constants.
| :index:`ERKSTEP_DEFAULT_6` | Use ERKStep's default sixth-order ERK method |
| | (ARKODE_VERNER_8_5_6). |
+-----------------------------------------------+------------------------------------------------------------+
| :index:`ERKSTEP_DEFAULT_7` | Use ERKStep's default seventh-order ERK method |
| | (ARKODE_VERNER_10_6_7). |
+-----------------------------------------------+------------------------------------------------------------+
| :index:`ERKSTEP_DEFAULT_8` | Use ERKStep's default eighth-order ERK method |
| | (ARKODE_FEHLBERG_13_7_8). |
+-----------------------------------------------+------------------------------------------------------------+
| :index:`ERKSTEP_DEFAULT_9` | Use ERKStep's default ninth-order ERK method |
| | (ARKODE_VERNER_16_8_9). |
+-----------------------------------------------+------------------------------------------------------------+
| | |
+-----------------------------------------------+------------------------------------------------------------+
| **Implicit Butcher table specification** | |
Expand Down
9 changes: 8 additions & 1 deletion doc/arkode/guide/source/Introduction.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,14 @@ Fixed scaling bug in ``SUNMatScaleAddI_Sparse`` for non-square matrices.
Fixed missing soversions in some ``SUNLinearSolver`` and ``SUNNonlinearSolver``
CMake targets.

Added the fourth order ERK method ``ARKODE_SOFRONIOU_SPALETTA_5_3_4``.
Fixed the build system support for MAGMA when using a NVIDIA HPC SDK installation of CUDA
and fixed the targets used for rocBLAS and rocSPARSE.

Added the third order ERK method ``ARKODE_SHU_OSHER_3_2_3``, the fourth order
ERK method ``ARKODE_SOFRONIOU_SPALETTA_5_3_4``, the sixth order ERK method
``ARKODE_VERNER_9_5_6``, the seventh order ERK method ``ARKODE_VERNER_10_6_7``,
the eighth order ERK method ``ARKODE_VERNER_13_7_8``, and the ninth order ERK
method ``ARKODE_VERNER_16_8_9``.

Changes in v5.6.1
-----------------
Expand Down
Binary file added doc/shared/figs/arkode/shu_osher_erk_stab_region.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/shared/figs/arkode/v65b_erk_stab_region.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/shared/figs/arkode/v76_erk_stab_region.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/shared/figs/arkode/v87_erk_stab_region.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/shared/figs/arkode/v98_erk_stab_region.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
40 changes: 37 additions & 3 deletions doc/shared/sundials.bib
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -445,9 +445,9 @@ @book{HaWa:91
address = {Berlin},
year = 1991,
}
@book{HaWa:06,
author = {Hairer, Ernst and Wanner, Gerhard and Lubich, Christian},
title = {{Geometric Numerical Integration, Structure-Preserving Algorithms for Ordinary Differential Equations}},
@book{HaWa:06,
author = {Hairer, Ernst and Wanner, Gerhard and Lubich, Christian},
title = {{Geometric Numerical Integration, Structure-Preserving Algorithms for Ordinary Differential Equations}},
publisher = {Springer Series in Computational Mathematics},
doi = {10.1007/3-540-30666-8},
year = {2006}
Expand Down Expand Up @@ -1806,6 +1806,17 @@ @article{HaSo:05
publisher={SIAM}
}

@article{FCS:21,
author = {Imre Fekete and Sidafa Conde and John N. Shadid},
title = {Embedded pairs for optimal explicit strong stability preserving {Runge--Kutta} methods},
journal = {Journal of Computational and Applied Mathematics},
volume = {412},
pages = {114325},
year = {2022},
issn = {0377-0427},
doi = {10.1016/j.cam.2022.114325}
}

@article{FFKMS:14,
author = {Falgout, R.D. and Friedhoff, S. and Kolev, TZ.V. and MacLachlan, S.P. and Schroder, J.B.},
title = {Parallel Time Integration with Multigrid},
Expand Down Expand Up @@ -1998,6 +2009,18 @@ @article{Shampine:80
doi = {10.1137/0901005}
}

@article{ShOs:88,
author = {Chi-Wang Shu and Stanley Osher},
title = {Efficient implementation of essentially non-oscillatory shock-capturing schemes},
journal = {Journal of Computational Physics},
volume = {77},
number = {2},
pages = {439-471},
year = {1988},
issn = {0021-9991},
doi = {10.1016/0021-9991(88)90177-5}
}

@article{Sod:98,
author = {Soderlind, G.},
title = {The automatic control of numerical integration},
Expand Down Expand Up @@ -2076,6 +2099,17 @@ @article{Ver:78
doi = {10.1137/0715051}
}

@article{Ver:10,
author = {Verner, J.H},
title = {Numerically optimal {Runge–Kutta} pairs with interpolants},
journal = {Numerical Algorithms},
volume = {53},
number = {2},
pages = {383-396},
year = {2010},
doi = {10.1007/s11075-009-9290-3}
}

@article{Ruth:93,
title = {A canonical integration technique},
author = {Ruth, Ronald D},
Expand Down
2 changes: 2 additions & 0 deletions include/arkode/arkode_arkstep.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ static const int ARKSTEP_DEFAULT_ERK_3 = ARKODE_BOGACKI_SHAMPINE_4_2_3;
static const int ARKSTEP_DEFAULT_ERK_4 = ARKODE_ZONNEVELD_5_3_4;
static const int ARKSTEP_DEFAULT_ERK_5 = ARKODE_CASH_KARP_6_4_5;
static const int ARKSTEP_DEFAULT_ERK_6 = ARKODE_VERNER_8_5_6;
static const int ARKSTEP_DEFAULT_ERK_7 = ARKODE_VERNER_10_6_7;
static const int ARKSTEP_DEFAULT_ERK_8 = ARKODE_FEHLBERG_13_7_8;
static const int ARKSTEP_DEFAULT_ERK_9 = ARKODE_VERNER_16_8_9;

/* implicit */
static const int ARKSTEP_DEFAULT_DIRK_2 = ARKODE_SDIRK_2_1_2;
Expand Down
9 changes: 7 additions & 2 deletions include/arkode/arkode_butcher_erk.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ extern "C" {
/* DEPRECATED MIN_ERK_NUM: use ARKODE_MIN_ERK_NUM */
#define MIN_ERK_NUM 0
/* DEPRECATED MAX_ERK_NUM: use ARKODE_MAX_ERK_NUM */
#define MAX_ERK_NUM 14
#define MAX_ERK_NUM 21

typedef enum {
ARKODE_ERK_NONE = -1, /* ensure enum is signed int */
Expand All @@ -86,7 +86,12 @@ typedef enum {
ARKODE_ARK548L2SAb_ERK_8_4_5,
ARKODE_ARK2_ERK_3_1_2,
ARKODE_SOFRONIOU_SPALETTA_5_3_4,
ARKODE_MAX_ERK_NUM = ARKODE_SOFRONIOU_SPALETTA_5_3_4
ARKODE_SHU_OSHER_3_2_3,
ARKODE_VERNER_9_5_6,
ARKODE_VERNER_10_6_7,
ARKODE_VERNER_13_7_8,
ARKODE_VERNER_16_8_9,
ARKODE_MAX_ERK_NUM = ARKODE_VERNER_16_8_9
} ARKODE_ERKTableID;

/* Accessor routine to load built-in ERK table */
Expand Down
2 changes: 2 additions & 0 deletions include/arkode/arkode_erkstep.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ static const int ERKSTEP_DEFAULT_3 = ARKODE_BOGACKI_SHAMPINE_4_2_3;
static const int ERKSTEP_DEFAULT_4 = ARKODE_ZONNEVELD_5_3_4;
static const int ERKSTEP_DEFAULT_5 = ARKODE_CASH_KARP_6_4_5;
static const int ERKSTEP_DEFAULT_6 = ARKODE_VERNER_8_5_6;
static const int ERKSTEP_DEFAULT_7 = ARKODE_VERNER_10_6_7;
static const int ERKSTEP_DEFAULT_8 = ARKODE_FEHLBERG_13_7_8;
static const int ERKSTEP_DEFAULT_9 = ARKODE_VERNER_16_8_9;

#ifndef DEFAULT_ERK_2
/* DEPRECATED DEFAULT_ERK_2: use ERKSTEP_DEFAULT_2 */
Expand Down
Loading
Loading