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

Fix Rosenbrock docstrings for Wolfbrandt-property #2512

Merged
merged 3 commits into from
Nov 7, 2024
Merged

Fix Rosenbrock docstrings for Wolfbrandt-property #2512

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ce2df44
Fix Rosenbrock docstrings for Wolfbrandt-property
termi-official Nov 5, 2024
baa79d6
Try to clarify the 'W'
termi-official Nov 5, 2024
8cfa5e9
Fix oopsie.
termi-official Nov 6, 2024
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: 3 additions & 3 deletions lib/OrdinaryDiffEqRosenbrock/src/OrdinaryDiffEqRosenbrock.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ using Reexport
import OrdinaryDiffEqCore: alg_autodiff
import OrdinaryDiffEqCore

function rosenbrock_wanner_docstring(description::String,
function rosenbrock_wolfbrandt_docstring(description::String,
name::String;
references::String = "",
extra_keyword_description = "",
Expand Down Expand Up @@ -118,7 +118,7 @@ function rosenbrock_wanner_docstring(description::String,
end

generic_solver_docstring(
description, name, "Rosenbrock-Wanner Method. ", references,
description, name, "Rosenbrock-Wanner-W(olfbrandt) Method. ", references,
keyword_default_description, keyword_default
)
end
Expand Down Expand Up @@ -202,7 +202,7 @@ function rosenbrock_docstring(description::String,
end

generic_solver_docstring(
description, name, "Rosenbrock Method. ", references,
description, name, "Rosenbrock-Wanner Method. ", references,
keyword_default_description, keyword_default
)
end
Expand Down
2 changes: 1 addition & 1 deletion lib/OrdinaryDiffEqRosenbrock/src/algorithms.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ function GeneralRosenbrock(; chunk_size = Val{0}(), autodiff = true,
factorization)
end

@doc rosenbrock_wanner_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
A 4th order L-stable Rosenbrock-W method (fixed step only).
""",
Expand Down
32 changes: 16 additions & 16 deletions lib/OrdinaryDiffEqRosenbrock/src/generic_rosenbrock.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -911,7 +911,7 @@ function ROS2Tableau() # 2nd order
RosenbrockAdaptiveTableau(a,C,b,btilde,gamma,d,c)
end

@doc rosenbrock_wanner_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
An Order 2/3 L-Stable Rosenbrock-W method which is good for very stiff equations with oscillations at low tolerances. 2nd order stiff-aware interpolation.
""",
Expand All @@ -922,7 +922,7 @@ Scientific Computing, 18 (1), pp. 1-22.
""",
with_step_limiter = true) Rosenbrock23

@doc rosenbrock_wanner_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
An Order 3/2 A-Stable Rosenbrock-W method which is good for mildly stiff equations without oscillations at low tolerances. Note that this method is prone to instability in the presence of oscillations, so use with caution. 2nd order stiff-aware interpolation.
""",
Expand All @@ -944,7 +944,7 @@ references = """
""",
with_step_limiter = true) ROS3P

@doc rosenbrock_wanner_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
An Order 2/3 L-Stable Rosenbrock-W method for stiff ODEs and DAEs in mass matrix form. 2nd order stiff-aware interpolation and additional error test for interpolation.
""",
Expand All @@ -955,7 +955,7 @@ references = """
""",
with_step_limiter = true) Rodas23W

@doc rosenbrock_wanner_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
A 4th order L-stable Rosenbrock-W method.
""",
Expand All @@ -971,7 +971,7 @@ references = """
publisher={Springer}}
""") ROS34PW1a

@doc rosenbrock_wanner_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
A 4th order L-stable Rosenbrock-W method.
""",
Expand All @@ -987,7 +987,7 @@ references = """
publisher={Springer}}
""") ROS34PW1b

@doc rosenbrock_wanner_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
A 4th order stiffy accurate Rosenbrock-W method for PDAEs.
""",
Expand All @@ -1003,7 +1003,7 @@ references = """
publisher={Springer}}
""") ROS34PW2

@doc rosenbrock_wanner_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
A 4th order strongly A-stable (Rinf~0.63) Rosenbrock-W method.
""",
Expand Down Expand Up @@ -1088,7 +1088,7 @@ references = """
""",
with_step_limiter=true) Rodas42

@doc rosenbrock_wanner_docstring(
@doc rosenbrock_docstring(
"""
4th order A-stable stiffly stable Rosenbrock method with a stiff-aware 3rd order interpolant. 4th order
on linear parabolic problems and 3rd order accurate on nonlinear parabolic problems (as opposed to
Expand All @@ -1102,7 +1102,7 @@ references = """
""",
with_step_limiter=true) Rodas4P

@doc rosenbrock_wanner_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
A 4th order L-stable stiffly stable Rosenbrock method with a stiff-aware 3rd order interpolant. 4th order
on linear parabolic problems and 3rd order accurate on nonlinear parabolic problems. It is an improvement
Expand All @@ -1128,7 +1128,7 @@ references = """
""",
with_step_limiter=true) Rodas5

@doc rosenbrock_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
A 5th order A-stable stiffly stable Rosenbrock method with a stiff-aware 4th order interpolant.
Has improved stability in the adaptive time stepping embedding.
Expand All @@ -1141,7 +1141,7 @@ references = """
""",
with_step_limiter=true) Rodas5P

@doc rosenbrock_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
A 5th order A-stable stiffly stable Rosenbrock method with a stiff-aware 4th order interpolant.
Has improved stability in the adaptive time stepping embedding.
Expand All @@ -1154,7 +1154,7 @@ references = """
""",
with_step_limiter=true) Rodas5Pr

@doc rosenbrock_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
A 5th order A-stable stiffly stable Rosenbrock method with a stiff-aware 4th order interpolant.
Has improved stability in the adaptive time stepping embedding.
Expand Down Expand Up @@ -1200,7 +1200,7 @@ references = """
""",
with_step_limiter=true) Veldd4

@doc rosenbrock_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
A 4th order A-stable Rosenbrock method.
""",
Expand Down Expand Up @@ -1324,7 +1324,7 @@ function ROS2STableau() # 2nd order
RosenbrockAdaptiveTableau(a,C,b,btilde,gamma,d,c)
end

@doc rosenbrock_wanner_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
2nd order stiffly accurate Rosenbrock-Wanner W-method with 3 internal stages with B_PR consistent of order 2 with (Rinf=0).
""",
Expand Down Expand Up @@ -1619,7 +1619,7 @@ function ROS34PRwTableau() # 3rd order
RosenbrockAdaptiveTableau(a,C,b,btilde,gamma,d,c)
end

@doc rosenbrock_wanner_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
3rd order stiffly accurate Rosenbrock-Wanner W-method with 4 internal stages,
B_PR consistent of order 2.
Expand Down Expand Up @@ -1736,7 +1736,7 @@ function ROK4aTableau() # 4rd order
RosenbrockAdaptiveTableau(a,C,b,btilde,gamma,d,c)
end

@doc rosenbrock_wanner_docstring(
@doc rosenbrock_wolfbrandt_docstring(
"""
4rd order L-stable Rosenbrock-Krylov method with 4 internal stages,
with a 3rd order embedded method which is strongly A-stable with Rinf~=0.55. (when using exact Jacobians)
Expand Down
Loading