docs updated

tumaer · Dec 22, 2023 · e8780c9 · e8780c9
1 parent b5396c2
commit e8780c9
Show file tree

Hide file tree

Showing 172 changed files with 10,425 additions and 20,834 deletions.
diff --git a/docs/build/doctrees/authors.doctree b/docs/build/doctrees/authors.doctree
diff --git a/docs/build/doctrees/available_modules.doctree b/docs/build/doctrees/available_modules.doctree
diff --git a/docs/build/doctrees/change_log.doctree b/docs/build/doctrees/change_log.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/features.doctree b/docs/build/doctrees/features.doctree
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/installation.doctree b/docs/build/doctrees/installation.doctree
diff --git a/docs/build/doctrees/jaxfluids.doctree b/docs/build/doctrees/jaxfluids.doctree
diff --git a/docs/build/doctrees/jaxfluids.forcing.doctree b/docs/build/doctrees/jaxfluids.forcing.doctree
diff --git a/docs/build/doctrees/jaxfluids.iles.doctree b/docs/build/doctrees/jaxfluids.iles.doctree
diff --git a/docs/build/doctrees/jaxfluids.io_utils.doctree b/docs/build/doctrees/jaxfluids.io_utils.doctree
diff --git a/docs/build/doctrees/jaxfluids.levelset.doctree b/docs/build/doctrees/jaxfluids.levelset.doctree
diff --git a/docs/build/doctrees/jaxfluids.materials.doctree b/docs/build/doctrees/jaxfluids.materials.doctree
diff --git a/docs/build/doctrees/jaxfluids.post_process.doctree b/docs/build/doctrees/jaxfluids.post_process.doctree
diff --git a/docs/build/doctrees/jaxfluids.shock_sensor.doctree b/docs/build/doctrees/jaxfluids.shock_sensor.doctree
diff --git a/docs/build/doctrees/jaxfluids.solvers.doctree b/docs/build/doctrees/jaxfluids.solvers.doctree
diff --git a/docs/build/doctrees/jaxfluids.solvers.riemann_solvers.doctree b/docs/build/doctrees/jaxfluids.solvers.riemann_solvers.doctree
diff --git a/docs/build/doctrees/jaxfluids.stencils.derivative.doctree b/docs/build/doctrees/jaxfluids.stencils.derivative.doctree
diff --git a/docs/build/doctrees/jaxfluids.stencils.doctree b/docs/build/doctrees/jaxfluids.stencils.doctree
diff --git a/docs/build/doctrees/jaxfluids.stencils.levelset.doctree b/docs/build/doctrees/jaxfluids.stencils.levelset.doctree
diff --git a/docs/build/doctrees/jaxfluids.stencils.reconstruction.doctree b/docs/build/doctrees/jaxfluids.stencils.reconstruction.doctree
diff --git a/docs/build/doctrees/jaxfluids.time_integration.doctree b/docs/build/doctrees/jaxfluids.time_integration.doctree
diff --git a/docs/build/doctrees/jaxfluids.turb.doctree b/docs/build/doctrees/jaxfluids.turb.doctree
diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree
diff --git a/docs/build/doctrees/nbsphinx/notebooks/01_JAX-Fluids_1D_Sod_demo.ipynb b/docs/build/doctrees/nbsphinx/notebooks/01_JAX-Fluids_1D_Sod_demo.ipynb
diff --git a/docs/build/doctrees/nbsphinx/notebooks_01_JAX-Fluids_1D_Sod_demo_10_0.png b/docs/build/doctrees/nbsphinx/notebooks_01_JAX-Fluids_1D_Sod_demo_10_0.png
diff --git a/docs/build/doctrees/notebooks/01_JAX-Fluids_1D_Sod_demo.doctree b/docs/build/doctrees/notebooks/01_JAX-Fluids_1D_Sod_demo.doctree
diff --git a/docs/build/doctrees/runsimulation.doctree b/docs/build/doctrees/runsimulation.doctree
diff --git a/docs/build/doctrees/tutorials.doctree b/docs/build/doctrees/tutorials.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -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: fea90d13c7776d803318c1683b48b5df
+config: 224ea1f84cb407420e6e1ee2cbb67e02
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/_images/notebooks_01_JAX-Fluids_1D_Sod_demo_10_0.png b/docs/build/html/_images/notebooks_01_JAX-Fluids_1D_Sod_demo_10_0.png
diff --git a/docs/build/html/_modules/index.html b/docs/build/html/_modules/index.html
@@ -1,19 +1,22 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="../">
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>Overview: module code &mdash; jaxfluids 0.1.0 documentation</title>
-      <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
+      <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" />
+
+
   <!--[if lt IE 9]>
     <script src="../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
