dfm_mesh information

lanl · Feb 1, 2024 · 0fa907e · 0fa907e
1 parent 7100211
commit 0fa907e
Show file tree

Hide file tree

Showing 9 changed files with 87 additions and 44 deletions.
diff --git a/docs/_modules/index.html b/docs/_modules/index.html
@@ -97,6 +97,7 @@ <h1>All modules for which code is available</h1>
 <li><a href="pydfnworks/dfnGen/generation/output_report/gen_output.html">pydfnworks.dfnGen.generation.output_report.gen_output</a></li>
 <li><a href="pydfnworks/dfnGen/generation/stress.html">pydfnworks.dfnGen.generation.stress</a></li>
 <li><a href="pydfnworks/dfnGen/meshing/add_attribute_to_mesh.html">pydfnworks.dfnGen.meshing.add_attribute_to_mesh</a></li>
+<li><a href="pydfnworks/dfnGen/meshing/dfm/mesh_dfm.html">pydfnworks.dfnGen.meshing.dfm.mesh_dfm</a></li>
 <li><a href="pydfnworks/dfnGen/meshing/mapdfn_ecpm/mapdfn_ecpm.html">pydfnworks.dfnGen.meshing.mapdfn_ecpm.mapdfn_ecpm</a></li>
 <li><a href="pydfnworks/dfnGen/meshing/mesh_dfn/mesh_dfn.html">pydfnworks.dfnGen.meshing.mesh_dfn.mesh_dfn</a></li>
 <li><a href="pydfnworks/dfnGen/meshing/mesh_dfn/mesh_dfn_helper.html">pydfnworks.dfnGen.meshing.mesh_dfn.mesh_dfn_helper</a></li>

diff --git a/docs/_sources/pydfnGen.rst.txt b/docs/_sources/pydfnGen.rst.txt
@@ -193,12 +193,8 @@ DFM
 
 Creating a conforming DFM mesh DFN
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. automodule:: pydfnworks.dfnGen.meshing.dfm
+.. automodule:: pydfnworks.dfnGen.meshing.dfm.mesh_dfm
     :members:  mesh_dfm
 
 
 
-
-
-
-
diff --git a/docs/genindex.html b/docs/genindex.html
@@ -264,8 +264,17 @@ <h2 id="M">M</h2>
       <li><a href="pydfnGen.html#pydfnworks.dfnGen.meshing.udfm.map2continuum.map_to_continuum">map_to_continuum() (in module pydfnworks.dfnGen.meshing.udfm.map2continuum)</a>
 </li>
       <li><a href="pydfnGen.html#pydfnworks.dfnGen.meshing.mapdfn_ecpm.mapdfn_ecpm.mapdfn_ecpm">mapdfn_ecpm() (in module pydfnworks.dfnGen.meshing.mapdfn_ecpm.mapdfn_ecpm)</a>
+</li>
+      <li><a href="pydfnGen.html#pydfnworks.dfnGen.meshing.dfm.mesh_dfm.mesh_dfm">mesh_dfm() (in module pydfnworks.dfnGen.meshing.dfm.mesh_dfm)</a>
 </li>
       <li>
+    mesh_dfm.py
+
+      <ul>
+        <li><a href="pydfnGen.html#module-mesh_dfm.py">module</a>
+</li>
+      </ul></li>
+      <li>
     mesh_dfn.py
 
       <ul>
@@ -290,6 +299,8 @@ <h2 id="M">M</h2>
         <li><a href="pydfnGraph.html#module-graph_transport.py">graph_transport.py</a>
 </li>
         <li><a href="pydfnGen.html#module-map2continuum.py">map2continuum.py</a>
+</li>
+        <li><a href="pydfnGen.html#module-mesh_dfm.py">mesh_dfm.py</a>
 </li>
         <li><a href="pydfnGen.html#module-mesh_dfn.py">mesh_dfn.py</a>
 </li>
@@ -315,7 +326,7 @@ <h2 id="M">M</h2>
 </li>
         <li><a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.add_attribute_to_mesh">pydfnworks.dfnGen.meshing.add_attribute_to_mesh</a>
 </li>
