pywfm.IWFMModel.get_n_subregions#

IWFMModel.get_n_subregions()#

Return the number of subregions in an IWFM model

Returns:: number of subregions in the IWFM model
Return type:: int

See also

IWFMModel.get_subregion_ids: Return an array of IDs for subregions in an IWFM model
IWFMModel.get_subregion_name: Return the name corresponding to the subregion_id 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_n_subregions()
2
>>> model.kill()
>>> model.close_log_file()