Skip to content

Commit

Permalink
build based on 849ecd2
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 15, 2024
1 parent 28a0606 commit 1d0d28c
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion dev/.documenter-siteinfo.json
View file
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-10-15T12:22:32","documenter_version":"1.7.0"}}
{"documenter":{"julia_version":"1.10.4","generation_timestamp":"2024-10-15T12:43:01","documenter_version":"1.7.0"}}
2 changes: 1 addition & 1 deletion dev/api/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>API · GeMotion.jl</title><meta name="title" content="API · GeMotion.jl"/><meta property="og:title" content="API · GeMotion.jl"/><meta property="twitter:title" content="API · GeMotion.jl"/><meta name="description" content="Documentation for GeMotion.jl."/><meta property="og:description" content="Documentation for GeMotion.jl."/><meta property="twitter:description" content="Documentation for GeMotion.jl."/><script data-outdated-warner src="../assets/warner.js"></script><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="../search_index.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/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><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"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt="GeMotion.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">GeMotion.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#API"><span>API</span></a></li><li><a class="tocitem" href="#Index"><span>Index</span></a></li></ul></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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Developer-Documentation"><a class="docs-heading-anchor" href="#Developer-Documentation">Developer Documentation</a><a id="Developer-Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Developer-Documentation" title="Permalink"></a></h1><h2 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GeMotion.simulate-Tuple{}" href="#GeMotion.simulate-Tuple{}"><code>GeMotion.simulate</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">simulate(;name=&quot;sim&quot;,Pr=1.0,Ra=1.0,n=1.0,n_elems=20,nlsolver_opts=(;show_trace=true,method=:newton,linesearch=BackTracking(),ftol=1E-8,xtol=1E-10),levels=(;T=5,psi=5,Sth=5,Sfl=5),T_diri_tags=[&quot;leftline&quot;,&quot;rightline&quot;,&quot;botleftpoint&quot;,&quot;botrightpoint&quot;,&quot;topleftpoint&quot;,&quot;toprightpoint&quot;],T_diri_expressions=[0.0,1.0,0.0,1.0,0.0,1.0])</code></pre><p>Simulate the flow in a square cavity with a moving lid and a temperature gradient.</p><p><strong>Arguments</strong></p><ul><li><code>name::String</code>: Name of the simulation.</li><li><code>Pr::Float64</code>: Prandtl number.</li><li><code>Ra::Float64</code>: Rayleigh number.</li><li><code>n::Float64</code>: Power of the viscosity.</li><li><code>n_elems::Int</code>: Number of elements in each direction.</li><li><code>nlsolver_opts::Dict</code>: Options for the nonlinear solver.</li><li><code>levels::Dict</code>: Levels for the contour plots.</li><li><code>T_diri_tags::Array{String}</code>: Tags for the Dirichlet boundary conditions for the temperature.</li><li><code>T_diri_expressions::Array{Float64}</code>: Expressions for the Dirichlet boundary conditions for the temperature.</li></ul><p><strong>Returns</strong></p><ul><li><code>uh::FEFunction</code>: Velocity field.</li><li><code>ph::FEFunction</code>: Pressure field.</li><li><code>Th::FEFunction</code>: Temperature field.</li><li><code>psih::FEFunction</code>: Stream function.</li><li><code>Nu::Interpolable</code>: Nusselt number.</li><li><code>Sth::FEFunction</code>: Local heat entropy.</li><li><code>Sfl::FEFunction</code>: Local fluid entropy.</li><li><code>btrian::BoundaryTriangulation</code>: Boundary triangulation.</li><li><code>model::CartesianDiscreteModel</code>: Model.</li><li><code>Ωₕ::Triangulation</code>: Triangulation.</li><li><code>Pr::Float64</code>: Prandtl number.</li><li><code>Ra::Float64</code>: Rayleigh number.</li></ul><p><strong>Example</strong></p><pre><code class="language-julia hljs">simulate(;name=&quot;sim&quot;,Pr=1.0,Ra=1.0,n=1.0,n_elems=20,nlsolver_opts=(;show_trace=true,method=:newton,linesearch=BackTracking(),ftol=1E-8,xtol=1E-10),levels=(;T=5,psi=5,Sth=5,Sfl=5),T_diri_tags=[&quot;leftline&quot;,&quot;rightline&quot;,&quot;botleftpoint&quot;,&quot;botrightpoint&quot;,&quot;topleftpoint&quot;,&quot;toprightpoint&quot;],T_diri_expressions=[0.0,1.0,0.0,1.0,0.0,1.0])</code></pre></div></section></article><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="#GeMotion.simulate-Tuple{}"><code>GeMotion.simulate</code></a></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 15 October 2024 12:22">Tuesday 15 October 2024</span>. Using Julia version 1.10.4.</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>API · GeMotion.jl</title><meta name="title" content="API · GeMotion.jl"/><meta property="og:title" content="API · GeMotion.jl"/><meta property="twitter:title" content="API · GeMotion.jl"/><meta name="description" content="Documentation for GeMotion.jl."/><meta property="og:description" content="Documentation for GeMotion.jl."/><meta property="twitter:description" content="Documentation for GeMotion.jl."/><script data-outdated-warner src="../assets/warner.js"></script><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.050/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.4.2/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.8/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="../search_index.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/catppuccin-mocha.css" data-theme-name="catppuccin-mocha"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-macchiato.css" data-theme-name="catppuccin-macchiato"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-frappe.css" data-theme-name="catppuccin-frappe"/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../assets/themes/catppuccin-latte.css" data-theme-name="catppuccin-latte"/><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"><a class="docs-logo" href="../"><img src="../assets/logo.png" alt="GeMotion.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">GeMotion.jl</a></span></div><button class="docs-search-query input is-rounded is-small is-clickable my-2 mx-auto py-1 px-2" id="documenter-search-query">Search docs (Ctrl + /)</button><ul class="docs-menu"><li><a class="tocitem" href="../">Home</a></li><li class="is-active"><a class="tocitem" href>API</a><ul class="internal"><li><a class="tocitem" href="#API"><span>API</span></a></li><li><a class="tocitem" href="#Index"><span>Index</span></a></li></ul></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"><a class="docs-sidebar-button docs-navbar-link fa-solid fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a><nav class="breadcrumb"><ul class="is-hidden-mobile"><li class="is-active"><a href>API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>API</a></li></ul></nav><div class="docs-right"><a class="docs-settings-button docs-navbar-link fa-solid fa-gear" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-article-toggle-button fa-solid fa-chevron-up" id="documenter-article-toggle-button" href="javascript:;" title="Collapse all docstrings"></a></div></header><article class="content" id="documenter-page"><h1 id="Developer-Documentation"><a class="docs-heading-anchor" href="#Developer-Documentation">Developer Documentation</a><a id="Developer-Documentation-1"></a><a class="docs-heading-anchor-permalink" href="#Developer-Documentation" title="Permalink"></a></h1><h2 id="API"><a class="docs-heading-anchor" href="#API">API</a><a id="API-1"></a><a class="docs-heading-anchor-permalink" href="#API" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-article-toggle-button fa-solid fa-chevron-down" href="javascript:;" title="Collapse docstring"></a><a class="docstring-binding" id="GeMotion.simulate-Tuple{}" href="#GeMotion.simulate-Tuple{}"><code>GeMotion.simulate</code></a> — <span class="docstring-category">Method</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">simulate(;name=&quot;sim&quot;,Pr=1.0,Ra=1.0,n=1.0,n_elems=20,nlsolver_opts=(;show_trace=true,method=:newton,linesearch=BackTracking(),ftol=1E-8,xtol=1E-10),levels=(;T=5,psi=5,Sth=5,Sfl=5),T_diri_tags=[&quot;leftline&quot;,&quot;rightline&quot;,&quot;botleftpoint&quot;,&quot;botrightpoint&quot;,&quot;topleftpoint&quot;,&quot;toprightpoint&quot;],T_diri_expressions=[0.0,1.0,0.0,1.0,0.0,1.0])</code></pre><p>Simulate the flow in a square cavity with a moving lid and a temperature gradient.</p><p><strong>Arguments</strong></p><ul><li><code>name::String</code>: Name of the simulation.</li><li><code>Pr::Float64</code>: Prandtl number.</li><li><code>Ra::Float64</code>: Rayleigh number.</li><li><code>n::Float64</code>: Power of the viscosity.</li><li><code>n_elems::Int</code>: Number of elements in each direction.</li><li><code>nlsolver_opts::Dict</code>: Options for the nonlinear solver.</li><li><code>levels::Dict</code>: Levels for the contour plots.</li><li><code>T_diri_tags::Array{String}</code>: Tags for the Dirichlet boundary conditions for the temperature.</li><li><code>T_diri_expressions::Array{Float64}</code>: Expressions for the Dirichlet boundary conditions for the temperature.</li></ul><p><strong>Returns</strong></p><ul><li><code>uh::FEFunction</code>: Velocity field.</li><li><code>ph::FEFunction</code>: Pressure field.</li><li><code>Th::FEFunction</code>: Temperature field.</li><li><code>psih::FEFunction</code>: Stream function.</li><li><code>Nu::Interpolable</code>: Nusselt number.</li><li><code>Sth::FEFunction</code>: Local heat entropy.</li><li><code>Sfl::FEFunction</code>: Local fluid entropy.</li><li><code>btrian::BoundaryTriangulation</code>: Boundary triangulation.</li><li><code>model::CartesianDiscreteModel</code>: Model.</li><li><code>Ωₕ::Triangulation</code>: Triangulation.</li><li><code>Pr::Float64</code>: Prandtl number.</li><li><code>Ra::Float64</code>: Rayleigh number.</li></ul><p><strong>Example</strong></p><pre><code class="language-julia hljs">simulate(;name=&quot;sim&quot;,Pr=1.0,Ra=1.0,n=1.0,n_elems=20,nlsolver_opts=(;show_trace=true,method=:newton,linesearch=BackTracking(),ftol=1E-8,xtol=1E-10),levels=(;T=5,psi=5,Sth=5,Sfl=5),T_diri_tags=[&quot;leftline&quot;,&quot;rightline&quot;,&quot;botleftpoint&quot;,&quot;botrightpoint&quot;,&quot;topleftpoint&quot;,&quot;toprightpoint&quot;],T_diri_expressions=[0.0,1.0,0.0,1.0,0.0,1.0])</code></pre></div></section></article><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="#GeMotion.simulate-Tuple{}"><code>GeMotion.simulate</code></a></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../">« Home</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Tuesday 15 October 2024 12:43">Tuesday 15 October 2024</span>. Using Julia version 1.10.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 1d0d28c

Please sign in to comment.