Skip to content

Commit

Permalink
Deploying to gh-pages from @ 1970095 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
asalmgren committed Oct 8, 2024
1 parent b028744 commit a1ff46e
Show file tree
Hide file tree
Showing 29 changed files with 444 additions and 316 deletions.
2 changes: 1 addition & 1 deletion docs_html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 60bdbdc153dc662c31ec8c53e5ec95c8
config: 9622626d96e2441b84aaa5770dcdc386
tags: 645f666f9bcd5a90fca523b33c5a78b7
27 changes: 11 additions & 16 deletions docs_html/Debugging.html
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Debugging &mdash; incflo 24.10-dev documentation</title>
<title>Debugging &mdash; incflo 24.11-dev documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/theme_overrides.css?v=681a4282" />


<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=3963c78d"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=c413f8cb"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand All @@ -36,9 +34,6 @@
<a href="index.html" class="icon icon-home">
incflo
</a>
<div class="version">
24.10-dev
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Expand Down Expand Up @@ -100,7 +95,7 @@
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">VisMF</span><span class="o">::</span><span class="n">Write</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">FabArray</span><span class="o">&lt;</span><span class="n">FArrayBox</span><span class="o">&gt;&amp;</span><span class="w"> </span><span class="n">mf</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">std</span><span class="o">::</span><span class="n">string</span><span class="o">&amp;</span><span class="w"> </span><span class="n">name</span><span class="p">);</span>
</pre></div>
</div>
<p>and examining it with <code class="docutils literal notranslate"><span class="pre">Amrvis</span></code> (section <a class="reference external" href="https://amrex-codes.github.io/amrex/docs_html/Visualization.html#sec-amrvis" title="(in amrex v24.10-dev)"><span>Amrvis</span></a> in the AMReX documentation).</p>
<p>and examining it with <code class="docutils literal notranslate"><span class="pre">Amrvis</span></code> (section <a class="reference external" href="https://amrex-codes.github.io/amrex/docs_html/Visualization.html#sec-amrvis" title="(in amrex v24.11-dev)"><span>Amrvis</span></a> in the AMReX documentation).</p>
</li>
<li><p>You can also use the <code class="code highlight cpp c++ docutils literal highlight-c++"><span class="n">print_state</span></code> routine:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span><span class="w"> </span><span class="nf">print_state</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="n">MultiFab</span><span class="o">&amp;</span><span class="w"> </span><span class="n">mf</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="n">IntVect</span><span class="o">&amp;</span><span class="w"> </span><span class="n">cell</span><span class="p">,</span><span class="w"> </span><span class="k">const</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">n</span><span class="o">=</span><span class="mi">-1</span><span class="p">);</span>
Expand All @@ -126,7 +121,7 @@
</pre></div>
</div>
</div></blockquote>
<p>Also see AMReX’s documentation on <a class="reference external" href="https://amrex-codes.github.io/amrex/docs_html/Debugging.html#sec-basics-debugging" title="(in amrex v24.10-dev)"><span>Debugging</span></a> for further suggestions.</p>
<p>Also see AMReX’s documentation on <a class="reference external" href="https://amrex-codes.github.io/amrex/docs_html/Debugging.html#sec-basics-debugging" title="(in amrex v24.11-dev)"><span>Debugging</span></a> for further suggestions.</p>
<p>If you believe you’ve encountered a bug or incorrect behavior in incflo, please report the issue
on incflo’s github page <a class="reference external" href="https://github.com/AMReX-Fluids/incflo/issues">here</a> .</p>
</section>
Expand Down
25 changes: 10 additions & 15 deletions docs_html/EB.html
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Embedded Boundaries &mdash; incflo 24.10-dev documentation</title>
<title>Embedded Boundaries &mdash; incflo 24.11-dev documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/theme_overrides.css?v=681a4282" />


