pywfm.IWFMModel._get_hydrograph#

IWFMModel._get_hydrograph(hydrograph_type, hydrograph_index, layer_number, begin_date, end_date, length_conversion_factor, volume_conversion_factor)#

private method returning a simulated hydrograph for a selected hydrograph type and hydrograph index

Parameters:
  • hydrograph_type (int) – one of the available hydrograph types for the model retrieved using get_hydrograph_type_list method

  • hydrograph_index (int) – index for hydrograph being retrieved

  • layer_number (int) – layer number for returning hydrograph. only used for groundwater hydrograph at node and layer

  • begin_date (str) – IWFM-style date for the beginning date of the simulated groundwater heads

  • end_date (str) – IWFM-style date for the end date of the simulated groundwater heads

  • length_conversion_factor (float, int) – hydrographs with units of length are multiplied by this value to convert simulation units to desired output units

  • volume_conversion_factor (float, int) – hydrographs with units of volume are multiplied by this value to convert simulation units to desired output units

Returns:

1-D array of dates 1-D array of hydrograph values

Return type:

np.arrays