pydfnworks.dfnFlow.flow Namespace Reference

Functions
def	set_flow_solver (self, flow_solver)
def	dfn_flow (self, dump_vtk=True, effective_perm=True)
def	create_dfn_flow_links (self, path='../')

Variables
	flow_solver

Function Documentation

create_dfn_flow_links()

def pydfnworks.dfnFlow.flow.create_dfn_flow_links	(		self,
			path = '../'
	)

 Create symlinks to files required to run dfnFlow that are in another directory. 

Parameters
---------
    self : object
        DFN Class
    path : string 
        Absolute path to primary directory. 

Returns
--------
    None

Notes
-------
    1. Typically, the path is DFN.path, which is set by the command line argument -path
    2. Currently only supported for PFLOTRAN

Definition at line 101 of file flow.py.

dfn_flow()

def pydfnworks.dfnFlow.flow.dfn_flow	(		self,
			dump_vtk = True,
			effective_perm = True
	)

 Run the dfnFlow portion of the workflow
   
Parameters
----------
    self : object
        DFN Class
    dump_vtk : bool
        True - Write out vtk files for flow solutions 
        False  - Does not write out vtk files for flow solutions 

Returns
---------

Notes
--------
Information on individual functions is found therein 

Definition at line 37 of file flow.py.

set_flow_solver()

def pydfnworks.dfnFlow.flow.set_flow_solver	(		self,
			flow_solver
	)

Sets flow solver to be used 
   
Parameters
----------
    self : object
        DFN Class
    flow_solver: string  
        Name of flow solver. Currently supported flow sovlers are FEHM and PFLOTRAN

Returns
---------

Notes
--------
Default is PFLOTRAN 

Definition at line 10 of file flow.py.

Variable Documentation

flow_solver

pydfnworks.dfnFlow.flow.flow_solver

Definition at line 30 of file flow.py.