Skip to content

Commit

Permalink
build based on 501ba3a
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Mar 21, 2024
1 parent 57e9df2 commit 8d37b05
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion latest/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · GeometricSolutions.jl</title><script data-outdated-warner src="assets/warner.js"></script><link rel="canonical" href="https://JuliaGNI.github.io/GeometricSolutions.jl/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.044/juliamono.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>GeometricSolutions.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="/~https://github.com/JuliaGNI/GeometricSolutions.jl/blob/master/docs/src/index.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="GeometricSolutions"><a class="docs-heading-anchor" href="#GeometricSolutions">GeometricSolutions</a><a id="GeometricSolutions-1"></a><a class="docs-heading-anchor-permalink" href="#GeometricSolutions" title="Permalink"></a></h1><p>Documentation for <a href="/~https://github.com/JuliaGNI/GeometricSolutions.jl">GeometricSolutions</a>.</p><ul><li><a href="#GeometricSolutions.EnsembleSolution"><code>GeometricSolutions.EnsembleSolution</code></a></li><li><a href="#GeometricSolutions.GeometricSolution"><code>GeometricSolutions.GeometricSolution</code></a></li></ul><article class="docstring"><header><a class="docstring-binding" id="GeometricSolutions.EnsembleSolution" href="#GeometricSolutions.EnsembleSolution"><code>GeometricSolutions.EnsembleSolution</code></a> — <span class="docstring-category">Type</span></header><section><div><p><code>EnsembleSolution</code>: Collection of all solutions of an <code>EnsembleProblem</code>.</p></div><a class="docs-sourcelink" target="_blank" href="/~https://github.com/JuliaGNI/GeometricSolutions.jl/blob/e494a5f8d414ddc611389c5cf5004ef313053042/src/ensemble_solution.jl#L1-L3">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="GeometricSolutions.GeometricSolution" href="#GeometricSolutions.GeometricSolution"><code>GeometricSolutions.GeometricSolution</code></a> — <span class="docstring-category">Type</span></header><section><div><p><code>GeometricSolution</code>: Solution of a geometric differential equation</p><p>Contains all fields necessary to store the solution of a GeometricProblem.</p><p><strong>Fields</strong></p><ul><li><code>t</code>: time steps</li><li><code>s</code>: NamedTuple of DataSeries for each solution component</li><li><code>step</code>: store every step&#39;th time step (default: 1)</li><li><code>nstore</code>: number of time steps to store</li><li><code>offset</code>: offset of current time step</li></ul><p><strong>Constructors</strong></p><pre><code class="language-julia hljs">GeometricSolution(problem; step=1)</code></pre><p>The usual way to initialise a <code>Solution</code> is by passing a <a href="@ref"><code>GeometricProblem</code></a>, which can for example be an <a href="@ref"><code>ODEProblem</code></a> or <a href="@ref"><code>PODEProblem</code></a>. The optional parameter <code>step</code> determines the intervals for storing the solution, i.e., if <code>store &gt; 1</code> only every <code>store</code>&#39;th solution is actually stored.</p></div><a class="docs-sourcelink" target="_blank" href="/~https://github.com/JuliaGNI/GeometricSolutions.jl/blob/e494a5f8d414ddc611389c5cf5004ef313053042/src/geometric_solution.jl#L1-L25">source</a></section></article></article><nav class="docs-footer"><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.16 on <span class="colophon-date" title="Tuesday 19 March 2024 16:04">Tuesday 19 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Home · GeometricSolutions.jl</title><script data-outdated-warner src="assets/warner.js"></script><link rel="canonical" href="https://JuliaGNI.github.io/GeometricSolutions.jl/"/><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.044/juliamono.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.11/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="assets/documenter.js"></script><script src="siteinfo.js"></script><script src="../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><div class="docs-package-name"><span class="docs-autofit"><a href>GeometricSolutions.jl</a></span></div><form class="docs-search" action="search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li class="is-active"><a class="tocitem" href>Home</a></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>Home</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Home</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="/~https://github.com/JuliaGNI/GeometricSolutions.jl/blob/master/docs/src/index.md#" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="GeometricSolutions"><a class="docs-heading-anchor" href="#GeometricSolutions">GeometricSolutions</a><a id="GeometricSolutions-1"></a><a class="docs-heading-anchor-permalink" href="#GeometricSolutions" title="Permalink"></a></h1><p>Documentation for <a href="/~https://github.com/JuliaGNI/GeometricSolutions.jl">GeometricSolutions</a>.</p><ul><li><a href="#GeometricSolutions.EnsembleSolution"><code>GeometricSolutions.EnsembleSolution</code></a></li><li><a href="#GeometricSolutions.GeometricSolution"><code>GeometricSolutions.GeometricSolution</code></a></li></ul><article class="docstring"><header><a class="docstring-binding" id="GeometricSolutions.EnsembleSolution" href="#GeometricSolutions.EnsembleSolution"><code>GeometricSolutions.EnsembleSolution</code></a> — <span class="docstring-category">Type</span></header><section><div><p><code>EnsembleSolution</code>: Collection of all solutions of an <code>EnsembleProblem</code>.</p></div><a class="docs-sourcelink" target="_blank" href="/~https://github.com/JuliaGNI/GeometricSolutions.jl/blob/501ba3a9f8869e687137e22f330bfbd3b8ce1fba/src/ensemble_solution.jl#L1-L3">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="GeometricSolutions.GeometricSolution" href="#GeometricSolutions.GeometricSolution"><code>GeometricSolutions.GeometricSolution</code></a> — <span class="docstring-category">Type</span></header><section><div><p><code>GeometricSolution</code>: Solution of a geometric differential equation</p><p>Contains all fields necessary to store the solution of a GeometricProblem.</p><p><strong>Fields</strong></p><ul><li><code>t</code>: time steps</li><li><code>s</code>: NamedTuple of DataSeries for each solution component</li><li><code>step</code>: store every step&#39;th time step (default: 1)</li><li><code>nstore</code>: number of time steps to store</li><li><code>offset</code>: offset of current time step</li></ul><p><strong>Constructors</strong></p><pre><code class="language-julia hljs">GeometricSolution(problem; step=1)</code></pre><p>The usual way to initialise a <code>Solution</code> is by passing a <a href="@ref"><code>GeometricProblem</code></a>, which can for example be an <a href="@ref"><code>ODEProblem</code></a> or <a href="@ref"><code>PODEProblem</code></a>. The optional parameter <code>step</code> determines the intervals for storing the solution, i.e., if <code>store &gt; 1</code> only every <code>store</code>&#39;th solution is actually stored.</p></div><a class="docs-sourcelink" target="_blank" href="/~https://github.com/JuliaGNI/GeometricSolutions.jl/blob/501ba3a9f8869e687137e22f330bfbd3b8ce1fba/src/geometric_solution.jl#L1-L25">source</a></section></article></article><nav class="docs-footer"><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.16 on <span class="colophon-date" title="Thursday 21 March 2024 14:28">Thursday 21 March 2024</span>. Using Julia version 1.10.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 8d37b05

Please sign in to comment.