build based on 4b9f120

dev/alg_dev/benchmarks/index.html

@@ -17,4 +17,4 @@
 wp = WorkPrecision(prob, DP5(), abstols, reltols; name = &quot;Dormand-Prince 4/5&quot;)</code></pre><p>If we want to plot many WorkPrecisions together in order to compare between algorithms, you can make a WorkPrecisionSet. To do so, you pass the setups into the function as well:</p><pre><code class="language-julia hljs">wp_set = WorkPrecisionSet(prob, tspan, abstols, reltols, setups; numruns = 2)
 setups = [Dict(:alg =&gt; RK4()); Dict(:alg =&gt; Euler()); Dict(:alg =&gt; BS3());
           Dict(:alg =&gt; Midpoint()); Dict(:alg =&gt; BS5()); Dict(:alg =&gt; DP5())]
-wp_set = WorkPrecisionSet(prob, abstols, reltols, setups; dt = 1 / 2^4, numruns = 2)</code></pre><p>Both of these types have a plot recipe to produce a work-precision diagram, and a print which will show some relevant information.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../convergence/">« Convergence Simulations</a><a class="docs-footer-nextpage" href="../../internals/notes_on_algorithms/">Notes on Algorithms »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Monday 4 March 2024 19:48">Monday 4 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+wp_set = WorkPrecisionSet(prob, abstols, reltols, setups; dt = 1 / 2^4, numruns = 2)</code></pre><p>Both of these types have a plot recipe to produce a work-precision diagram, and a print which will show some relevant information.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../convergence/">« Convergence Simulations</a><a class="docs-footer-nextpage" href="../../internals/notes_on_algorithms/">Notes on Algorithms »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 2 April 2024 00:58">Tuesday 2 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/alg_dev/test_problems/index.html

@@ -12,4 +12,4 @@
 (T::TestSolution)(t) = T.interp(t)
 TestSolution(t, u) = TestSolution(t, u, nothing, false)
 TestSolution(t, u, interp) = TestSolution(t, u, interp, true)
-TestSolution(interp::DESolution) = TestSolution(nothing, nothing, interp, true)</code></pre><p>This acts like a solution. When used in conjunction with <code>apprxtrue</code>:</p><pre><code class="language-julia hljs">appxtrue(sol::AbstractODESolution, sol2::TestSolution)</code></pre><p>you can use it to build a <code>TestSolution</code> from a problem (like <code>ODETestSolution</code>) which holds the errors  If you only give it <code>t</code> and <code>u</code>, then it can only calculate the final error. If the <code>TestSolution</code> has an interpolation, it will define timeseries and dense errors.</p><p>(Note: I would like it so that way the timeseries error will be calculated on the times of <code>sol.t in sol2.t</code> which would act nicely with <code>tstops</code> and when interpolations don&#39;t exist, but haven&#39;t gotten to it!)</p><p>These can then be passed to other functionality. For example, the benchmarking functions allow one to set <code>appxsol</code> which is a <code>TestSolution</code> for the benchmark solution to calculate errors against, and <code>error_estimate</code> allows one to choose which error estimate to use in the benchmarking (defaults to <code>:final</code>).</p><h2 id="Related-Functions"><a class="docs-heading-anchor" href="#Related-Functions">Related Functions</a><a id="Related-Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Related-Functions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="DiffEqDevTools.appxtrue" href="#DiffEqDevTools.appxtrue"><code>DiffEqDevTools.appxtrue</code></a> — <span class="docstring-category">Function</span></header><section><div><p><code>appxtrue(sol::AbstractODESolution,sol2::TestSolution)</code></p><p>Uses the interpolant from the higher order solution sol2 to approximate errors for sol. If sol2 has no interpolant, only the final error is calculated.</p></div></section><section><div><p><code>appxtrue(sol::AbstractODESolution,sol2::AbstractODESolution)</code></p><p>Uses the interpolant from the higher order solution sol2 to approximate errors for sol. If sol2 has no interpolant, only the final error is calculated.</p></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../contributing/type_traits/">« Type Traits</a><a class="docs-footer-nextpage" href="../convergence/">Convergence Simulations »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Monday 4 March 2024 19:48">Monday 4 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+TestSolution(interp::DESolution) = TestSolution(nothing, nothing, interp, true)</code></pre><p>This acts like a solution. When used in conjunction with <code>apprxtrue</code>:</p><pre><code class="language-julia hljs">appxtrue(sol::AbstractODESolution, sol2::TestSolution)</code></pre><p>you can use it to build a <code>TestSolution</code> from a problem (like <code>ODETestSolution</code>) which holds the errors  If you only give it <code>t</code> and <code>u</code>, then it can only calculate the final error. If the <code>TestSolution</code> has an interpolation, it will define timeseries and dense errors.</p><p>(Note: I would like it so that way the timeseries error will be calculated on the times of <code>sol.t in sol2.t</code> which would act nicely with <code>tstops</code> and when interpolations don&#39;t exist, but haven&#39;t gotten to it!)</p><p>These can then be passed to other functionality. For example, the benchmarking functions allow one to set <code>appxsol</code> which is a <code>TestSolution</code> for the benchmark solution to calculate errors against, and <code>error_estimate</code> allows one to choose which error estimate to use in the benchmarking (defaults to <code>:final</code>).</p><h2 id="Related-Functions"><a class="docs-heading-anchor" href="#Related-Functions">Related Functions</a><a id="Related-Functions-1"></a><a class="docs-heading-anchor-permalink" href="#Related-Functions" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="DiffEqDevTools.appxtrue" href="#DiffEqDevTools.appxtrue"><code>DiffEqDevTools.appxtrue</code></a> — <span class="docstring-category">Function</span></header><section><div><p><code>appxtrue(sol::AbstractODESolution,sol2::TestSolution)</code></p><p>Uses the interpolant from the higher order solution sol2 to approximate errors for sol. If sol2 has no interpolant, only the final error is calculated.</p></div></section><section><div><p><code>appxtrue(sol::AbstractODESolution,sol2::AbstractODESolution)</code></p><p>Uses the interpolant from the higher order solution sol2 to approximate errors for sol. If sol2 has no interpolant, only the final error is calculated.</p></div></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../contributing/type_traits/">« Type Traits</a><a class="docs-footer-nextpage" href="../convergence/">Convergence Simulations »</a><div class="flexbox-break"></div><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Tuesday 2 April 2024 00:58">Tuesday 2 April 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>