pydfnWorks
python wrapper for dfnWorks
pydfnworks.general.general_functions Namespace Reference

Functions

def dump_time (self, function_name, time)
 
def print_run_time (self)
 

Function Documentation

◆ dump_time()

def pydfnworks.general.general_functions.dump_time (   self,
  function_name,
  time 
)
Write run time for a funcion to the jobname_run_time.txt file 

Parameters
----------
    self : object
        DFN Class 
    function_name : string
        Name of function that was timed
    time : float
        Run time of function in seconds

Returns
----------
    None

Notes
--------- 
While this function is working, the current formulation is not robust through the entire workflow

Definition at line 5 of file general_functions.py.

◆ print_run_time()

def pydfnworks.general.general_functions.print_run_time (   self)
Read in run times from file and and print to screen with percentages

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

Returns
--------
    None

Notes
--------
This will dump out all values in the run file, not just those from the most recent run

Definition at line 40 of file general_functions.py.