-        <script src="../_static/jquery.js"></script>
-        <script src="../_static/underscore.js"></script>
-        <script src="../_static/doctools.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=01f34227"></script>
+        <script src="../_static/doctools.js?v=888ff710"></script>
+        <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
@@ -25,14 +28,18 @@
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
-            <a href="../index.html" class="icon icon-home"> jaxfluids
+
+
+
+          <a href="../index.html" class="icon icon-home">
+            jaxfluids
           </a>
               <div class="version">
                 0.1.0
               </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" />
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
@@ -72,8 +79,8 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
-      <li>Overview: module code</li>
+      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
+      <li class="breadcrumb-item active">Overview: module code</li>
       <li class="wy-breadcrumbs-aside">
       </li>
   </ul>
@@ -120,6 +127,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="jaxfluids/solvers/riemann_solvers/HLL.html">jaxfluids.solvers.riemann_solvers.HLL</a></li>
 <li><a href="jaxfluids/solvers/riemann_solvers/HLLC.html">jaxfluids.solvers.riemann_solvers.HLLC</a></li>
 <li><a href="jaxfluids/solvers/riemann_solvers/HLLCLM.html">jaxfluids.solvers.riemann_solvers.HLLCLM</a></li>
+<li><a href="jaxfluids/solvers/riemann_solvers/LaxFriedrichs.html">jaxfluids.solvers.riemann_solvers.LaxFriedrichs</a></li>
 <li><a href="jaxfluids/solvers/riemann_solvers/RiemannNN.html">jaxfluids.solvers.riemann_solvers.RiemannNN</a></li>
 <li><a href="jaxfluids/solvers/riemann_solvers/Rusanov.html">jaxfluids.solvers.riemann_solvers.Rusanov</a></li>
 <li><a href="jaxfluids/solvers/riemann_solvers/RusanovNN.html">jaxfluids.solvers.riemann_solvers.RusanovNN</a></li>

diff --git a/docs/build/html/_modules/jaxfluids/boundary_condition.html b/docs/build/html/_modules/jaxfluids/boundary_condition.html
diff --git a/docs/build/html/_modules/jaxfluids/domain_information.html b/docs/build/html/_modules/jaxfluids/domain_information.html
@@ -1,19 +1,22 @@
 <!DOCTYPE html>
-<html class="writer-html5" lang="en" >
+<html class="writer-html5" lang="en" data-content_root="../../">
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
   <title>jaxfluids.domain_information &mdash; jaxfluids 0.1.0 documentation</title>
-      <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
-      <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
+      <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" />
+
+
   <!--[if lt IE 9]>
     <script src="../../_static/js/html5shiv.min.js"></script>
   <![endif]-->
 
-        <script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
-        <script src="../../_static/jquery.js"></script>
-        <script src="../../_static/underscore.js"></script>
-        <script src="../../_static/doctools.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=01f34227"></script>
+        <script src="../../_static/doctools.js?v=888ff710"></script>
+        <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script src="../../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../../genindex.html" />
@@ -25,14 +28,18 @@
     <nav data-toggle="wy-nav-shift" class="wy-nav-side">
       <div class="wy-side-scroll">
         <div class="wy-side-nav-search" >
-            <a href="../../index.html" class="icon icon-home"> jaxfluids
+
+
+
+          <a href="../../index.html" class="icon icon-home">
+            jaxfluids
           </a>
               <div class="version">
                 0.1.0
               </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" />
+    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
     <input type="hidden" name="check_keywords" value="yes" />
     <input type="hidden" name="area" value="default" />
   </form>
@@ -72,9 +79,9 @@
         <div class="rst-content">
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
-      <li><a href="../../index.html" class="icon icon-home"></a> &raquo;</li>
-          <li><a href="../index.html">Module code</a> &raquo;</li>
-      <li>jaxfluids.domain_information</li>
+      <li><a href="../../index.html" class="icon icon-home" aria-label="Home"></a></li>
+          <li class="breadcrumb-item"><a href="../index.html">Module code</a></li>
+      <li class="breadcrumb-item active">jaxfluids.domain_information</li>
       <li class="wy-breadcrumbs-aside">
       </li>
   </ul>
@@ -119,8 +126,10 @@ <h1>Source code for jaxfluids.domain_information</h1><div class="highlight"><pre
 
 <span class="kn">import</span> <span class="nn">jax.numpy</span> <span class="k">as</span> <span class="nn">jnp</span>
 
-<div class="viewcode-block" id="DomainInformation"><a class="viewcode-back" href="../../jaxfluids.html#jaxfluids.domain_information.DomainInformation">[docs]</a><span class="k">class</span> <span class="nc">DomainInformation</span><span class="p">:</span>
-    <span class="sd">&quot;&quot;&quot;This DomainInformation class holds information about the computational domain, e.g., </span>
+<div class="viewcode-block" id="DomainInformation">
+<a class="viewcode-back" href="../../jaxfluids.html#jaxfluids.domain_information.DomainInformation">[docs]</a>
+<span class="k">class</span> <span class="nc">DomainInformation</span><span class="p">:</span>
+<span class="w">    </span><span class="sd">&quot;&quot;&quot;This DomainInformation class holds information about the computational domain, e.g., </span>
 <span class="sd">    mesh, number of cells, extension in each spatial direction, active axis, domain slice objects etc..</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
