-
-
Notifications
You must be signed in to change notification settings - Fork 214
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2222 from termi-official/do/rosenbrock-docs
Documentation for Rosenbrock methods
- Loading branch information
Showing
6 changed files
with
501 additions
and
78 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| """ | ||
| Utility function to help generating consistent docstrings across the package. | ||
| """ | ||
| # TODO we should add a consistency check using the string $name(; $keyword_default) against the standard console output of name() | ||
| function generic_solver_docstring(description::String, | ||
| name::String, | ||
| solver_class::String, | ||
| references::String, | ||
| keyword_description::String, | ||
| keyword_default::String) | ||
| if !isempty(keyword_default) | ||
| # Chunk string and remove empty lines | ||
| kws = split(keyword_default, "\n") | ||
| keywords_split = [kw for kw in kws if !isempty(rstrip(kw))] | ||
|
|
||
| # Indent the keywords properly | ||
| indentation = repeat(" ", length(name)+3) | ||
| # We do not indent the first kw and no newline for the last one | ||
| if length(keyword_default) > 1 | ||
| keywords_split[1] = keywords_split[1] * "\n" | ||
| for i in 2:(length(keywords_split)-1) | ||
| keywords_split[i] = indentation * keywords_split[i] * "\n" | ||
| end | ||
| keywords_split[end] = indentation * keywords_split[end] | ||
| end | ||
| # Flatten into string | ||
| keyword_default = join(keywords_split) | ||
| # Remove trailing comma | ||
| keyword_default = strip(keyword_default, [',']) | ||
| end | ||
| start_docstring = !isempty(keyword_default) ? """ | ||
| ```julia | ||
| $name(; $keyword_default) | ||
| ``` | ||
| $solver_class | ||
| """ : | ||
| """ | ||
| ```julia | ||
| $name() | ||
| ``` | ||
| $solver_class | ||
| """ | ||
|
|
||
| keyword_docstring = """ | ||
| ### Keyword Arguments | ||
| $keyword_description | ||
| """ | ||
|
|
||
| return start_docstring * description * keyword_docstring * | ||
| "## References\n" * references | ||
| end | ||
|
|
||
| function explicit_rk_docstring(description::String, | ||
| name::String; | ||
| references::String = "", | ||
| extra_keyword_description::String = "", | ||
| extra_keyword_default::String = "") | ||
| keyword_default = """ | ||
| stage_limiter! = OrdinaryDiffEq.trivial_limiter!, | ||
| step_limiter! = OrdinaryDiffEq.trivial_limiter!, | ||
| """ * extra_keyword_default | ||
|
|
||
| keyword_default_description = """ | ||
| - `stage_limiter!`: function of the form `limiter!(u, integrator, p, t)` | ||
| - `step_limiter!`: function of the form `limiter!(u, integrator, p, t)` | ||
| """ * extra_keyword_description | ||
|
|
||
| generic_solver_docstring( | ||
| description, name, "Explicit Runge-Kutta Method. ", references, | ||
| keyword_default_description, keyword_default | ||
| ) | ||
| end | ||
|
|
||
| function rosenbrock_docstring(description::String, | ||
| name::String; | ||
| references::String = "", | ||
| extra_keyword_description = "", | ||
| extra_keyword_default = "", | ||
| with_step_limiter = false) | ||
| keyword_default = """ | ||
| autodiff = Val{true}(), | ||
| concrete_jac = nothing, | ||
| linsolve = nothing, | ||
| precs = DEFAULT_PRECS, | ||
| """ * extra_keyword_default | ||
|
|
||
| keyword_default_description = """ | ||
| - `autodiff`: boolean to control if the Jacobian should be computed via AD or not | ||
| - `concrete_jac`: function of the form `jac!(J, u, p, t)` | ||
| - `linsolve`: custom solver for the inner linear systems | ||
| - `precs`: custom preconditioner for the inner linear solver | ||
| """ * extra_keyword_description | ||
|
|
||
| if with_step_limiter | ||
| keyword_default *= "step_limiter! = OrdinaryDiffEq.trivial_limiter!,\n" | ||
| keyword_default_description *= "- `step_limiter!`: function of the form `limiter!(u, integrator, p, t)`\n" | ||
| end | ||
|
|
||
| generic_solver_docstring( | ||
| description, name, "Rosenbrock Method. ", references, | ||
| keyword_default_description, keyword_default | ||
| ) | ||
| end | ||
|
|
||
| function rosenbrock_wanner_docstring(description::String, | ||
| name::String; | ||
| references::String = "", | ||
| extra_keyword_description = "", | ||
| extra_keyword_default = "", | ||
| with_step_limiter = false) | ||
| keyword_default = """ | ||
| autodiff = Val{true}(), | ||
| concrete_jac = nothing, | ||
| linsolve = nothing, | ||
| precs = DEFAULT_PRECS, | ||
| """ * extra_keyword_default | ||
|
|
||
| keyword_default_description = """ | ||
| - `autodiff`: boolean to control if the Jacobian should be computed via AD or not | ||
| - `concrete_jac`: function of the form `jac!(J, u, p, t)` | ||
| - `linsolve`: custom solver for the inner linear systems | ||
| - `precs`: custom preconditioner for the inner linear solver | ||
| """ * extra_keyword_description | ||
|
|
||
| if with_step_limiter | ||
| keyword_default *= "step_limiter! = OrdinaryDiffEq.trivial_limiter!,\n" | ||
| keyword_default_description *= "- `step_limiter!`: function of the form `limiter!(u, integrator, p, t)`\n" | ||
| end | ||
|
|
||
| generic_solver_docstring( | ||
| description, name, "Rosenbrock-Wanner Method. ", references, | ||
| keyword_default_description, keyword_default | ||
| ) | ||
| end | ||
|
|
||
| # TODO other classes |
Oops, something went wrong.