Functions
def	dfn_gen (self, output=True, visual_mode=None)

def	make_working_directory (self, delete=False)

def	create_network (self)

Variables
	num_frac

	h

Function Documentation

◆ create_network()

def pydfnworks.dfnGen.generation.generator.create_network ( self )

 Execute dfnGen

Parameters
----------
    self : object
        DFN Class 

Returns
-------
    None

Notes
-----
After generation is complete, this script checks whether the generation of the fracture network failed or succeeded based on the existence of the file params.txt.

Definition at line 121 of file generator.py.

◆ dfn_gen()

def pydfnworks.dfnGen.generation.generator.dfn_gen	(	self,
		output = `True`,
		visual_mode = `None`
	)

 Wrapper script the runs the dfnGen workflow:    
    1) make_working_directory: Create a directory with name of job
    2) check_input: Check input parameters and create a clean version of the input file
    3) create_network: Create network. DFNGEN v2.0 is called and creates the network
    4) output_report: Generate a PDF summary of the DFN generation
    5) mesh_network: calls module dfnGen_meshing and runs LaGriT to mesh the DFN

Parameters
----------
    self : object
        DFN Class object
    output : bool
        If True, output pdf will be created. If False, no pdf is made 
    visual_mode : None
        If the user wants to run in a different meshing mode from what is in params.txt, set visual_mode = True/False on command line to override meshing mode

Returns
-------
    None

Notes
-----
    Details of each portion of the routine are in those sections

Definition at line 9 of file generator.py.

◆ make_working_directory()

def pydfnworks.dfnGen.generation.generator.make_working_directory	(	self,
		delete = `False`
	)

 Make working directory for dfnWorks Simulation

Parameters
----------
    self : object
        DFN Class object

Returns
-------
    None

Notes
-----
If directory already exists, user is prompted if they want to overwrite and proceed. If not, program exits.

Definition at line 66 of file generator.py.

Variable Documentation

◆ h

pydfnworks.dfnGen.generation.generator.h

Definition at line 153 of file generator.py.

◆ num_frac

pydfnworks.dfnGen.generation.generator.num_frac

Definition at line 152 of file generator.py.

Functions