pywfm.IWFMModel.get_lake_ids#

IWFMModel.get_lake_ids()#

Return an array of lake IDs in an IWFM model

Returns:: array of lake identification numbers for each lake in the model
Return type:: np.ndarray

See also

IWFMModel.get_n_lakes: Return the number of lakes in an IWFM model
IWFMModel.get_n_elements_in_lake: Return the number of finite element grid cells that make up a lake
IWFMModel.get_elements_in_lake: Return the element ids with the specified lake ID

Example

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> model.get_lake_ids()
array([1])
>>> model.kill()
>>> model.close_log_file()