pywfm.IWFMModel.get_subregion_name#

IWFMModel.get_subregion_name(subregion_id)#

Return the name corresponding to the subregion_id in an IWFM model

Parameters:: subregion_id (int) – subregion identification number used to return name
Returns:: name of the subregion
Return type:: str

See also

IWFMModel.get_n_subregions: Return the number of subregions in an IWFM model
IWFMModel.get_subregion_ids: Return an array of IDs for subregions identified in an IWFM model
IWFMModel.get_subregions_by_element: Return an array identifying the IWFM Model elements contained within each subregion.

Example

>>> from pywfm import IWFMModel
>>> pp_file = '../Preprocessor/PreProcessor_MAIN.IN'
>>> sim_file = 'Simulation_MAIN.IN'
>>> model = IWFMModel(pp_file, sim_file)
>>> model.get_subregion_name(1)
'Region1 (SR1)'
>>> model.kill()
>>> model.close_log_file()