Skip to content

Commit

Permalink
build based on cbb6f2c
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 24, 2023
1 parent b15ae3c commit 71c0083
Show file tree
Hide file tree
Showing 47 changed files with 386 additions and 392 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2023-10-23T00:10:39","documenter_version":"1.1.1"}}
{"documenter":{"julia_version":"1.6.7","generation_timestamp":"2023-10-24T21:18:10","documenter_version":"1.1.2"}}
2 changes: 1 addition & 1 deletion dev/api/diagnostics/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api/index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/api/io/index.html

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions dev/api/numerics/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api/physics/heat_conduction/index.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions dev/api/physics/hydrology/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api/physics/salt/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api/physics/seb/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api/physics/snow/index.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions dev/api/physics/soils/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api/presets/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api/solvers/basic_solvers/index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/api/solvers/diffeq/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api/solvers/lite_implicit/index.html

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/api/tiles/index.html

Large diffs are not rendered by default.

28 changes: 14 additions & 14 deletions dev/api/toplevel/index.html

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions dev/api/utils/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/dev/concepts/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,4 @@

computediagnostic!(Layer1(), MyProcess() state)
computediagnostic!(Layer2(), MyProcess(), state)</code></pre><p>Output:</p><pre><code class="nohighlight hljs">hello MyProcess on any SubSurface
hello MyProcess on Bar</code></pre><p>Thus, multiple dispatch allows us to write generic code in <code>computediagnostic!</code> that implements <code>MyProcess</code> for any <code>SubSurface</code> layer (i.e. the parent type of both <code>Foo</code> and <code>Bar</code>) in addition to adding specialized code for more specific layer types.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../manual/coupling/">« Coupling layers and processes</a><a class="docs-footer-nextpage" href="../debugging/">Debugging »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.1 on <span class="colophon-date" title="Monday 23 October 2023 00:10">Monday 23 October 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
hello MyProcess on Bar</code></pre><p>Thus, multiple dispatch allows us to write generic code in <code>computediagnostic!</code> that implements <code>MyProcess</code> for any <code>SubSurface</code> layer (i.e. the parent type of both <code>Foo</code> and <code>Bar</code>) in addition to adding specialized code for more specific layer types.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../manual/coupling/">« Coupling layers and processes</a><a class="docs-footer-nextpage" href="../debugging/">Debugging »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Tuesday 24 October 2023 21:18">Tuesday 24 October 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/dev/contributing/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/dev/debugging/index.html