@@ -176,20 +185,24 @@ <h1>Source code for jaxfluids.domain_information</h1><div class="highlight"><pre
 
         <span class="bp">self</span><span class="o">.</span><span class="n">resolution</span>         <span class="o">=</span> <span class="n">jnp</span><span class="o">.</span><span class="n">prod</span><span class="p">(</span><span class="n">jnp</span><span class="o">.</span><span class="n">array</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">number_of_cells</span><span class="p">))</span>
 
-<div class="viewcode-block" id="DomainInformation.compute_mesh_xi"><a class="viewcode-back" href="../../jaxfluids.html#jaxfluids.domain_information.DomainInformation.compute_mesh_xi">[docs]</a>    <span class="k">def</span> <span class="nf">compute_mesh_xi</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nxi</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">domain_size_xi</span><span class="p">:</span> <span class="n">List</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">jnp</span><span class="o">.</span><span class="n">DeviceArray</span><span class="p">,</span> <span class="n">jnp</span><span class="o">.</span><span class="n">DeviceArray</span><span class="p">,</span> <span class="n">jnp</span><span class="o">.</span><span class="n">DeviceArray</span><span class="p">]:</span>
-        <span class="sd">&quot;&quot;&quot;Computes cell center coordinates, cell face coordinates and cell sizes in the specified direction</span>
+<div class="viewcode-block" id="DomainInformation.compute_mesh_xi">
+<a class="viewcode-back" href="../../jaxfluids.html#jaxfluids.domain_information.DomainInformation.compute_mesh_xi">[docs]</a>
+    <span class="k">def</span> <span class="nf">compute_mesh_xi</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">nxi</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span> <span class="n">domain_size_xi</span><span class="p">:</span> <span class="n">List</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">jnp</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">jnp</span><span class="o">.</span><span class="n">ndarray</span><span class="p">,</span> <span class="n">jnp</span><span class="o">.</span><span class="n">ndarray</span><span class="p">]:</span>
+<span class="w">        </span><span class="sd">&quot;&quot;&quot;Computes cell center coordinates, cell face coordinates and cell sizes in the specified direction</span>
 
 <span class="sd">        :param nxi: Number of cells in xi direction</span>
 <span class="sd">        :type nxi: int</span>
 <span class="sd">        :param domain_size_xi: Domain size in xi direction</span>
 <span class="sd">        :type domain_size_xi: List</span>
 <span class="sd">        :return: Cell center coordinates, cell face coordinates and cell sizes in xi direction</span>
-<span class="sd">        :rtype: Tuple[jnp.DeviceArray, jnp.DeviceArray, jnp.DeviceArray]</span>
+<span class="sd">        :rtype: Tuple[jnp.ndarray, jnp.ndarray, jnp.ndarray]</span>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">cell_sizes_xi</span>   <span class="o">=</span> <span class="p">(</span><span class="n">domain_size_xi</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">domain_size_xi</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> <span class="o">/</span> <span class="n">nxi</span>
         <span class="n">cell_centers_xi</span> <span class="o">=</span> <span class="n">jnp</span><span class="o">.</span><span class="n">linspace</span><span class="p">(</span><span class="n">domain_size_xi</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="n">cell_sizes_xi</span><span class="o">/</span><span class="mi">2</span><span class="p">,</span> <span class="n">domain_size_xi</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="o">-</span> <span class="n">cell_sizes_xi</span><span class="o">/</span><span class="mi">2</span><span class="p">,</span> <span class="n">nxi</span><span class="p">)</span>
         <span class="n">cell_faces_xi</span>   <span class="o">=</span> <span class="n">jnp</span><span class="o">.</span><span class="n">linspace</span><span class="p">(</span><span class="n">domain_size_xi</span><span class="p">[</span><span class="mi">0</span><span class="p">],</span> <span class="n">domain_size_xi</span><span class="p">[</span><span class="mi">1</span><span class="p">],</span> <span class="n">nxi</span><span class="o">+</span><span class="mi">1</span><span class="p">)</span>
-        <span class="k">return</span> <span class="n">cell_centers_xi</span><span class="p">,</span> <span class="n">cell_faces_xi</span><span class="p">,</span> <span class="n">cell_sizes_xi</span></div></div>
+        <span class="k">return</span> <span class="n">cell_centers_xi</span><span class="p">,</span> <span class="n">cell_faces_xi</span><span class="p">,</span> <span class="n">cell_sizes_xi</span></div>
+</div>
+
 </pre></div>
 
            </div>