.. _dfnWorks-python-chapter-dfnGen:

pydfnworks: dfnGen
========================================

DFN Class functions used in network generation and meshing

dfnGen
-------

Processing generator input
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: pydfnworks.dfnGen.generation.input_checking
    :members: check_input

Running the generator
^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: pydfnworks.dfnGen.generation.generator
    :members: dfn_gen, make_working_directory, create_network

Analysis of generated DFN 
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: pydfnworks.dfnGen.generation.output_report.gen_output
    :members: output_report

Modification of hydraulic properties of the DFN 
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: pydfnworks.dfnGen.generation.hydraulic_properties
    :members: generate_hydraulic_values, dump_hydraulic_values 

Meshing - LaGriT
-----------------

Primary DFN meshing driver
^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: pydfnworks.dfnGen.meshing.mesh_dfn
    :members: mesh_network


Meshing helper methods
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: pydfnworks.dfnGen.meshing.mesh_dfn_helper
    :members: inp2gmv, inp2vtk_python, create_mesh_links, run_lagrit_script

.. automodule:: pydfnworks.dfnGen.meshing.add_attribute_to_mesh
    :members: add_variable_to_mesh


UDFM 
--------


Creating an upscaled mesh of the DFN
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. automodule:: pydfnworks.dfnGen.meshing.udfm.map2continuum
    :members: map_to_continuum

.. automodule:: pydfnworks.dfnGen.meshing.udfm.upscale
    :members: upscale

.. automodule:: pydfnworks.dfnGen.meshing.udfm.false_connections
    :members: check_false_connections