dfm_mesh information

Documentation/sphinx-docs/source/conf.py

@@ -80,7 +80,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en' 
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:

Documentation/sphinx-docs/source/pydfnGen.rst

@@ -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
 
 
 
-
-
-
-

docs/_modules/pydfnworks/dfnGen/meshing/mesh_dfn/mesh_dfn.html

@@ -93,6 +93,7 @@ <h1>Source code for pydfnworks.dfnGen.meshing.mesh_dfn.mesh_dfn</h1><div class="
 <span class="sd">.. moduleauthor:: Jeffrey Hyman &lt;jhyman@lanl.gov&gt;</span>
 
 <span class="sd">&quot;&quot;&quot;</span>
+
 <span class="kn">import</span> <span class="nn">os</span>
 <span class="kn">import</span> <span class="nn">sys</span>
 <span class="kn">import</span> <span class="nn">shutil</span>
@@ -119,21 +120,20 @@ <h1>Source code for pydfnworks.dfnGen.meshing.mesh_dfn.mesh_dfn</h1><div class="
                  <span class="n">strict</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
                  <span class="n">quiet</span><span class="o">=</span><span class="kc">True</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<span class="sd">    </span>
-<span class="sd">    Mesh fracture network using LaGriT</span>
+<span class="sd">      Mesh fracture network using LaGriT</span>
 
 <span class="sd">    Parameters</span>
-<span class="sd">    ------------</span>
+<span class="sd">    ----------</span>
 <span class="sd">        self : object </span>
 <span class="sd">            DFN Class</span>
 <span class="sd">        uniform_mesh : bool</span>
 <span class="sd">            toggle for uniform or variable mesh. Default : False </span>
 <span class="sd">        min_dist : float</span>
-<span class="sd">            Defines the minimum distance from the intersections with resolution h/2. This value is the factor of h, distance = min_dist x h</span>
+<span class="sd">            Defines the minimum distance from the intersections with resolution h/2. This value is the factor of h, distance = min_dist * h</span>
 <span class="sd">        max_dist : float</span>
-<span class="sd">            Defines the minimum distance from the intersections with resolution max_resolution x h. This value is the factor of h, distance = max_dist x h</span>
+<span class="sd">            Defines the minimum distance from the intersections with resolution max_resolution * h. This value is the factor of h, distance = max_dist * h</span>
 <span class="sd">        max_resolution_factor : float</span>
-<span class="sd">            Maximum factor of the mesh resolultion (max_resolution x h). Depending on the slope of the linear function and size of the fracture, this may not be realized in the mesh. </span>
+<span class="sd">            Maximum factor of the mesh resolultion (max_resolution *h). Depending on the slope of the linear function and size of the fracture, this may not be realized in the mesh. </span>
 <span class="sd">        cleanup : bool</span>
 <span class="sd">            toggle to clean up directory (remove meshing files after a run). Default : True</span>
 <span class="sd">        strict : bool</span>
@@ -142,11 +142,11 @@ <h1>Source code for pydfnworks.dfnGen.meshing.mesh_dfn.mesh_dfn</h1><div class="
 <span class="sd">            Toggle to turn on/off verbose information to screen about meshing. Default is true, does not print to screen</span>
 
 <span class="sd">    Returns</span>
-<span class="sd">    ------------</span>
+<span class="sd">    -------</span>
 <span class="sd">        None</span>
 
 <span class="sd">    Notes</span>
-<span class="sd">    ------------</span>
+<span class="sd">    ------</span>
 <span class="sd">        1. All fractures in self.prune_file must intersect at least 1 other fracture</span>
 
 <span class="sd">    &quot;&quot;&quot;</span>

docs/pydfnGen.html

@@ -596,15 +596,17 @@ <h2>Meshing - LaGriT<a class="headerlink" href="#meshing-lagrit" title="Link to
 <dl class="py function" id="module-mesh_dfn.py">
 <dt class="sig sig-object py" id="pydfnworks.dfnGen.meshing.mesh_dfn.mesh_dfn.mesh_network">
 <span class="sig-name descname"><span class="pre">mesh_network</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">uniform_mesh</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">min_dist</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">0.5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_dist</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_resolution_factor</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">10</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">well</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</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>, <em class="sig-param"><span class="n"><span class="pre">strict</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">quiet</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/mesh_dfn/mesh_dfn.html#mesh_network"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#pydfnworks.dfnGen.meshing.mesh_dfn.mesh_dfn.mesh_network" title="Link to this definition"></a></dt>
