pywfm.IWFMModel.get_subsidence_hydrograph#

IWFMModel.get_subsidence_hydrograph(subsidence_hydrograph_id, begin_date=None, end_date=None, length_conversion_factor=1.0, volume_conversion_factor=1.0)#

Return the simulated subsidence hydrograph for the provided subsidence hydrograph ID

Parameters:

subsidence_hydrograph_id (int) – ID for subsidence hydrograph location being retrieved
begin_date (str or None, default=None) – IWFM-style date for the beginning date of the simulated subsidence
end_date (str or None, default=None) – IWFM-style date for the end date of the simulated subsidence
length_conversion_factor (float, int, default=1.0) – hydrographs with units of length are multiplied by this value to convert simulation units to desired output units
volume_conversion_factor (float, int, default=1.0) – hydrographs with units of volume are multiplied by this value to convert simulation units to desired output units e.g. use 2.29568E-8 for ft^3 –> TAF

Returns:

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

Return type:

np.arrays

See also

IWFMModel.get_n_hydrograph_types: Return the number of different hydrograph types being printed by the IWFM model
IWFMModel.get_hydrograph_type_list: Return a list of different hydrograph types being printed by the IWFM model
IWFMModel.get_n_groundwater_hydrographs: Return the number of groundwater hydrographs specified in an IWFM model
IWFMModel.get_n_subsidence_hydrographs: Return the number of subsidence hydrographs specified in an IWFM model
IWFMModel.get_n_stream_hydrographs: Return the number of stream flow hydrographs specified in an IWFM model
IWFMModel.get_n_tile_drain_hydrographs: Return the number of tile drain hydrographs specified in an IWFM model
IWFMModel.get_groundwater_hydrograph_ids: Return the IDs for the groundwater hydrographs specified in an IWFM model
IWFMModel.get_subsidence_hydrograph_ids: Return the IDs for the subsidence hydrographs specified in an IWFM model
IWFMModel.get_stream_hydrograph_ids: Return the IDs for the stream hydrographs specified in an IWFM model
IWFMModel.get_tile_drain_hydrograph_ids: Return the IDs for the tile drain hydrographs specified in an IWFM model
IWFMModel.get_groundwater_hydrograph_coordinates: Return the x,y-coordinates for the groundwater hydrographs specified in an IWFM model
IWFMModel.get_subsidence_hydrograph_coordinates: Return the x,y-coordinates for the subsidence hydrograph locations specified in an IWFM model
IWFMModel.get_stream_hydrograph_coordinates: Return the x,y-coordinates for the stream flow observation locations specified in an IWFM model
IWFMModel.get_tile_drain_hydrograph_coordinates: Return the x,y-coordinates for the tile drain observations specified in an IWFM model
IWFMModel.get_groundwater_hydrograph: Return the simulated groundwater hydrograph for the provided groundwater hydrograph id
IWFMModel.get_groundwater_hydrograph_at_node_and_layer: Return a simulated groundwater hydrograph for a node and layer
IWFMModel.get_stream_hydrograph: Return the simulated stream hydrograph for the provided stream hydrograph id
IWFMModel.get_tile_drain_hydrograph: Return the simulated tile drain hydrograph for the provided tile drain hydrograph id

Example

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> dates, values = model.get_subsidence_hydrograph(1)
>>> dates
array(['1990-10-01', '1990-10-02', '1990-10-03', ..., '2000-09-28',
       '2000-09-29', '2000-09-30'], dtype='datetime64[D]')
>>> values
array([-0.0152, -0.0153, -0.0153, ..., -0.0189, -0.0189, -0.0189])
>>> model.kill()
>>> model.close_log_file()