-        <li><a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.dfm">pydfnworks.dfnGen.meshing.dfm</a>
+        <li><a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.dfm.mesh_dfm">pydfnworks.dfnGen.meshing.dfm.mesh_dfm</a>
 </li>
         <li><a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.mapdfn_ecpm.mapdfn_ecpm">pydfnworks.dfnGen.meshing.mapdfn_ecpm.mapdfn_ecpm</a>
 </li>
@@ -445,10 +456,10 @@ <h2 id="P">P</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li>
-    pydfnworks.dfnGen.meshing.dfm
+    pydfnworks.dfnGen.meshing.dfm.mesh_dfm
 
       <ul>
-        <li><a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.dfm">module</a>
+        <li><a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.dfm.mesh_dfm">module</a>
 </li>
       </ul></li>
       <li>

diff --git a/docs/index.html b/docs/index.html
@@ -190,7 +190,7 @@ <h1>Welcome to dfnWorks 2.8 documentation!<a class="headerlink" href="#welcome-t
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="pydfnGen.html#dfm">DFM</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.dfm">Creating a conforming DFM mesh DFN</a></li>
+<li class="toctree-l3"><a class="reference internal" href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.dfm.mesh_dfm">Creating a conforming DFM mesh DFN</a></li>
 </ul>
 </li>
 </ul>

diff --git a/docs/index_docs.html b/docs/index_docs.html
@@ -191,7 +191,7 @@ <h1>Welcome to dfnWorks 2.8 documentation!<a class="headerlink" href="#welcome-t
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="pydfnGen.html#dfm">DFM</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.dfm">Creating a conforming DFM mesh DFN</a></li>
+<li class="toctree-l3"><a class="reference internal" href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.dfm.mesh_dfm">Creating a conforming DFM mesh DFN</a></li>
 </ul>
 </li>
 </ul>

diff --git a/docs/objects.inv b/docs/objects.inv
diff --git a/docs/py-modindex.html b/docs/py-modindex.html
@@ -146,20 +146,31 @@ <h1>Python Module Index</h1>
        <td><img src="_static/minus.png" class="toggler"
               id="toggle-4" style="display: none" alt="-" /></td>
        <td>
-       <code class="xref">mesh_dfn</code></td><td>
+       <code class="xref">mesh_dfm</code></td><td>
        <em></em></td></tr>
      <tr class="cg-4">
+       <td></td>
+       <td>&#160;&#160;&#160;
+       <a href="pydfnGen.html#module-mesh_dfm.py"><code class="xref">mesh_dfm.py</code></a></td><td>
+       <em>meshing driver for conforming DFM</em></td></tr>
+     <tr>
+       <td><img src="_static/minus.png" class="toggler"
+              id="toggle-5" style="display: none" alt="-" /></td>
+       <td>
+       <code class="xref">mesh_dfn</code></td><td>
+       <em></em></td></tr>
+     <tr class="cg-5">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-mesh_dfn.py"><code class="xref">mesh_dfn.py</code></a></td><td>
        <em>meshing driver for DFN</em></td></tr>
      <tr>
        <td><img src="_static/minus.png" class="toggler"
-              id="toggle-5" style="display: none" alt="-" /></td>
+              id="toggle-6" style="display: none" alt="-" /></td>
        <td>
        <code class="xref">mesh_dfn_helper</code></td><td>
        <em></em></td></tr>
-     <tr class="cg-5">
+     <tr class="cg-6">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-mesh_dfn_helper.py"><code class="xref">mesh_dfn_helper.py</code></a></td><td>
@@ -169,121 +180,121 @@ <h1>Python Module Index</h1>
        <strong>p</strong></td><td></td></tr>
      <tr>
        <td><img src="_static/minus.png" class="toggler"
