pywfm.IWFMModel.get_gwheads_foralayer#

IWFMModel.get_gwheads_foralayer(layer_number, begin_date=None, end_date=None, length_conversion_factor=1.0)#

Return the simulated groundwater heads for a single user-specified model layer for every model node over a user-specified time interval.

Parameters:

layer_number (int) – layer number for a layer in the model
begin_date (str, default=None) – IWFM-style date for the beginning date of the simulated groundwater heads
end_date (str, default=None) – IWFM-style date for the end date of the simulated groundwater heads
length_conversion_factor (float, int, default=1.0) – simulated heads are multiplied by this value to convert simulation units to desired output units

Returns:

1-D array of dates 2-D array of heads for all nodes for each date

Return type:

np.arrays

Note

the interval between the begin_date and the end_date is determined from the model time interval using get_time_specs()

See also

IWFMModel.get_gwheads_all: Return the groundwater heads at all nodes in every aquifer layer for the current simulation time step

Example

>>> model = IWFMModel(dll, preprocessor_file, simulation_file)
>>> dates, heads = model.get_gwheadsall_foralayer(1, '09/30/1980_24:00', '09/30/2000_24:00')
>>> dates
    ['09/30/1980',
     '10/31/1980',
     '11/30/1980',
     '12/31/1980',
     .
     .
     .
     '09/30/2000']
>>> heads
    [[458.57, 460.32, 457.86, ..., 686.42],
     [459.86, 462.38, 459.11, ..., 689.05],
     .
     .
     .
     [435.75, 439.23, 440.99, ..., 650.78]]