deploy: 2618306

Deltares · Jul 17, 2024 · dbfcf46 · dbfcf46
1 parent d362203
commit dbfcf46
Show file tree

Hide file tree

Showing 25 changed files with 71 additions and 46 deletions.
diff --git a/.buildinfo b/.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: c21e735eab84c3aa0e238b171d1ab8ac
+config: 32366a3347e65842caa56b850979ac4e
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/api.doctree b/.doctrees/api.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/examples/sg_execution_times.doctree b/.doctrees/examples/sg_execution_times.doctree
diff --git a/.doctrees/examples/spatial_indexing.doctree b/.doctrees/examples/spatial_indexing.doctree
diff --git a/.doctrees/sg_execution_times.doctree b/.doctrees/sg_execution_times.doctree
diff --git a/_downloads/bc82bea3a5dd7bdba60b65220891d9e5/examples_python.zip b/_downloads/bc82bea3a5dd7bdba60b65220891d9e5/examples_python.zip
diff --git a/_downloads/fb625db3c50d423b1b7881136ffdeec8/examples_jupyter.zip b/_downloads/fb625db3c50d423b1b7881136ffdeec8/examples_jupyter.zip
diff --git a/_modules/index.html b/_modules/index.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; Numba Celltree 0.1.6 documentation</title>
+    <title>Overview: module code &#8212; Numba Celltree 0.1.7 documentation</title>
 
 
 
@@ -39,7 +39,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../_static/documentation_options.js?v=6e0256f3"></script>
+    <script src="../_static/documentation_options.js?v=ca7ad2ea"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = '_modules/index';</script>

diff --git a/_modules/numba_celltree/celltree.html b/_modules/numba_celltree/celltree.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>numba_celltree.celltree &#8212; Numba Celltree 0.1.6 documentation</title>
+    <title>numba_celltree.celltree &#8212; Numba Celltree 0.1.7 documentation</title>
 
 
 
@@ -39,7 +39,7 @@
 <link rel="preload" as="script" href="../../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../../_static/documentation_options.js?v=6e0256f3"></script>
+    <script src="../../_static/documentation_options.js?v=ca7ad2ea"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = '_modules/numba_celltree/celltree';</script>
@@ -392,7 +392,6 @@ <h1>Source code for numba_celltree.celltree</h1><div class="highlight"><pre>
 <span class="p">)</span>
 <span class="kn">from</span> <span class="nn">numba_celltree.constants</span> <span class="kn">import</span> <span class="p">(</span>
     <span class="n">FILL_VALUE</span><span class="p">,</span>
-    <span class="n">MAX_N_FACE</span><span class="p">,</span>
     <span class="n">MAX_N_VERTEX</span><span class="p">,</span>
     <span class="n">BoolArray</span><span class="p">,</span>
     <span class="n">CellTreeData</span><span class="p">,</span>
@@ -430,13 +429,7 @@ <h1>Source code for numba_celltree.celltree</h1><div class="highlight"><pre>
         <span class="n">faces</span> <span class="o">=</span> <span class="n">np</span><span class="o">.</span><span class="n">ascontiguousarray</span><span class="p">(</span><span class="n">faces</span><span class="p">,</span> <span class="n">dtype</span><span class="o">=</span><span class="n">IntDType</span><span class="p">)</span>
     <span class="k">if</span> <span class="n">faces</span><span class="o">.</span><span class="n">ndim</span> <span class="o">!=</span> <span class="mi">2</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s2">&quot;faces must have shape (n_face, n_max_vert)&quot;</span><span class="p">)</span>
-    <span class="n">n_face</span><span class="p">,</span> <span class="n">n_max_vert</span> <span class="o">=</span> <span class="n">faces</span><span class="o">.</span><span class="n">shape</span>
-    <span class="k">if</span> <span class="n">n_face</span> <span class="o">&gt;</span> <span class="n">MAX_N_FACE</span><span class="p">:</span>
-        <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
-            <span class="sa">f</span><span class="s2">&quot;faces contains </span><span class="si">{</span><span class="n">n_face</span><span class="si">}</span><span class="s2"> faces. &quot;</span>
-            <span class="sa">f</span><span class="s2">&quot;numba_celltree supports a maximum of </span><span class="si">{</span><span class="n">MAX_N_FACE</span><span class="si">}</span><span class="s2"> faces. &quot;</span>
-            <span class="sa">f</span><span class="s2">&quot;Increase MAX_N_FACE in the source code, or supply a smaller mesh.&quot;</span>
-        <span class="p">)</span>
+    <span class="n">_</span><span class="p">,</span> <span class="n">n_max_vert</span> <span class="o">=</span> <span class="n">faces</span><span class="o">.</span><span class="n">shape</span>
     <span class="k">if</span> <span class="n">n_max_vert</span> <span class="o">&gt;</span> <span class="n">MAX_N_VERTEX</span><span class="p">:</span>
         <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
             <span class="sa">f</span><span class="s2">&quot;faces contains up to </span><span class="si">{</span><span class="n">n_max_vert</span><span class="si">}</span><span class="s2"> vertices for a single face. &quot;</span>
