Skip to content

Commit

Permalink
More minor improvements to the docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
ketch committed Aug 31, 2020
1 parent 90dbb2e commit 72ca0a5
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 15 deletions.
2 changes: 1 addition & 1 deletion am_radius-opt/Rskp.m
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
% function [R,gamma]=Rskp(s,k,p)
%
% Finds the optimal contractive k-step, s-stage GLM with order of accuracy p
% for linear problems
% for linear problems.
%
% Inputs:
% * s = # of stages
Expand Down
7 changes: 7 additions & 0 deletions doc/RKtools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ RKtools
=======
Some general utilities for analyzing Runge-Kutta methods.

Some of the routines expect as input a structured array `rk`.
This structure must have the fields `A, b, c`, containing its
Butcher coefficients. Optionally, it may represent an additive
Runge-Kutta method or an embedded pair in which case it should also have
`Ahat`, `bhat`, `chat` containing the coefficients of the secondary
method.



.. contents::
Expand Down
29 changes: 15 additions & 14 deletions doc/am_radius-opt.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ Rkp

Find the optimal SSP k-step explicit LMM with order of accuracy p.

Inputs:
Inputs:
* k = # of steps
* p = order of accuracy

Outputs:
Outputs:
* R = the SSP coefficient
* alpha, beta = the coefficients of the method

Expand Down Expand Up @@ -90,15 +90,16 @@ Rskp


Finds the optimal contractive k-step, s-stage GLM with order of accuracy p
for linear problems
for linear problems.

Inputs: s = # of stages
k = # of steps
p = order of accuracy
Inputs:
* s = # of stages
* k = # of steps
* p = order of accuracy

Outputs:
R = threshold factor
gamma = coefficients of the polynomials
Outputs:
* R = threshold factor
* gamma = coefficients of the polynomials

for k=1, the resulting polynomial is
`\sum_{j=0}^m (1+z/R)^j`
Expand All @@ -119,11 +120,11 @@ Rkp_dw
Finds the optimal SSP k-step explicit LMM with order of accuracy p
allowing downwind operators

Inputs:
Inputs:
* k = # of steps
* p = order of accuracy

Outputs:
Outputs:
* R = the SSP coefficient
* alpha, beta, tbeta = the coefficients of the method

Expand All @@ -144,7 +145,7 @@ Rkp_imp

Find the optimal SSP k-step implicit LMM with order of accuracy p

Inputs:
Inputs:
* k = # of steps
* p = order of accuracy

Expand All @@ -166,11 +167,11 @@ Rkp_imp_dw
Finds the optimal k-step implicit LMM with order of accuracy p
allowing downwinding

Inputs:
Inputs:
* k = # of steps
* p = order of accuracy

Outputs:
Outputs:
* R = the SSP coefficient
* alpha, beta, tbeta = the coefficients of the method

Expand Down

0 comments on commit 72ca0a5

Please sign in to comment.