Skip to content

Commit

Permalink
build based on 4efbd85
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jan 20, 2025
1 parent cda29a6 commit 4829a9d
Show file tree
Hide file tree
Showing 13 changed files with 13 additions and 13 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.9.4","generation_timestamp":"2025-01-20T20:19:53","documenter_version":"1.8.0"}}
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2025-01-20T20:38:47","documenter_version":"1.8.0"}}
2 changes: 1 addition & 1 deletion dev/API/index.html
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/CellArrays/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@
julia> CA
2×2 CellArrays.CPUCellArray{StaticArraysCore.SVector{2, Float64}, 2, 1, Float64}:
[21.0, 21.0] [20.0, 20.0]
[20.0, 20.0] [20.0, 20.0]</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../particles/">« Particles</a><a class="docs-footer-nextpage" href="../interpolations/">Particles interpolations »</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.8.0 on <span class="colophon-date" title="Monday 20 January 2025 20:19">Monday 20 January 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
[20.0, 20.0] [20.0, 20.0]</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../particles/">« Particles</a><a class="docs-footer-nextpage" href="../interpolations/">Particles interpolations »</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.8.0 on <span class="colophon-date" title="Monday 20 January 2025 20:38">Monday 20 January 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/IO/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@
particles = TA(backend)(Float64, data[&quot;particles&quot;])
phases = TA(backend)(Float64, data[&quot;phases&quot;])
phase_ratios = TA(backend)(Float64, data[&quot;phase_ratios&quot;])
particle_args = TA(backend).(Float64, data[&quot;particle_args&quot;])</code></pre><p>The function <code>TA(backend)</code> will automatically cast the data to the appropriate type, depending on the requested backend.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../field_advection3D/">« Field advection in 3D</a><a class="docs-footer-nextpage" href="../mixed_CPU_GPU/">Mixed GPU/CPU »</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.8.0 on <span class="colophon-date" title="Monday 20 January 2025 20:19">Monday 20 January 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
particle_args = TA(backend).(Float64, data[&quot;particle_args&quot;])</code></pre><p>The function <code>TA(backend)</code> will automatically cast the data to the appropriate type, depending on the requested backend.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../field_advection3D/">« Field advection in 3D</a><a class="docs-footer-nextpage" href="../mixed_CPU_GPU/">Mixed GPU/CPU »</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.8.0 on <span class="colophon-date" title="Monday 20 January 2025 20:38">Monday 20 January 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/field_advection2D/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@
move_particles!(particles, xvi, particle_args) # move particles in the memory
inject_particles!(particles, (pT, ), xvi) # inject particles if needed
particle2grid!(T, pT, xvi, particles) # interpolate particles to the grid
end</code></pre><h1 id="Pure-shear-in-2D"><a class="docs-heading-anchor" href="#Pure-shear-in-2D">Pure shear in 2D</a><a id="Pure-shear-in-2D-1"></a><a class="docs-heading-anchor-permalink" href="#Pure-shear-in-2D" title="Permalink"></a></h1><p>An example of two-dimensional pure shear flow is provided in this <a href="https://github.com/JuliaGeodynamics/JustPIC.jl/blob/main/scripts/pureshear_ALE.jl">script</a>. The velocity field is set to:</p><p class="math-container">\[v_{x} = \dot{\varepsilon} x\]</p><p class="math-container">\[v_{y} = -\dot{\varepsilon} y\]</p><p>where <span>$\dot{\varepsilon}$</span> is the pure shear strain rate applied at the boundaries. A positive value of <span>$\dot{\varepsilon}$</span> leads to horizontal extension, while negative values correspond to horizontal compression.</p><p>The <code>ALE</code> switch (Arbitrary Lagrangian Eulerian) allows to activate, or not, model box deformation. If <code>ALE=false</code>, the model dimension remains constant over time. If <code>ALE=true</code>, the model domain is deformed with the background pure shear rate.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../marker_chain/">« Marker chain</a><a class="docs-footer-nextpage" href="../field_advection2D_MPI/">Field advection in 2D using MPI »</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.8.0 on <span class="colophon-date" title="Monday 20 January 2025 20:19">Monday 20 January 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre><h1 id="Pure-shear-in-2D"><a class="docs-heading-anchor" href="#Pure-shear-in-2D">Pure shear in 2D</a><a id="Pure-shear-in-2D-1"></a><a class="docs-heading-anchor-permalink" href="#Pure-shear-in-2D" title="Permalink"></a></h1><p>An example of two-dimensional pure shear flow is provided in this <a href="https://github.com/JuliaGeodynamics/JustPIC.jl/blob/main/scripts/pureshear_ALE.jl">script</a>. The velocity field is set to:</p><p class="math-container">\[v_{x} = \dot{\varepsilon} x\]</p><p class="math-container">\[v_{y} = -\dot{\varepsilon} y\]</p><p>where <span>$\dot{\varepsilon}$</span> is the pure shear strain rate applied at the boundaries. A positive value of <span>$\dot{\varepsilon}$</span> leads to horizontal extension, while negative values correspond to horizontal compression.</p><p>The <code>ALE</code> switch (Arbitrary Lagrangian Eulerian) allows to activate, or not, model box deformation. If <code>ALE=false</code>, the model dimension remains constant over time. If <code>ALE=true</code>, the model domain is deformed with the background pure shear rate.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../marker_chain/">« Marker chain</a><a class="docs-footer-nextpage" href="../field_advection2D_MPI/">Field advection in 2D using MPI »</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.8.0 on <span class="colophon-date" title="Monday 20 January 2025 20:38">Monday 20 January 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/field_advection2D_MPI/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,4 +50,4 @@
T_nohalo = @zeros(size(T).-2) # local `T` without overlapping halo</code></pre><p>Visualization with GLMakie.jl</p><pre><code class="language-julia hljs">using GLMakie
x_global = range(0, Lx, length=size(T_v,1))
y_global = range(0, Ly, length=size(T_v,2))
heatmap(x_global, y_global, T_v)</code></pre><h2 id="Going-3D"><a class="docs-heading-anchor" href="#Going-3D">Going 3D</a><a id="Going-3D-1"></a><a class="docs-heading-anchor-permalink" href="#Going-3D" title="Permalink"></a></h2><p>A 3D example using MPI is found in <code>scripts/temperature_advection3D_MPI.jl</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../field_advection2D/">« Field advection in 2D</a><a class="docs-footer-nextpage" href="../field_advection3D/">Field advection in 3D »</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.8.0 on <span class="colophon-date" title="Monday 20 January 2025 20:19">Monday 20 January 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
heatmap(x_global, y_global, T_v)</code></pre><h2 id="Going-3D"><a class="docs-heading-anchor" href="#Going-3D">Going 3D</a><a id="Going-3D-1"></a><a class="docs-heading-anchor-permalink" href="#Going-3D" title="Permalink"></a></h2><p>A 3D example using MPI is found in <code>scripts/temperature_advection3D_MPI.jl</code>.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../field_advection2D/">« Field advection in 2D</a><a class="docs-footer-nextpage" href="../field_advection3D/">Field advection in 3D »</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.8.0 on <span class="colophon-date" title="Monday 20 January 2025 20:38">Monday 20 January 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/field_advection3D/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,4 +35,4 @@
move_particles!(particles, xvi, particle_args) # move particles in the memory
inject_particles!(particles, (pT, ), xvi) # inject particles if needed
particle2grid!(T, pT, xvi, particles) # interpolate particles to the grid
end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../field_advection2D_MPI/">« Field advection in 2D using MPI</a><a class="docs-footer-nextpage" href="../IO/">I/O »</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.8.0 on <span class="colophon-date" title="Monday 20 January 2025 20:19">Monday 20 January 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
end</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../field_advection2D_MPI/">« Field advection in 2D using MPI</a><a class="docs-footer-nextpage" href="../IO/">I/O »</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.8.0 on <span class="colophon-date" title="Monday 20 January 2025 20:38">Monday 20 January 2025</span>. Using Julia version 1.9.4.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit 4829a9d

Please sign in to comment.