-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #77 from RJArthern/docs-reconcile
Merging documentation into main
- Loading branch information
Showing
96 changed files
with
573 additions
and
15,791 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| name: Testing | ||
|
|
||
| on: | ||
| push: | ||
| branches: | ||
| - docs-reconcile # update to match your development branch (master, main, dev, trunk, ...) or '**' for all | ||
| - main | ||
| tags: '*' | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| build: | ||
| permissions: | ||
| contents: write | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| - uses: julia-actions/setup-julia@v1 | ||
| with: | ||
| version: '1.6' | ||
| - name: Install dependencies | ||
| run: julia --project=test/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()' | ||
| - name: Build and deploy | ||
| env: | ||
| DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key | ||
| run: julia --project=test/ test/runtests_structure.jl |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| <!DOCTYPE html> | ||
| <html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Grid · WAVI.jl</title><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.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/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"><a class="docs-logo" href="../index.html"><img src="../assets/logo.png" alt="WAVI.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../index.html">WAVI.jl</a></span></div><form class="docs-search" action="../search.html"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../index.html">Home</a></li><li><a class="tocitem" href="../installation_instructions.html">Installation instructions</a></li><li><input class="collapse-toggle" id="menuitem-3" type="checkbox"/><label class="tocitem" for="menuitem-3"><span class="docs-label">Examples</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../examples/planar_1D_flow.html">First example: one-dimensional planar flow</a></li><li><a class="tocitem" href="../examples/mismip_plus.html">MISMIP+ part one: grounding lines on overdeepened bed</a></li><li><a class="tocitem" href="../examples/mismip_plus_retreat.html">MISMIP+ part two: retreat experiments</a></li><li><a class="tocitem" href="../examples/bumpy_bed.html">Two-dimensional flow on a bumpy bed</a></li><li><a class="tocitem" href="../examples/melt_parametrizations.html">Melt rate parametrizations</a></li><li><a class="tocitem" href="../examples/stochastic_forcing.html">Ice sheet retreat under stochastic forcing</a></li><li><a class="tocitem" href="../examples/WAIS.html">Real world: West Antarctic Ice Sheet</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-4" type="checkbox"/><label class="tocitem" for="menuitem-4"><span class="docs-label">Physics</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../physics/overview.html">Overview</a></li><li><a class="tocitem" href="../physics/governing_equations.html">Governing Equations</a></li><li><a class="tocitem" href="../physics/melting.html">Basal Melt Rate Parametrizations</a></li></ul></li><li><a class="tocitem" href="../numerical_procedure/numerical_procedure.html">Numerical Implementation</a></li><li><input class="collapse-toggle" id="menuitem-6" type="checkbox" checked/><label class="tocitem" for="menuitem-6"><span class="docs-label">API</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="overview.html">Overview</a></li><li><a class="tocitem" href="simulations.html">Simulations</a></li><li><a class="tocitem" href="model.html">Models</a></li><li><a class="tocitem" href="timestepping_params.html">Timestepping Parameters</a></li><li><a class="tocitem" href="output_writing.html">Output Writing</a></li><li class="is-active"><a class="tocitem" href="grid.html">Grid</a></li><li><a class="tocitem" href="solver_parameters.html">Solver Parameters</a></li><li><a class="tocitem" href="params.html">Physical Parameters</a></li><li><a class="tocitem" href="initial_conditions.html">Initial Conditions</a></li><li><a class="tocitem" href="fields.html">Fields</a></li><li><a class="tocitem" href="melt_rate_models.html">Basal Melt Rate Models</a></li></ul></li><li><a class="tocitem" href="../mitgcm_coupling.html">MITgcm coupling</a></li><li><a class="tocitem" href="../contributing.html">Contributors guide</a></li><li><a class="tocitem" href="../contact.html">Contact us</a></li><li><a class="tocitem" href="../references.html">References</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><a class="is-disabled">API</a></li><li class="is-active"><a href="grid.html">Grid</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href="grid.html">Grid</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/RJArthern/WAVI.jl/blob/main/docs/src/API/grid.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="Grid"><a class="docs-heading-anchor" href="#Grid">Grid</a><a id="Grid-1"></a><a class="docs-heading-anchor-permalink" href="#Grid" title="Permalink"></a></h1><p>A <code>Grid</code> is a WAVI.jl object that stores information relating to the <a href="../numerical_procedure/numerical_procedure.html#Numerical-Grid">numerical grid</a>. The key parameters, which are passed via keyword arguments in the <code>OutputParams</code> constructor, are as follows:</p><ul><li><code>nx</code>: number of x grid points</li><li><code>ny</code>: number of y grid points</li><li><code>nσ</code>: number of levels in the vertical</li><li><code>dx</code>: grid spacing in x </li><li><code>dy</code>: grid spacing in y </li><li><code>x0</code>: grid origin x co-ordinate </li><li><code>y0</code>: grid origin y co-ordinate</li><li><code>h_mask</code>: Array of size <code>nx</code> x <code>ny</code> that defines domain points: ones in the <code>h_mask</code> indicate loations within ice domain, while zeros in the <code>h_mask</code> indicate locations outside of the ice domain. Defaults to <code>trues(nx,ny)</code>, corresponding to every grid point being in the ice domain.</li><li><code>u_iszero</code>: Array of size <code>nx</code> x <code>ny</code> that defines locations of zero velocity in the x-direction: ones in the <code>u_iszero</code> correspond to points where the velocity in the x-direction is forced to be zero, while zeros in the <code>u_iszero</code> array corresponds to points where the velocity is free. Defaults to <code>falses(nx,ny)</code>, corresponding to no restrictions on u velocity anywhere. <code>u_iszero</code> can also be specified by an array with entries from "North", "South", "East", and "West", which set the corresponding edges of the domain to have zero velocity boundary conditions there.</li><li><code>v_iszero</code>: As in <code>u_iszero</code> for the velocity in the y-direction.</li><li><code>σ</code>: Dimensionless locations of sigma (vertical) levels. Values must be increasing between 0 and 1.</li><li><code>quadrature_weights</code>: weights associated with sigma (vertical) levels used in quadrature scheme to determine depth averaged quantities (e.g. viscosity).</li></ul><p>WAVI.jl has several grids, on which different quantities are defined (see <a href="../numerical_procedure/numerical_procedure.html#Numerical-Grid">numerical grid</a>). A <code>Grid</code> object contains explicit definitions of these grids; for example, the x-coordinates of the "h grid" are stored in <code>grid.xxh</code> (where <code>grid</code> is the name of the <code>Grid</code> instance).</p><article class="docstring"><header><a class="docstring-binding" id="WAVI.Grid-Tuple{}" href="#WAVI.Grid-Tuple{}"><code>WAVI.Grid</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">Grid(; | ||
| nx = 80, | ||
| ny = 10, | ||
| dx = 8000.0, | ||
| dy = 8000.0, | ||
| nσ = 4, | ||
| x0 = 0.0, | ||
| y0 = -40000.0, | ||
| h_mask = nothing, | ||
| h_isfixed = nothing, | ||
| u_iszero = nothing, | ||
| v_iszero = nothing, | ||
| basin_ID = nothing, | ||
| u_isfixed = nothing, | ||
| v_isfixed = nothing)</code></pre><p>Construct a WAVI.jl grid.</p><p><strong>Keyword arguments</strong></p><ul><li><code>nx</code>: number of x grid points</li><li><code>ny</code>: number of y grid points</li><li><code>dx</code>: grid spacing in x </li><li><code>dy</code>: grid spacing in y </li><li><code>nσ</code>: number of levels in the vertical</li><li><code>x0</code>: grid origin x co-ordinate </li><li><code>y0</code>: grid origin y co-ordinate</li><li><code>h_mask</code>: Mask defining domain points within grid</li><li>`h_isfixed': Mask defining locations of fixed thickness within grid</li><li><code>u_iszero</code>: Locations of zero u velocity points</li><li><code>v_iszero</code>: Locations of zero v velocity points</li><li><code>u_isfixed</code>: Locations of fixed u velocity points</li><li><code>v_isfixed</code>: Locations of fixed v velocity points</li><li><code>quadrature_weights</code>: weights associated with sigma levels used in quadrature scheme</li><li><code>basin_ID</code>: grid of basin IDs </li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/RJArthern/WAVI.jl/blob/aa4c1b01a4e340aceea2331087cd1d7826d9f1fd/src/Grid.jl#L29-L65">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="output_writing.html">« Output Writing</a><a class="docs-footer-nextpage" href="solver_parameters.html">Solver Parameters »</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="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.25 on <span class="colophon-date" title="Wednesday 10 January 2024 16:01">Wednesday 10 January 2024</span>. Using Julia version 1.6.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html> |
Oops, something went wrong.