@@ -614,7 +607,9 @@ <h1>Source code for numba_celltree.celltree</h1><div class="highlight"><pre>
         <span class="k">return</span> <span class="n">i</span><span class="p">[</span><span class="n">actual</span><span class="p">],</span> <span class="n">j</span><span class="p">[</span><span class="n">actual</span><span class="p">],</span> <span class="n">area</span><span class="p">[</span><span class="n">actual</span><span class="p">]</span></div>
 
 
-    <span class="k">def</span> <span class="nf">_locate_faces</span><span class="p">(</span>
+<div class="viewcode-block" id="CellTree2d.locate_faces">
+<a class="viewcode-back" href="../../api.html#numba_celltree.CellTree2d.locate_faces">[docs]</a>
+    <span class="k">def</span> <span class="nf">locate_faces</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span> <span class="n">vertices</span><span class="p">:</span> <span class="n">FloatArray</span><span class="p">,</span> <span class="n">faces</span><span class="p">:</span> <span class="n">IntArray</span>
     <span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">IntArray</span><span class="p">,</span> <span class="n">IntArray</span><span class="p">]:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
@@ -651,7 +646,8 @@ <h1>Source code for numba_celltree.celltree</h1><div class="highlight"><pre>
             <span class="n">indices_a</span><span class="o">=</span><span class="n">shortlist_i</span><span class="p">,</span>
             <span class="n">indices_b</span><span class="o">=</span><span class="n">shortlist_j</span><span class="p">,</span>
         <span class="p">)</span>
-        <span class="k">return</span> <span class="n">shortlist_i</span><span class="p">[</span><span class="n">intersects</span><span class="p">],</span> <span class="n">shortlist_j</span><span class="p">[</span><span class="n">intersects</span><span class="p">]</span>
+        <span class="k">return</span> <span class="n">shortlist_i</span><span class="p">[</span><span class="n">intersects</span><span class="p">],</span> <span class="n">shortlist_j</span><span class="p">[</span><span class="n">intersects</span><span class="p">]</span></div>
+
 
 <div class="viewcode-block" id="CellTree2d.intersect_faces">
 <a class="viewcode-back" href="../../api.html#numba_celltree.CellTree2d.intersect_faces">[docs]</a>
@@ -684,7 +680,7 @@ <h1>Source code for numba_celltree.celltree</h1><div class="highlight"><pre>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="n">vertices</span> <span class="o">=</span> <span class="n">cast_vertices</span><span class="p">(</span><span class="n">vertices</span><span class="p">)</span>
         <span class="n">faces</span> <span class="o">=</span> <span class="n">cast_faces</span><span class="p">(</span><span class="n">faces</span><span class="p">,</span> <span class="n">fill_value</span><span class="p">)</span>
