pywfm.IWFMModel._get_location_ids

IWFMModel._get_location_ids(location_type_id)

private method returning the location identification numbers used by the model for a specified location type

Parameters:

location_type_id (int) – identification number used by IWFM for a particular location type e.g elements, nodes, subregions, etc.

Returns:

array of identification numbers

Return type:

np.ndarray

Note

This is a generic version to get the number of locations. Many location types already have a dedicated procedure for doing this