-              id="toggle-6" style="display: none" alt="-" /></td>
+              id="toggle-7" style="display: none" alt="-" /></td>
        <td>
        <code class="xref">pydfnworks</code></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnFlow.html#module-pydfnworks.dfnFlow.fehm"><code class="xref">pydfnworks.dfnFlow.fehm</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnFlow.html#module-pydfnworks.dfnFlow.flow"><code class="xref">pydfnworks.dfnFlow.flow</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnFlow.html#module-pydfnworks.dfnFlow.mass_balance"><code class="xref">pydfnworks.dfnFlow.mass_balance</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnFlow.html#module-pydfnworks.dfnFlow.pflotran"><code class="xref">pydfnworks.dfnFlow.pflotran</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-pydfnworks.dfnGen.generation.generator"><code class="xref">pydfnworks.dfnGen.generation.generator</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-pydfnworks.dfnGen.generation.input_checking"><code class="xref">pydfnworks.dfnGen.generation.input_checking</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-pydfnworks.dfnGen.generation.input_checking.user_defined_fracture_functions"><code class="xref">pydfnworks.dfnGen.generation.input_checking.user_defined_fracture_functions</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-pydfnworks.dfnGen.generation.output_report.gen_output"><code class="xref">pydfnworks.dfnGen.generation.output_report.gen_output</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-pydfnworks.dfnGen.generation.stress"><code class="xref">pydfnworks.dfnGen.generation.stress</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.add_attribute_to_mesh"><code class="xref">pydfnworks.dfnGen.meshing.add_attribute_to_mesh</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.dfm"><code class="xref">pydfnworks.dfnGen.meshing.dfm</code></a></td><td>
+       <a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.dfm.mesh_dfm"><code class="xref">pydfnworks.dfnGen.meshing.dfm.mesh_dfm</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.mapdfn_ecpm.mapdfn_ecpm"><code class="xref">pydfnworks.dfnGen.meshing.mapdfn_ecpm.mapdfn_ecpm</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.mesh_dfn.mesh_dfn"><code class="xref">pydfnworks.dfnGen.meshing.mesh_dfn.mesh_dfn</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.mesh_dfn.mesh_dfn_helper"><code class="xref">pydfnworks.dfnGen.meshing.mesh_dfn.mesh_dfn_helper</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.udfm.false_connections"><code class="xref">pydfnworks.dfnGen.meshing.udfm.false_connections</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.udfm.map2continuum"><code class="xref">pydfnworks.dfnGen.meshing.udfm.map2continuum</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.udfm.upscale"><code class="xref">pydfnworks.dfnGen.meshing.udfm.upscale</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnWorks-well.html#module-pydfnworks.dfnGen.well_package.wells"><code class="xref">pydfnworks.dfnGen.well_package.wells</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGraph.html#module-pydfnworks.dfnGraph.dfn2graph"><code class="xref">pydfnworks.dfnGraph.dfn2graph</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGraph.html#module-pydfnworks.dfnGraph.graph_flow"><code class="xref">pydfnworks.dfnGraph.graph_flow</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGraph.html#module-pydfnworks.dfnGraph.graph_transport"><code class="xref">pydfnworks.dfnGraph.graph_transport</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGraph.html#module-pydfnworks.dfnGraph.pruning"><code class="xref">pydfnworks.dfnGraph.pruning</code></a></td><td>
        <em></em></td></tr>
-     <tr class="cg-6">
+     <tr class="cg-7">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnTrans.html#module-pydfnworks.dfnTrans.transport"><code class="xref">pydfnworks.dfnTrans.transport</code></a></td><td>
@@ -293,11 +304,11 @@ <h1>Python Module Index</h1>
        <strong>u</strong></td><td></td></tr>
      <tr>
        <td><img src="_static/minus.png" class="toggler"
-              id="toggle-7" style="display: none" alt="-" /></td>
+              id="toggle-8" style="display: none" alt="-" /></td>
        <td>
        <code class="xref">upscale</code></td><td>
        <em></em></td></tr>
-     <tr class="cg-7">
+     <tr class="cg-8">
        <td></td>
        <td>&#160;&#160;&#160;
        <a href="pydfnGen.html#module-upscale.py"><code class="xref">upscale.py</code></a></td><td>