-        <span class="n">i</span><span class="p">,</span> <span class="n">j</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_locate_faces</span><span class="p">(</span><span class="n">vertices</span><span class="p">,</span> <span class="n">faces</span><span class="p">)</span>
+        <span class="n">i</span><span class="p">,</span> <span class="n">j</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">locate_faces</span><span class="p">(</span><span class="n">vertices</span><span class="p">,</span> <span class="n">faces</span><span class="p">)</span>
         <span class="n">area</span> <span class="o">=</span> <span class="n">area_of_intersection</span><span class="p">(</span>
             <span class="n">vertices_a</span><span class="o">=</span><span class="n">vertices</span><span class="p">,</span>
             <span class="n">vertices_b</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">vertices</span><span class="p">,</span>

diff --git a/_sources/examples/sg_execution_times.rst.txt b/_sources/examples/sg_execution_times.rst.txt
@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:00.746** total execution time for 1 file **from examples**:
+**00:00.752** total execution time for 1 file **from examples**:
 
 .. container::
 
@@ -33,5 +33,5 @@ Computation times
      - Time
      - Mem (MB)
    * - :ref:`sphx_glr_examples_spatial_indexing.py` (``spatial_indexing.py``)
-     - 00:00.746
+     - 00:00.752
      - 0.0
diff --git a/_sources/examples/spatial_indexing.rst.txt b/_sources/examples/spatial_indexing.rst.txt
@@ -676,7 +676,7 @@ with the Euclidian norm (Pythagorean distance):
 
 .. rst-class:: sphx-glr-timing
 
-   **Total running time of the script:** (0 minutes 0.746 seconds)
+   **Total running time of the script:** (0 minutes 0.752 seconds)
 
 
 .. _sphx_glr_download_examples_spatial_indexing.py:

diff --git a/_sources/sg_execution_times.rst.txt b/_sources/sg_execution_times.rst.txt
@@ -6,7 +6,7 @@
 
 Computation times
 =================
-**00:00.746** total execution time for 1 file **from all galleries**:
+**00:00.752** total execution time for 1 file **from all galleries**:
 
 .. container::
 
@@ -33,5 +33,5 @@ Computation times
      - Time
      - Mem (MB)
    * - :ref:`sphx_glr_examples_spatial_indexing.py` (``../examples/spatial_indexing.py``)
-     - 00:00.746
+     - 00:00.752
      - 0.0
diff --git a/_static/documentation_options.js b/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.1.6',
+    VERSION: '0.1.7',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/api.html b/api.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>CellTree2d &#8212; Numba Celltree 0.1.6 documentation</title>
+    <title>CellTree2d &#8212; Numba Celltree 0.1.7 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="_static/documentation_options.js?v=6e0256f3"></script>
+    <script src="_static/documentation_options.js?v=ca7ad2ea"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'api';</script>
@@ -516,6 +516,32 @@
 </dl>
 </dd></dl>
 
+<dl class="py method">
+<dt class="sig sig-object py" id="numba_celltree.CellTree2d.locate_faces">
+<span class="sig-name descname"><span class="pre">locate_faces</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">vertices</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">faces</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">ndarray</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">ndarray</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/numba_celltree/celltree.html#CellTree2d.locate_faces"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numba_celltree.CellTree2d.locate_faces" title="Link to this definition">#</a></dt>
+<dd><p>Find the index of a face intersecting with another face.</p>
+<p>Only sharing an edge also counts as an intersection, due to the use of
+the separating axis theorem to define intersection. The area of the
+overlap is zero in such a case.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>vertices</strong> (ndarray of floats with shape <code class="docutils literal notranslate"><span class="pre">(n_point,</span> <span class="pre">2)</span></code>) – Corner coordinates (x, y) of the cells.</p></li>
+<li><p><strong>faces</strong> (ndarray of integers with shape <code class="docutils literal notranslate"><span class="pre">(n_face,</span> <span class="pre">n_max_vert)</span></code>) – Index identifying for every face the indices of its corner nodes.
+If a face has less corner nodes than n_max_vert, its last indices
+should be equal to <code class="docutils literal notranslate"><span class="pre">fill_value</span></code>.</p></li>
+</ul>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><ul class="simple">
+<li><p><strong>face_indices</strong> (ndarray of integers with shape <code class="docutils literal notranslate"><span class="pre">(n_found,)</span></code>) – Indices of the faces.</p></li>
+<li><p><strong>tree_face_indices</strong> (ndarray of integers with shape <code class="docutils literal notranslate"><span class="pre">(n_found,)</span></code>) – Indices of the tree faces.</p></li>
+</ul>
+</p>
+</dd>
+</dl>
+</dd></dl>
+
 <dl class="py method">
 <dt class="sig sig-object py" id="numba_celltree.CellTree2d.locate_points">
 <span class="sig-name descname"><span class="pre">locate_points</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">points</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ndarray</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">ndarray</span></span></span><a class="reference internal" href="_modules/numba_celltree/celltree.html#CellTree2d.locate_points"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#numba_celltree.CellTree2d.locate_points" title="Link to this definition">#</a></dt>
@@ -630,6 +656,7 @@
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#numba_celltree.CellTree2d.intersect_edges"><code class="docutils literal notranslate"><span class="pre">CellTree2d.intersect_edges()</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#numba_celltree.CellTree2d.intersect_faces"><code class="docutils literal notranslate"><span class="pre">CellTree2d.intersect_faces()</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#numba_celltree.CellTree2d.locate_boxes"><code class="docutils literal notranslate"><span class="pre">CellTree2d.locate_boxes()</span></code></a></li>
+<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#numba_celltree.CellTree2d.locate_faces"><code class="docutils literal notranslate"><span class="pre">CellTree2d.locate_faces()</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#numba_celltree.CellTree2d.locate_points"><code class="docutils literal notranslate"><span class="pre">CellTree2d.locate_points()</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#numba_celltree.CellTree2d.node_bounds"><code class="docutils literal notranslate"><span class="pre">CellTree2d.node_bounds</span></code></a></li>
 <li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#numba_celltree.CellTree2d.to_dict_of_lists"><code class="docutils literal notranslate"><span class="pre">CellTree2d.to_dict_of_lists()</span></code></a></li>

diff --git a/examples/index.html b/examples/index.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Examples &#8212; Numba Celltree 0.1.6 documentation</title>
+    <title>Examples &#8212; Numba Celltree 0.1.7 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../_static/documentation_options.js?v=6e0256f3"></script>
+    <script src="../_static/documentation_options.js?v=ca7ad2ea"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'examples/index';</script>

diff --git a/examples/sg_execution_times.html b/examples/sg_execution_times.html
@@ -8,7 +8,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
-    <title>Computation times &#8212; Numba Celltree 0.1.6 documentation</title>
+    <title>Computation times &#8212; Numba Celltree 0.1.7 documentation</title>
 
 
 
@@ -40,7 +40,7 @@
 <link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=dfe6caa3a7d634c4db9b" />
   <script src="../_static/vendor/fontawesome/6.5.2/js/all.min.js?digest=dfe6caa3a7d634c4db9b"></script>
 
-    <script src="../_static/documentation_options.js?v=6e0256f3"></script>
+    <script src="../_static/documentation_options.js?v=ca7ad2ea"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script>DOCUMENTATION_OPTIONS.pagename = 'examples/sg_execution_times';</script>
@@ -382,7 +382,7 @@
 
   <section id="computation-times">
 <span id="sphx-glr-examples-sg-execution-times"></span><h1>Computation times<a class="headerlink" href="#computation-times" title="Link to this heading">#</a></h1>
-<p><strong>00:00.746</strong> total execution time for 1 file <strong>from examples</strong>:</p>
+<p><strong>00:00.752</strong> total execution time for 1 file <strong>from examples</strong>:</p>
 <div class="docutils container">
 <style scoped>
 <link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/5.3.0/css/bootstrap.min.css" rel="stylesheet" />
@@ -404,7 +404,7 @@
 </thead>
 <tbody>
 <tr class="row-even"><td><p><a class="reference internal" href="spatial_indexing.html#sphx-glr-examples-spatial-indexing-py"><span class="std std-ref">Spatial indexing</span></a> (<code class="docutils literal notranslate"><span class="pre">spatial_indexing.py</span></code>)</p></td>
-<td><p>00:00.746</p></td>
+<td><p>00:00.752</p></td>
 <td><p>0.0</p></td>
 </tr>
 </tbody>