pywfm.IWFMModel.get_stratigraphy_atXYcoordinate#

IWFMModel.get_stratigraphy_atXYcoordinate(x, y, fact=1.0, output_options=1)#

Return the stratigraphy at given X,Y coordinates

Parameters:

x (int, float) – x-coordinate for spatial location
y (int, float) – y-coordinate for spatial location
fact (int, float, default=1.0) – conversion factor for x,y coordinates to model length units
output_options (int, string, default=1) – selects how output is returned by the function {1 or ‘combined’, 2 or ‘gse’, 3 or ‘tops’, 4 or ‘bottoms’}

Returns:

np.ndarray (if output_options == 1 or ‘combined’,) – array contains ground surface elevation and the bottoms of all layers
float (if output_options == 2 or ‘gse’,) – ground surface elevation at x,y coordinates
np.ndarray (if output_options == 3 or ‘tops’:) – array containing the top elevations of each model layer
np.ndarray (if output_options == 4 or ‘bottoms’:) – array containing the bottom elevations of each model layer
tuple (length 3, if output_options is some other integer or string not defined above,) – ground surface elevation at x,y coordinates, numpy array of top elevation of each layer, numpy array of bottom elevation of each layer

Note

All return values will be zero if the coordinates provided do not fall within a model element

If model units are in feet and x,y coordinates are provided in meters, then FACT=3.2808

See also

IWFMModel.get_ground_surface_elevation: Return the ground surface elevation for each node specified in the IWFM model
IWFMModel.get_aquifer_top_elevation: Return the aquifer top elevations for each finite element node and each layer
IWFMModel.get_aquifer_bottom_elevation: Return the aquifer bottom elevations for each finite element node and each layer

Examples

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> model.get_stratigraphy_atXYcoordinate(590000.0, 4440000.0, 3.2808, 5)
(500.0, array([500.,   0.]), array([   0., -100.]))
>>> model.kill()
>>> model.close_log_file()

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> model.get_stratigraphy_atXYcoordinate(590000.0, 4440000.0, 3.2808, 1)
array([ 500.,    0., -100.])
>>> model.kill()
>>> model.close_log_file()

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> model.get_stratigraphy_atXYcoordinate(590000.0, 4440000.0, 3.2808, ''gse')
500.0
>>> model.kill()
>>> model.close_log_file()