diff --git a/docs/pydfnGen.html b/docs/pydfnGen.html
@@ -111,7 +111,10 @@
 </ul>
 </li>
 <li class="toctree-l2"><a class="reference internal" href="#dfm">DFM</a><ul>
-<li class="toctree-l3"><a class="reference internal" href="#module-pydfnworks.dfnGen.meshing.dfm">Creating a conforming DFM mesh DFN</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#module-pydfnworks.dfnGen.meshing.dfm.mesh_dfm">Creating a conforming DFM mesh DFN</a><ul>
+<li class="toctree-l4"><a class="reference internal" href="#pydfnworks.dfnGen.meshing.dfm.mesh_dfm.mesh_dfm"><code class="docutils literal notranslate"><span class="pre">mesh_dfm()</span></code></a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
@@ -863,8 +866,29 @@ <h3>Authors<a class="headerlink" href="#authors" title="Link to this heading">
 </section>
 <section id="dfm">
 <h2>DFM<a class="headerlink" href="#dfm" title="Link to this heading"></a></h2>
-<section id="module-pydfnworks.dfnGen.meshing.dfm">
-<span id="creating-a-conforming-dfm-mesh-dfn"></span><h3>Creating a conforming DFM mesh DFN<a class="headerlink" href="#module-pydfnworks.dfnGen.meshing.dfm" title="Link to this heading"></a></h3>
+<section id="module-pydfnworks.dfnGen.meshing.dfm.mesh_dfm">
+<span id="creating-a-conforming-dfm-mesh-dfn"></span><h3>Creating a conforming DFM mesh DFN<a class="headerlink" href="#module-pydfnworks.dfnGen.meshing.dfm.mesh_dfm" title="Link to this heading"></a></h3>
+<dl class="py function" id="module-mesh_dfm.py">
+<dt class="sig sig-object py" id="pydfnworks.dfnGen.meshing.dfm.mesh_dfm.mesh_dfm">
+<span class="sig-name descname"><span class="pre">mesh_dfm</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dirname</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">'dfm_mesh'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allowed_percentage</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">1</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">cleanup</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pydfnworks/dfnGen/meshing/dfm/mesh_dfm.html#mesh_dfm"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydfnworks.dfnGen.meshing.dfm.mesh_dfm.mesh_dfm" title="Link to this definition"></a></dt>
+<dd><p>” Creates a conforming mesh of a DFN using a uniform background tetrahedron mesh. The DFN must be meshed using a uniform triangular mesh. (DFN.mesh_network(uniform_mesh = True))</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>self</strong> (<em>DFN Object</em>) – </p></li>
+<li><p><strong>dirname</strong> (<em>string</em>) – name of working directory. Default : dfm_mesh</p></li>
+<li><p><strong>percentage</strong> (<em>float</em>) – </p></li>
+<li><p><strong>cleanup</strong> (<em>bool</em>) – Clean up working directory. If true dep files are moved into subdirectories</p></li>
+</ul>
+</dd>
+<dt class="field-even">Return type<span class="colon">:</span></dt>
+<dd class="field-even"><p>None</p>
+</dd>
+</dl>
+<p class="rubric">Notes</p>
+<p>None</p>
+</dd></dl>
+
 </section>
 </section>
 </section>

diff --git a/docs/searchindex.js b/docs/searchindex.js
-Original file line number
+Diff line change
@@ Expand Up @@
     </ul>
     </li>
     <li class="toctree-l2"><a class="reference internal" href="pydfnGen.html#dfm">DFM</a><ul>
-    <li class="toctree-l3"><a class="reference internal" href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.dfm">Creating a conforming DFM mesh DFN</a></li>
+    <li class="toctree-l3"><a class="reference internal" href="pydfnGen.html#module-pydfnworks.dfnGen.meshing.dfm.mesh_dfm">Creating a conforming DFM mesh DFN</a></li>
     </ul>
     </li>
     </ul>
@@ Expand Down @@