Skip to content

Commit

Permalink
delete history
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Jan 22, 2025
0 parents commit 28c376d
Show file tree
Hide file tree
Showing 381 changed files with 22,721 additions and 0 deletions.
1 change: 1 addition & 0 deletions dev/.documenter-siteinfo.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2025-01-21T16:08:57","documenter_version":"1.8.0"}}
2 changes: 2 additions & 0 deletions dev/API/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Public API · JustPIC.jl</title><meta name="title" content="Public API · JustPIC.jl"/><meta property="og:title" content="Public API · JustPIC.jl"/><meta property="twitter:title" content="Public API · JustPIC.jl"/><meta name="description" content="Documentation for JustPIC.jl."/><meta property="og:description" content="Documentation for JustPIC.jl."/><meta property="twitter:description" content="Documentation for JustPIC.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"><div class="docs-package-name"><span class="docs-autofit"><a href="../">JustPIC.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><a class="tocitem" href="../particles/">Particles</a></li><li><a class="tocitem" href="../CellArrays/">CellArrays</a></li><li><span class="tocitem">Interpolations</span><ul><li><a class="tocitem" href="../interpolations/">Particles interpolations</a></li><li><a class="tocitem" href="../velocity_interpolation/">Velocity interpolation</a></li></ul></li><li><a class="tocitem" href="../marker_chain/">Marker chain</a></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../field_advection2D/">Field advection in 2D</a></li><li><a class="tocitem" href="../field_advection2D_MPI/">Field advection in 2D using MPI</a></li><li><a class="tocitem" href="../field_advection3D/">Field advection in 3D</a></li></ul></li><li><a class="tocitem" href="../IO/">I/O</a></li><li><a class="tocitem" href="../mixed_CPU_GPU/">Mixed GPU/CPU</a></li><li class="is-active"><a class="tocitem" href>Public API</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>Public API</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Public API</a></li></ul></nav><div class="docs-right"><a class="docs-navbar-link" href="https://github.com/JuliaGeodynamics/JustPIC.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/JuliaGeodynamics/JustPIC.jl/blob/main/docs/src/API.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="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></h1><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>JustPIC._2D.setelement!</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>JustPIC._3D.element</code>. Check Documenter&#39;s build log for details.</p></div></div><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>JustPIC._3D.setelement!</code>. Check Documenter&#39;s build log for details.</p></div></div><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="JustPIC._3D.@idx" href="#JustPIC._3D.@idx"><code>JustPIC._3D.@idx</code></a> — <span class="docstring-category">Macro</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">@idx(args...)</code></pre><p>Make a linear range from <code>1</code> to <code>args[i]</code>, with <code>i ∈ [1, ..., n]</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeodynamics/JustPIC.jl/blob/43acb58f343b99027ca4a1d3109afa96a97b39f7/src/Utils.jl#L18-L22">source</a></section></article><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="JustPIC._2D.@idx" href="#JustPIC._2D.@idx"><code>JustPIC._2D.@idx</code></a> — <span class="docstring-category">Macro</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">@idx(args...)</code></pre><p>Make a linear range from <code>1</code> to <code>args[i]</code>, with <code>i ∈ [1, ..., n]</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeodynamics/JustPIC.jl/blob/43acb58f343b99027ca4a1d3109afa96a97b39f7/src/Utils.jl#L18-L22">source</a></section></article><div class="admonition is-warning"><header class="admonition-header">Missing docstring.</header><div class="admonition-body"><p>Missing docstring for <code>JustPIC._2D.element</code>. Check Documenter&#39;s build log for details.</p></div></div><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="JustPIC._3D.lerp" href="#JustPIC._3D.lerp"><code>JustPIC._3D.lerp</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">lerp(v, t::NTuple{nD,T}) where {nD,T}</code></pre><p>Linearly interpolates the value <code>v</code> between the elements of the tuple <code>t</code>. This function is specialized for tuples of length <code>nD</code>.</p><p><strong>Arguments</strong></p><ul><li><code>v</code>: The value to be interpolated.</li><li><code>t</code>: The tuple of values to interpolate between.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeodynamics/JustPIC.jl/blob/43acb58f343b99027ca4a1d3109afa96a97b39f7/src/Interpolations/ndlerp.jl#L1-L10">source</a></section></article><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="JustPIC._2D.lerp" href="#JustPIC._2D.lerp"><code>JustPIC._2D.lerp</code></a> — <span class="docstring-category">Function</span><span class="is-flex-grow-1 docstring-article-toggle-button" title="Collapse docstring"></span></header><section><div><pre><code class="language-julia hljs">lerp(v, t::NTuple{nD,T}) where {nD,T}</code></pre><p>Linearly interpolates the value <code>v</code> between the elements of the tuple <code>t</code>. This function is specialized for tuples of length <code>nD</code>.</p><p><strong>Arguments</strong></p><ul><li><code>v</code>: The value to be interpolated.</li><li><code>t</code>: The tuple of values to interpolate between.</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/JuliaGeodynamics/JustPIC.jl/blob/43acb58f343b99027ca4a1d3109afa96a97b39f7/src/Interpolations/ndlerp.jl#L1-L10">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" 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="Tuesday 21 January 2025 16:08">Tuesday 21 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 28c376d

Please sign in to comment.