-<dd><p>Mesh fracture network using LaGriT</p>
+<dd><blockquote>
+<div><p>Mesh fracture network using LaGriT</p>
+</div></blockquote>
 <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>object</em>) – DFN Class</p></li>
 <li><p><strong>uniform_mesh</strong> (<em>bool</em>) – toggle for uniform or variable mesh. Default : False</p></li>
-<li><p><strong>min_dist</strong> (<em>float</em>) – Defines the minimum distance from the intersections with resolution h/2. This value is the factor of h, distance = min_dist x h</p></li>
-<li><p><strong>max_dist</strong> (<em>float</em>) – Defines the minimum distance from the intersections with resolution max_resolution x h. This value is the factor of h, distance = max_dist x h</p></li>
-<li><p><strong>max_resolution_factor</strong> (<em>float</em>) – Maximum factor of the mesh resolultion (max_resolution x h). Depending on the slope of the linear function and size of the fracture, this may not be realized in the mesh.</p></li>
+<li><p><strong>min_dist</strong> (<em>float</em>) – Defines the minimum distance from the intersections with resolution h/2. This value is the factor of h, distance = min_dist * h</p></li>
+<li><p><strong>max_dist</strong> (<em>float</em>) – Defines the minimum distance from the intersections with resolution max_resolution * h. This value is the factor of h, distance = max_dist * h</p></li>
+<li><p><strong>max_resolution_factor</strong> (<em>float</em>) – Maximum factor of the mesh resolultion (max_resolution <a href="#id1"><span class="problematic" id="id2">*</span></a>h). Depending on the slope of the linear function and size of the fracture, this may not be realized in the mesh.</p></li>
 <li><p><strong>cleanup</strong> (<em>bool</em>) – toggle to clean up directory (remove meshing files after a run). Default : True</p></li>
 <li><p><strong>strict</strong> (<em>bool</em>) – Toggle if a few mesh errors are acceptable. default is true</p></li>
 <li><p><strong>quiet</strong> (<em>bool</em>) – Toggle to turn on/off verbose information to screen about meshing. Default is true, does not print to screen</p></li>
@@ -875,9 +877,8 @@ <h2>DFM<a class="headerlink" href="#dfm" title="Link to this heading"></a></h
 <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>allowed_percentage</strong> (<em>float</em>) – Percentage of the mesh allowed to be missing and still continue</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>
@@ -886,7 +887,7 @@ <h2>DFM<a class="headerlink" href="#dfm" title="Link to this heading"></a></h
 </dd>
 </dl>
 <p class="rubric">Notes</p>
-<p>None</p>
+<p>The final mesh is output in exodus format. This requires that LaGriT is built against exodus.</p>
 </dd></dl>
 
 </section>

pydfnworks/pydfnworks.egg-info/SOURCES.txt

@@ -84,6 +84,7 @@ pydfnworks/dfnGraph/__init__.py
 pydfnworks/dfnGraph/bipartite_graph.py
 pydfnworks/dfnGraph/dfn2graph.py
 pydfnworks/dfnGraph/fracture_graph.py
+pydfnworks/dfnGraph/graphConversions.py
 pydfnworks/dfnGraph/graph_attributes.py
 pydfnworks/dfnGraph/graph_conversions.py
 pydfnworks/dfnGraph/graph_flow.py
@@ -92,6 +93,7 @@ pydfnworks/dfnGraph/graph_transport.py
 pydfnworks/dfnGraph/intersection_graph.py
 pydfnworks/dfnGraph/particle_class.py
 pydfnworks/dfnGraph/particle_io.py
+pydfnworks/dfnGraph/projection.py
 pydfnworks/dfnGraph/pruning.py
 pydfnworks/dfnTrans/__init__.py
 pydfnworks/dfnTrans/transport.py

pydfnworks/pydfnworks/dfnGen/meshing/dfm/mesh_dfm.py

@@ -758,11 +758,10 @@ def mesh_dfm(self, dirname = "dfm_mesh", allowed_percentage = 1, cleanup = True)
 
     Parameters
     ------------------
-        self : DFN Object
         dirname : string
             name of working directory. Default : dfm_mesh
-        percentage : float
-
+        allowed_percentage : float
+            Percentage of the mesh allowed to be missing and still continue
         cleanup : bool
             Clean up working directory. If true dep files are moved into subdirectories
 
@@ -772,7 +771,7 @@ def mesh_dfm(self, dirname = "dfm_mesh", allowed_percentage = 1, cleanup = True)
 
     Notes
     --------------
-        None 
+        The final mesh is output in exodus format. This requires that LaGriT is built against exodus.  
          
     """