diff --git a/Documentation/sphinx-docs/source/conf.py b/Documentation/sphinx-docs/source/conf.py index 49f15465..2639deb3 100755 --- a/Documentation/sphinx-docs/source/conf.py +++ b/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: diff --git a/Documentation/sphinx-docs/source/pydfnGen.rst b/Documentation/sphinx-docs/source/pydfnGen.rst index 2bade714..f8662c40 100644 --- a/Documentation/sphinx-docs/source/pydfnGen.rst +++ b/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 - - - - diff --git a/docs/_modules/index.html b/docs/_modules/index.html index b359001e..f93c8af8 100644 --- a/docs/_modules/index.html +++ b/docs/_modules/index.html @@ -97,6 +97,7 @@
mesh_dfn
mesh_dfm
mesh_dfm.py
mesh_dfn
mesh_dfn.py
mesh_dfn_helper
mesh_dfn_helper.py
pydfnworks
pydfnworks.dfnFlow.fehm
pydfnworks.dfnFlow.flow
pydfnworks.dfnFlow.mass_balance
pydfnworks.dfnFlow.pflotran
pydfnworks.dfnGen.generation.generator
pydfnworks.dfnGen.generation.input_checking
pydfnworks.dfnGen.generation.input_checking.user_defined_fracture_functions
pydfnworks.dfnGen.generation.output_report.gen_output
pydfnworks.dfnGen.generation.stress
pydfnworks.dfnGen.meshing.add_attribute_to_mesh
pydfnworks.dfnGen.meshing.dfm
pydfnworks.dfnGen.meshing.dfm.mesh_dfm
pydfnworks.dfnGen.meshing.mapdfn_ecpm.mapdfn_ecpm
pydfnworks.dfnGen.meshing.mesh_dfn.mesh_dfn
pydfnworks.dfnGen.meshing.mesh_dfn.mesh_dfn_helper
pydfnworks.dfnGen.meshing.udfm.false_connections
pydfnworks.dfnGen.meshing.udfm.map2continuum
pydfnworks.dfnGen.meshing.udfm.upscale
pydfnworks.dfnGen.well_package.wells
pydfnworks.dfnGraph.dfn2graph
pydfnworks.dfnGraph.graph_flow
pydfnworks.dfnGraph.graph_transport
pydfnworks.dfnGraph.pruning
pydfnworks.dfnTrans.transport
upscale
upscale.py
Mesh fracture network using LaGriT
++Mesh fracture network using LaGriT
+
self (object) – DFN Class
uniform_mesh (bool) – toggle for uniform or variable mesh. Default : False
min_dist (float) – Defines the minimum distance from the intersections with resolution h/2. This value is the factor of h, distance = min_dist x h
max_dist (float) – 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
max_resolution_factor (float) – 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.
min_dist (float) – Defines the minimum distance from the intersections with resolution h/2. This value is the factor of h, distance = min_dist * h
max_dist (float) – Defines the minimum distance from the intersections with resolution max_resolution * h. This value is the factor of h, distance = max_dist * h
max_resolution_factor (float) – 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.
cleanup (bool) – toggle to clean up directory (remove meshing files after a run). Default : True
strict (bool) – Toggle if a few mesh errors are acceptable. default is true
quiet (bool) – Toggle to turn on/off verbose information to screen about meshing. Default is true, does not print to screen
” 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))
+dirname (string) – name of working directory. Default : dfm_mesh
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
None
+Notes
+The final mesh is output in exodus format. This requires that LaGriT is built against exodus.
+