Model.renumbersolveridall#

Model.renumbersolveridall(start_id, incr_val, offset_val, offset_flag, reserved_1, reserved_2, reserved_3)#

Renumbers the solver IDs for all entities in the model.

Works in two ways. If the entity has solver IDs, the function will renumber the solver IDs and not the internal IDs. However, if the entity does not have solver IDs, the function will renumber the internal IDs (see Model.renumberall()).

Parameters:

  • start_id (unsigned int) – Integer value > 0 specifying the starting value.

  • incr_val (unsigned int) – Integer value > 0 specifying the renumbering increment.

  • offset_val (int) – Integer value to use for offsetting. Can be positive or negative as long as after renumbering all entities will have a positive ID.

  • offset_flag (int) –

    Flag to specify whether to use offsetting.

    0 - Use start_id and incr_val and ignore offset_val.

    1 - Use offset_val and ignore start_id and incr_val.

  • reserved_1 (int) – Reserved for future development. Value = 0

  • reserved_2 (int) – Reserved for future development. Value = 0

  • reserved_3 (double) – Reserved for future development. Value = 0.0.

Example#

Renumbere the solver IDs of all entities start from ID 100 with an increment of 1#
import hm
import hm.entities as ent

model = hm.Model()

model.renumbersolveridall(
    start_id=100,
    incr_val=1,
    offset_val=0,
    offset_flag=0,
    reserved_1=0,
    reserved_2=0,
    reserved_3=0.0,
)