Functions
def	dfn_trans (self)

def	copy_dfn_trans_files (self)

def	run_dfn_trans (self)

def	create_dfn_trans_links (self, path='../')

def	check_dfn_trans_run_files (self)

Variables
	flow_solver

Function Documentation

◆ check_dfn_trans_run_files()

def pydfnworks.dfnTrans.transport.check_dfn_trans_run_files ( self )

 Ensures that all files required for dfnTrans run are in the current directory

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

Returns
--------
    None

Notes
-------
    None

Definition at line 123 of file transport.py.

◆ copy_dfn_trans_files()

def pydfnworks.dfnTrans.transport.copy_dfn_trans_files ( self )

Creates symlink to dfnTrans Execuateble and copies input files for dfnTrans into working directory

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

Returns
--------
    None

Definition at line 35 of file transport.py.

◆ create_dfn_trans_links()

def pydfnworks.dfnTrans.transport.create_dfn_trans_links	(	self,
		path = `'../'`
	)

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

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

Returns
--------
None

Notes
-------
Typically, the path is DFN.path, which is set by the command line argument -path

Definition at line 86 of file transport.py.

◆ dfn_trans()

def pydfnworks.dfnTrans.transport.dfn_trans ( self )

Primary driver for dfnTrans. 

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

Returns
--------
    None

Definition at line 8 of file transport.py.

◆ run_dfn_trans()

def pydfnworks.dfnTrans.transport.run_dfn_trans ( self )

 Execute dfnTrans

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

Returns
--------
None

Definition at line 63 of file transport.py.

Variable Documentation

◆ flow_solver

pydfnworks.dfnTrans.transport.flow_solver

Definition at line 109 of file transport.py.

Functions

Variables