pywfm.IWFMModel.get_n_elements_in_lake#

IWFMModel.get_n_elements_in_lake(lake_id)#

Return the number of finite element grid cells that make up a lake

Parameters:: lake_id (int) – lake identification number used to obtain number of elements contained in the lake
Returns:: number of elements representing the lake with the provided id number
Return type:: int

See also

IWFMModel.get_n_lakes: Return the number of lakes in an IWFM model
IWFMModel.get_lake_ids: Return an array of the lake IDs in an IWFM model
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_n_elements_in_lake()
10
>>> model.kill()
>>> model.close_log_file()