pywfm.IWFMModel.get_subregion_names#

IWFMModel.get_subregion_names()#

Return the subregions names specified in an IWFM model

Returns:: list of names for each subregion in the model
Return type:: list

See also

IWFMModel.get_subregion_name: Return the name corresponding to the subregion_id in an IWFM model
IWFMModel.get_n_subregions: Return the number of subregions in an IWFM model
IWFMModel.get_subregion_ids: Return an array of IDs for subregions in an IWFM model

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_names()
['Region1 (SR1)', 'Region2 (SR2)']
>>> model.kill()
>>> model.close_log_file()