<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=3963c78d"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=c413f8cb"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand All @@ -37,9 +35,6 @@
<a href="index.html" class="icon icon-home">
incflo
</a>
<div class="version">
24.10-dev
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Expand Down Expand Up @@ -94,7 +89,7 @@
See <a class="reference external" href="https://mfix.netl.doe.gov/gitlab/exa/csg-eb">MFIX’s CSG-EB repository</a> for more details about this format.</p>
<p>incflo provides several options of embedded boundary geometries. The inputs parameter <code class="docutils literal notranslate"><span class="pre">incflo.geometry</span> <span class="pre">=</span> <span class="pre">XXX</span></code>
determines which geometry is selected by <code class="code highlight cpp c++ docutils literal highlight-c++"><span class="n">incflo</span><span class="o">::</span><span class="n">MakeEBGeometry</span><span class="p">()</span></code> within <code class="code highlight cpp c++ docutils literal highlight-c++"><span class="n">incflo</span><span class="o">/</span><span class="n">src</span><span class="o">/</span><span class="n">embedded_boundaries</span></code>.
The procedure to create your own EB geometry is described in the AMReX documentation on <a class="reference external" href="https://amrex-codes.github.io/amrex/docs_html/EB.html#sec-eb-ebinit" title="(in amrex v24.10-dev)"><span>Initializing the Geometric Database</span></a>.
The procedure to create your own EB geometry is described in the AMReX documentation on <a class="reference external" href="https://amrex-codes.github.io/amrex/docs_html/EB.html#sec-eb-ebinit" title="(in amrex v24.11-dev)"><span>Initializing the Geometric Database</span></a>.
As discussed in the AMReX documentation, note that when constructing the EB, we must specify a
maximum coarsening level (<code class="docutils literal notranslate"><span class="pre">max_crse_level</span></code>):</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="n">EB2</span><span class="o">::</span><span class="n">Build</span><span class="p">(</span><span class="n">gshop</span><span class="p">,</span><span class="w"> </span><span class="n">geom</span><span class="p">[</span><span class="n">lev</span><span class="p">],</span><span class="w"> </span><span class="n">required_crse_lev</span><span class="p">,</span><span class="w"> </span><span class="n">max_crse_level</span><span class="p">);</span>
Expand Down
25 changes: 10 additions & 15 deletions docs_html/FluidEquations.html
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Fluid Variables &mdash; incflo 24.10-dev documentation</title>
<title>Fluid Variables &mdash; incflo 24.11-dev documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/theme_overrides.css?v=681a4282" />


<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=3963c78d"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=c413f8cb"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand All @@ -38,9 +36,6 @@
<a href="index.html" class="icon icon-home">
incflo
</a>
<div class="version">
24.10-dev
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Expand Down
25 changes: 10 additions & 15 deletions docs_html/Fluids_Chapter.html
Original file line number Diff line number Diff line change
@@ -1,25 +1,23 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Solving the Fluid Equations &mdash; incflo 24.10-dev documentation</title>
<title>Solving the Fluid Equations &mdash; incflo 24.11-dev documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/theme_overrides.css?v=681a4282" />


<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=3963c78d"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=c413f8cb"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script async="async" src="https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand All @@ -38,9 +36,6 @@
<a href="index.html" class="icon icon-home">
incflo
</a>
<div class="version">
24.10-dev
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Expand Down
27 changes: 11 additions & 16 deletions docs_html/GettingStarted.html
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Getting Started &mdash; incflo 24.10-dev documentation</title>
<title>Getting Started &mdash; incflo 24.11-dev documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=7ab3649f" />
<link rel="stylesheet" type="text/css" href="_static/theme_overrides.css?v=681a4282" />


<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=3963c78d"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=c413f8cb"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand All @@ -37,9 +35,6 @@
<a href="index.html" class="icon icon-home">
incflo
</a>
<div class="version">
24.10-dev
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
Expand Down Expand Up @@ -438,11 +433,11 @@ <h2>Running the code<a class="headerlink" href="#running-the-code" title="Link t
<code class="docutils literal notranslate"><span class="pre">chk00010</span></code>, etc. These are called plotfiles and checkpoint
files. The plotfiles are used for visualization of derived fields; the checkpoint
files are used for restarting the code. For more information see the AMReX Documentation on
<a class="reference external" href="https://amrex-codes.github.io/amrex/docs_html/IO_Chapter.html#chap-io" title="(in amrex v24.10-dev)"><span>I/O (Plotfile, Checkpoint)</span></a>.</p>
<a class="reference external" href="https://amrex-codes.github.io/amrex/docs_html/IO_Chapter.html#chap-io" title="(in amrex v24.11-dev)"><span>I/O (Plotfile, Checkpoint)</span></a>.</p>
</section>
<section id="visualizing-the-results">
<h2>Visualizing the Results<a class="headerlink" href="#visualizing-the-results" title="Link to this heading"></a></h2>
<p>Options for visualizing the data are discussed in the AMReX Documentation on <a class="reference external" href="https://amrex-codes.github.io/amrex/docs_html/Visualization_Chapter.html#chap-visualization" title="(in amrex v24.10-dev)"><span>Visualization</span></a>.</p>
<p>Options for visualizing the data are discussed in the AMReX Documentation on <a class="reference external" href="https://amrex-codes.github.io/amrex/docs_html/Visualization_Chapter.html#chap-visualization" title="(in amrex v24.11-dev)"><span>Visualization</span></a>.</p>
</section>
</section>

Expand Down
Loading

0 comments on commit a1ff46e

Please sign in to comment.