Revert "Revive SSPKnoth"

This reverts commit bbe3545. Merged by accident
CliMA · Jun 3, 2024 · 040572c · 040572c
1 parent da80de6
commit 040572c
Show file tree

Hide file tree

Showing 16 changed files with 331 additions and 940 deletions.
diff --git a/docs/Manifest.toml b/docs/Manifest.toml
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -11,10 +11,8 @@ Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
 Krylov = "ba0b0d4f-ebba-5204-a429-3ac8c609bfb7"
 LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f"
-Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 NVTX = "5da4648a-3479-48b8-97b9-01cb529c0a1f"
 Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
 PrettyTables = "08abe8d2-0d0c-5749-adfa-8a2ac140af0d"
 Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
-SciMLBase = "0bca4576-84f4-4d90-8ffe-ffa030f20462"
 StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,22 +1,5 @@
 using Documenter, DocumenterCitations
 using ClimaTimeSteppers
-using Literate
-
-tutorial_basedir = "tutorials"
-tutorial_basedir_from_here = joinpath(@__DIR__, "src", tutorial_basedir)
-
-jl_files_in_basedir = filter(endswith(".jl"), readdir(tutorial_basedir_from_here))
-
-println("Building literate tutorials...")
-generated_tutorials = String[]
-for filename in jl_files_in_basedir
-    Literate.markdown(
-        joinpath(tutorial_basedir_from_here, filename),
-        tutorial_basedir_from_here;
-        flavor = Literate.CommonMarkFlavor(),
-    )
-    push!(generated_tutorials, joinpath(tutorial_basedir, replace(filename, ".jl" => ".md")))
-end
 
 # https://github.com/jheinen/GR.jl/issues/278#issuecomment-587090846
 ENV["GKSwstype"] = "nul"
@@ -29,14 +12,12 @@ pages = [
     "Algorithm Formulations" => [
         "ODE Solvers" => "algorithm_formulations/ode_solvers.md",
         "Newtons Method" => "algorithm_formulations/newtons_method.md",
-        "Rosenbrock Method" => "algorithm_formulations/rosenbrock.md",
         "Old LSRK Formulations" => "algorithm_formulations/lsrk.md",
         "Old MRRK Formulations" => "algorithm_formulations/mrrk.md",
     ],
     "Test problems" => [
         "test_problems/index.md",
     ],
-    "Tutorials" => generated_tutorials,
     "API docs" => [
         "ODE Solvers" => "api/ode_solvers.md",
         "Newtons Method" => "api/newtons_method.md",

diff --git a/docs/src/algorithm_formulations/rosenbrock.md b/docs/src/algorithm_formulations/rosenbrock.md
diff --git a/docs/src/api/ode_solvers.md b/docs/src/api/ode_solvers.md
@@ -51,7 +51,6 @@ HOMMEM1
 ARK2GKC
 ARK437L2SA1
 ARK548L2SA2
-SSPKnoth
 ```
 
 ## Explicit Algorithm Names

diff --git a/docs/src/dev/report_gen.jl b/docs/src/dev/report_gen.jl
@@ -17,10 +17,6 @@ let # Convergence
     title = "All Algorithms"
     algorithm_names = map(T -> T(), all_subtypes(ClimaTimeSteppers.AbstractAlgorithmName))
     algorithm_names = filter(name -> !(name isa ARK437L2SA1 || name isa ARK548L2SA2), algorithm_names) # too high order
-
-    # NOTE: Some imperfections in the convergence order for SSPKnoth are to be
-    # expected because we are not using the exact Jacobian
-
     verify_convergence(title, algorithm_names, ark_analytic_nonlin_test_cts(Float64), 200)
     verify_convergence(title, algorithm_names, ark_analytic_sys_test_cts(Float64), 400)
     verify_convergence(title, algorithm_names, ark_analytic_test_cts(Float64), 40000; super_convergence = (ARS121(),))
@@ -33,8 +29,6 @@ let # Convergence
         num_steps_scaling_factor = 4,
         numerical_reference_algorithm_name = ARS343(),
     )
-    rosenbrock_schems = filter(name -> name isa ClimaTimeSteppers.RosenbrockAlgorithmName, algorithm_names)
-    verify_convergence(title, rosenbrock_schems, climacore_1Dheat_test_implicit_cts(Float64), 400)
     verify_convergence(
         title,
         algorithm_names,

diff --git a/docs/src/plotting_utils.jl b/docs/src/plotting_utils.jl
@@ -59,8 +59,6 @@ imex_convergence_orders(::ARK548L2SA2) = (5, 5, 5)
 imex_convergence_orders(::SSP22Heuns) = (2, 2, 2)
 imex_convergence_orders(::SSP33ShuOsher) = (3, 3, 3)
 imex_convergence_orders(::RK4) = (4, 4, 4)
-# SSPKnoth is not really an IMEX method
-imex_convergence_orders(::SSPKnoth) = (2, 2, 2)
 
 # Compute a confidence interval for the convergence order, returning the
 # estimated convergence order and its uncertainty.
@@ -115,8 +113,6 @@ function verify_convergence(
     default_dt = t_end / num_steps
 
     algorithm(algorithm_name::ClimaTimeSteppers.ERKAlgorithmName) = ExplicitAlgorithm(algorithm_name)
-    algorithm(algorithm_name::ClimaTimeSteppers.SSPKnoth) =
-        ClimaTimeSteppers.RosenbrockAlgorithm(ClimaTimeSteppers.tableau(ClimaTimeSteppers.SSPKnoth()))
     algorithm(algorithm_name::ClimaTimeSteppers.IMEXARKAlgorithmName) =
         IMEXAlgorithm(algorithm_name, NewtonsMethod(; max_iters = linear_implicit ? 1 : 2))