Large diffs are not rendered by default.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion dev/examples/heat_freeW_bucketW_samoylov/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@
water_mass = Diagnostics.integrate(out.θwi, tile.grid)
Δwater = water_mass[end] - water_mass[1]</code></pre><p>Plot the results:</p><pre><code class="language-julia hljs">import Plots
zs = [1,5,9,15,21,25,33,55,65,75,100]u&quot;cm&quot;
cg = Plots.cgrad(:copper,rev=true);</code></pre><p>Temperature:</p><pre><code class="language-julia hljs">Plots.plot(out.T[Z(Near(zs))], color=cg[LinRange(0.0,1.0,length(zs))]&#39;, ylabel=&quot;Temperature&quot;, leg=false, size=(800,500), dpi=150)</code></pre><img src="80ccec9b.svg" alt="Example block output"/><p>Liquid water:</p><pre><code class="language-julia hljs">Plots.plot(out.θw[Z(Near(zs))], color=cg[LinRange(0.0,1.0,length(zs))]&#39;, ylabel=&quot;Unfrozen water content&quot;, leg=false, size=(800,500), dpi=150)</code></pre><img src="49886215.svg" alt="Example block output"/><p>Saturation:</p><pre><code class="language-julia hljs">Plots.plot(out.sat[Z(Near(zs))], color=cg[LinRange(0.0,1.0,length(zs))]&#39;, ylabel=&quot;Saturation&quot;, leg=false, size=(800,500), dpi=150)</code></pre><img src="343cf473.svg" alt="Example block output"/><p>Runoff:</p><pre><code class="language-julia hljs">Plots.plot(out.top.runoff[1,:], ylabel=&quot;Runoff&quot;)</code></pre><img src="1c50c2cf.svg" alt="Example block output"/><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../dev/contributing/">« Contributing</a><a class="docs-footer-nextpage" href="../heat_freeW_lite_implicit/">Fast heat conduction with CryoGridLite »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.1 on <span class="colophon-date" title="Monday 23 October 2023 00:10">Monday 23 October 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
cg = Plots.cgrad(:copper,rev=true);</code></pre><p>Temperature:</p><pre><code class="language-julia hljs">Plots.plot(out.T[Z(Near(zs))], color=cg[LinRange(0.0,1.0,length(zs))]&#39;, ylabel=&quot;Temperature&quot;, leg=false, size=(800,500), dpi=150)</code></pre><img src="f25f2bd6.svg" alt="Example block output"/><p>Liquid water:</p><pre><code class="language-julia hljs">Plots.plot(out.θw[Z(Near(zs))], color=cg[LinRange(0.0,1.0,length(zs))]&#39;, ylabel=&quot;Unfrozen water content&quot;, leg=false, size=(800,500), dpi=150)</code></pre><img src="d3375c29.svg" alt="Example block output"/><p>Saturation:</p><pre><code class="language-julia hljs">Plots.plot(out.sat[Z(Near(zs))], color=cg[LinRange(0.0,1.0,length(zs))]&#39;, ylabel=&quot;Saturation&quot;, leg=false, size=(800,500), dpi=150)</code></pre><img src="fdd3bee6.svg" alt="Example block output"/><p>Runoff:</p><pre><code class="language-julia hljs">Plots.plot(out.top.runoff[1,:], ylabel=&quot;Runoff&quot;)</code></pre><img src="45df0218.svg" alt="Example block output"/><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../dev/contributing/">« Contributing</a><a class="docs-footer-nextpage" href="../heat_freeW_lite_implicit/">Fast heat conduction with CryoGridLite »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Tuesday 24 October 2023 21:18">Tuesday 24 October 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 2 additions & 8 deletions dev/examples/heat_freeW_lite_implicit/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,5 @@
</code></pre><p>Plot the results!</p><pre><code class="language-julia hljs">import Plots
zs = [5,10,15,20,25,30,40,50,100,500,1000,5000]u&quot;cm&quot;
cg = Plots.cgrad(:copper,rev=true);
Plots.plot(out.T[Z(Near(zs))], color=cg[LinRange(0.0,1.0,length(zs))]&#39;, ylabel=&quot;Temperature&quot;, title=&quot;&quot;, leg=false, dpi=150)</code></pre><img src="f6a3f4b9.svg" alt="Example block output"/><p>CryoGridLite can also be embedded into integrators from OrdinaryDiffEq.jl via the <code>NLCGLite</code> nonlinear solver interface. Note that these sovers generally will not be faster (in execution time) but may be more stable in some cases. Adaptive timestepping can be employed by removing the <code>adaptive=false</code> argument.</p><pre><code class="language-julia hljs">using OrdinaryDiffEq
sol2 = @time solve(prob, ImplicitEuler(nlsolve=NLCGLite()), adaptive=false, dt=24*3600.0, saveat=24*3600);
# 3rd order additive scheme from Kennedy and Alan 2001
sol3 = @time solve(prob, KenCarp3(nlsolve=NLCGLite()), adaptive=false, dt=24*3600.0);
# Fixed leading coefficient backwards-eifferentiation scheme, similar to Sundials CVODE_BDF
sol4 = @time solve(prob, FBDF(nlsolve=NLCGLite()), adaptive=false, dt=24*3600.0);</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">296.098111 seconds (80.02 M allocations: 56.795 GiB, 1.52% gc time)
9335.252400 seconds (955.22 M allocations: 2.780 TiB, 1.32% gc time, 0.01% compilation time)
271.579762 seconds (40.26 M allocations: 53.599 GiB, 1.07% gc time, 0.14% compilation time)</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../heat_freeW_bucketW_samoylov/">« Soil heat with bucket water scheme</a><a class="docs-footer-nextpage" href="../heat_freeW_samoylov/">Soil heat with free water freeze curve »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.1 on <span class="colophon-date" title="Monday 23 October 2023 00:10">Monday 23 October 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Plots.plot(out.T[Z(Near(zs))], color=cg[LinRange(0.0,1.0,length(zs))]&#39;, ylabel=&quot;Temperature&quot;, title=&quot;&quot;, leg=false, dpi=150)</code></pre><img src="00269547.svg" alt="Example block output"/><p>CryoGridLite can also be embedded into integrators from OrdinaryDiffEq.jl via the <code>NLCGLite</code> nonlinear solver interface. Note that these sovers generally will not be faster (in execution time) but may be more stable in some cases. Adaptive timestepping can be employed by removing the <code>adaptive=false</code> argument.</p><pre><code class="language-julia hljs">using OrdinaryDiffEq
sol2 = @time solve(prob, ImplicitEuler(nlsolve=NLCGLite()), adaptive=false, dt=24*3600.0, saveat=24*3600);</code></pre><pre class="documenter-example-output"><code class="nohighlight hljs ansi">295.720159 seconds (85.10 M allocations: 56.901 GiB, 1.97% gc time)</code></pre><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../heat_freeW_bucketW_samoylov/">« Soil heat with bucket water scheme</a><a class="docs-footer-nextpage" href="../heat_freeW_samoylov/">Soil heat with free water freeze curve »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Tuesday 24 October 2023 21:18">Tuesday 24 October 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion dev/examples/heat_freeW_samoylov/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
</code></pre><p>Now we plot the reuslts!</p><pre><code class="language-julia hljs">import Plots
zs = [1,10,20,30,50,100,200,500,1000]u&quot;cm&quot;
cg = Plots.cgrad(:copper,rev=true);
Plots.plot(out.T[Z(Near(zs))], color=cg[LinRange(0.0,1.0,length(zs))]&#39;, ylabel=&quot;Temperature&quot;, leg=false, size=(800,500), dpi=150)</code></pre><img src="d3c9a8e7.svg" alt="Example block output"/><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../heat_freeW_lite_implicit/">« Fast heat conduction with CryoGridLite</a><a class="docs-footer-nextpage" href="../heat_freeW_seb_snow_bucketW_samoylov/">Soil heat w/ SEB, snow cover, and bucket water scheme »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.1 on <span class="colophon-date" title="Monday 23 October 2023 00:10">Monday 23 October 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Plots.plot(out.T[Z(Near(zs))], color=cg[LinRange(0.0,1.0,length(zs))]&#39;, ylabel=&quot;Temperature&quot;, leg=false, size=(800,500), dpi=150)</code></pre><img src="fb22d4b1.svg" alt="Example block output"/><hr/><p><em>This page was generated using <a href="https://github.com/fredrikekre/Literate.jl">Literate.jl</a>.</em></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../heat_freeW_lite_implicit/">« Fast heat conduction with CryoGridLite</a><a class="docs-footer-nextpage" href="../heat_freeW_seb_snow_bucketW_samoylov/">Soil heat w/ SEB, snow cover, and bucket water scheme »</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><option value="auto">Automatic (OS)</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.1.2 on <span class="colophon-date" title="Tuesday 24 October 2023 21:18">Tuesday 24 October 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 71c0083

Please sign in to comment.