Skip to content

Commit

Permalink
build based on d38810c
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed May 28, 2024
1 parent 9ee7821 commit 546c654
Show file tree
Hide file tree
Showing 11 changed files with 12 additions and 16 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.10.3","generation_timestamp":"2024-05-23T13:59:35","documenter_version":"1.4.1"}}
{"documenter":{"julia_version":"1.10.3","generation_timestamp":"2024-05-28T19:03:02","documenter_version":"1.4.1"}}
2 changes: 1 addition & 1 deletion dev/index.html
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 · JustRelax.jl</title><meta name="title" content="Home · JustRelax.jl"/><meta property="og:title" content="Home · JustRelax.jl"/><meta property="twitter:title" content="Home · JustRelax.jl"/><meta name="description" content="Documentation for JustRelax.jl."/><meta property="og:description" content="Documentation for JustRelax.jl."/><meta property="twitter:description" content="Documentation for JustRelax.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/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>JustRelax.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 class="is-active"><a class="tocitem" href>Home</a></li><li><span class="tocitem">User guide</span><ul><li><a class="tocitem" href="man/installation/">Installation</a></li><li><a class="tocitem" href="man/backend/">Backend</a></li><li><a class="tocitem" href="man/equations/">Equations</a></li><li><a class="tocitem" href="man/advection/">Advection</a></li></ul></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="man/Blankenbach/">Blankenbach</a></li><li><a class="tocitem" href="man/ShearBands/">Shear Bands</a></li></ul></li><li><a class="tocitem" href="man/listfunctions/">List of functions</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"><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>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-navbar-link" href="https://github.com/PTsolvers/JustRelax.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/PTsolvers/JustRelax.jl/blob/main/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><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="JustRelax.jl"><a class="docs-heading-anchor" href="#JustRelax.jl">JustRelax.jl</a><a id="JustRelax.jl-1"></a><a class="docs-heading-anchor-permalink" href="#JustRelax.jl" title="Permalink"></a></h1><p>Need to solve a very large multi-physics problem on many GPUs in parallel? Just Relax!</p><p><code>JustRelax</code> is a collection of accelerated iterative pseudo-transient solvers using MPI and multiple CPU or GPU backends. It&#39;s part of the <a href="https://ptsolvers.github.io">PTSolvers organisation</a> and developed within the <a href="https://www.pasc-ch.org/projects/2021-2024/gpu4geo/">GPU4GEO project</a>. Current publications, outreach and news can be found on the <a href="https://ptsolvers.github.io/GPU4GEO/">GPU4GEO website</a>.</p><p>The package relies on other packages as building blocks and parallelisation tools:</p><ul><li><a href="https://github.com/omlins/ParallelStencil.jl">ParallelStencil.jl</a> - device agnostic parallel kernels</li><li><a href="https://github.com/omlins/ImplicitGlobalGrid.jl">ImplicitGlobalGrid.jl</a> - (CUDA-aware) MPI communication</li><li><a href="https://github.com/JuliaGeodynamics/GeoParams.jl">GeoParams.jl</a> - Material physics</li><li><a href="https://github.com/JuliaGeodynamics/JustPIC.jl">JustPIC.jl</a> - Particle-in-cell advection</li></ul><p>The package serves several purposes:</p><ul><li><p>It provides a collection of solvers to be used in quickly developing new applications</p></li><li><p>It provides some standardization so that application codes can</p><ul><li>more easily handle local material properties through the use of <a href="https://github.com/JuliaGeodynamics/GeoParams.jl">GeoParams.jl</a></li><li>more easily switch between a pseudo-transient solver and another solvers (e.g. an explicit thermal solvers)</li></ul></li><li><p>It provides a natural repository for contributions of new solvers for use by the larger community</p></li></ul><p>We provide several miniapps, each designed to solve a well-specified benchmark problem, in order to provide</p><ul><li>examples of usage in high-performance computing</li><li>basis on which to build more full-featured application codes</li><li>cases for reference and performance tests</li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/installation/">Installation »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Thursday 23 May 2024 13:59">Thursday 23 May 2024</span>. Using Julia version 1.10.3.</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 · JustRelax.jl</title><meta name="title" content="Home · JustRelax.jl"/><meta property="og:title" content="Home · JustRelax.jl"/><meta property="twitter:title" content="Home · JustRelax.jl"/><meta name="description" content="Documentation for JustRelax.jl."/><meta property="og:description" content="Documentation for JustRelax.jl."/><meta property="twitter:description" content="Documentation for JustRelax.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/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>JustRelax.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 class="is-active"><a class="tocitem" href>Home</a></li><li><span class="tocitem">User guide</span><ul><li><a class="tocitem" href="man/installation/">Installation</a></li><li><a class="tocitem" href="man/backend/">Backend</a></li><li><a class="tocitem" href="man/equations/">Equations</a></li><li><a class="tocitem" href="man/advection/">Advection</a></li></ul></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="man/Blankenbach/">Blankenbach</a></li><li><a class="tocitem" href="man/ShearBands/">Shear Bands</a></li></ul></li><li><a class="tocitem" href="man/listfunctions/">List of functions</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"><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>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-navbar-link" href="https://github.com/PTsolvers/JustRelax.jl" title="View the repository on GitHub"><span class="docs-icon fa-brands"></span><span class="docs-label is-hidden-touch">GitHub</span></a><a class="docs-navbar-link" href="https://github.com/PTsolvers/JustRelax.jl/blob/main/docs/src/index.md" title="Edit source on GitHub"><span class="docs-icon fa-solid"></span></a><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="JustRelax.jl"><a class="docs-heading-anchor" href="#JustRelax.jl">JustRelax.jl</a><a id="JustRelax.jl-1"></a><a class="docs-heading-anchor-permalink" href="#JustRelax.jl" title="Permalink"></a></h1><p>Need to solve a very large multi-physics problem on many GPUs in parallel? Just Relax!</p><p><code>JustRelax</code> is a collection of accelerated iterative pseudo-transient solvers using MPI and multiple CPU or GPU backends. It&#39;s part of the <a href="https://ptsolvers.github.io">PTSolvers organisation</a> and developed within the <a href="https://www.pasc-ch.org/projects/2021-2024/gpu4geo/">GPU4GEO project</a>. Current publications, outreach and news can be found on the <a href="https://ptsolvers.github.io/GPU4GEO/">GPU4GEO website</a>.</p><p>The package relies on other packages as building blocks and parallelisation tools:</p><ul><li><a href="https://github.com/omlins/ParallelStencil.jl">ParallelStencil.jl</a> - device agnostic parallel kernels</li><li><a href="https://github.com/omlins/ImplicitGlobalGrid.jl">ImplicitGlobalGrid.jl</a> - (CUDA-aware) MPI communication</li><li><a href="https://github.com/JuliaGeodynamics/GeoParams.jl">GeoParams.jl</a> - Material physics</li><li><a href="https://github.com/JuliaGeodynamics/JustPIC.jl">JustPIC.jl</a> - Particle-in-cell advection</li></ul><p>The package serves several purposes:</p><ul><li><p>It provides a collection of solvers to be used in quickly developing new applications</p></li><li><p>It provides some standardization so that application codes can</p><ul><li>more easily handle local material properties through the use of <a href="https://github.com/JuliaGeodynamics/GeoParams.jl">GeoParams.jl</a></li><li>more easily switch between a pseudo-transient solver and another solvers (e.g. an explicit thermal solvers)</li></ul></li><li><p>It provides a natural repository for contributions of new solvers for use by the larger community</p></li></ul><p>We provide several miniapps, each designed to solve a well-specified benchmark problem, in order to provide</p><ul><li>examples of usage in high-performance computing</li><li>basis on which to build more full-featured application codes</li><li>cases for reference and performance tests</li></ul></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="man/installation/">Installation »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Tuesday 28 May 2024 19:03">Tuesday 28 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
4 changes: 2 additions & 2 deletions dev/man/Blankenbach/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
thermal_bc = TemperatureBoundaryConditions(;
no_flux = (left = true, right = true, top = false, bot = false),
)
thermal_bcs!(thermal.T, thermal_bc)
thermal_bcs!(thermal, thermal_bc)
thermal.Told .= thermal.T</code></pre><h2 id="Pseuo-transient-coefficients"><a class="docs-heading-anchor" href="#Pseuo-transient-coefficients">Pseuo-transient coefficients</a><a id="Pseuo-transient-coefficients-1"></a><a class="docs-heading-anchor-permalink" href="#Pseuo-transient-coefficients" title="Permalink"></a></h2><pre><code class="language-julia hljs">pt_stokes = PTStokesCoeffs(li, di; ϵ=1e-4, CFL = 1 / √2.1)
pt_thermal = PTThermalCoeffs(
backend_JR, rheology, phase_ratios, args, dt, ni, di, li; ϵ=1e-5, CFL = 1e-1 / √2.1
Expand Down Expand Up @@ -207,4 +207,4 @@
Colorbar(fig[2,4], h4)
linkaxes!(ax1, ax2, ax3, ax4)
save(joinpath(figdir, &quot;$(it).png&quot;), fig)
fig</code></pre><h3 id="Final-model"><a class="docs-heading-anchor" href="#Final-model">Final model</a><a id="Final-model-1"></a><a class="docs-heading-anchor-permalink" href="#Final-model" title="Permalink"></a></h3><p>Temperature field <img src="../../assets/Blankenbach_Temp.png" alt="Temperature"/></p><p>And time history of the rms-velocity and Nusselt number <img src="../../assets/Blankenbach_Time_Series_V_Nu.png" alt="time series"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../advection/">« Advection</a><a class="docs-footer-nextpage" href="../ShearBands/">Shear Bands »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Thursday 23 May 2024 13:59">Thursday 23 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
fig</code></pre><h3 id="Final-model"><a class="docs-heading-anchor" href="#Final-model">Final model</a><a id="Final-model-1"></a><a class="docs-heading-anchor-permalink" href="#Final-model" title="Permalink"></a></h3><p>Temperature field <img src="../../assets/Blankenbach_Temp.png" alt="Temperature"/></p><p>And time history of the rms-velocity and Nusselt number <img src="../../assets/Blankenbach_Time_Series_V_Nu.png" alt="time series"/></p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../advection/">« Advection</a><a class="docs-footer-nextpage" href="../ShearBands/">Shear Bands »</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></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.4.1 on <span class="colophon-date" title="Tuesday 28 May 2024 19:03">Tuesday 28 May 2024</span>. Using Julia version 1.10.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 546c654

Please sign in to comment.