Model.hm_plotloads_byentity

Model.hm_plotloads_byentity(entity, dataname, plottype)

Plots engineering loads with various options, by providing an entity.

Parameters:

• entity (Entity) – The load entity to query.

• dataname (hwString) – The data name of the load entity to plot. The dataname="magnitude" is a special data name where even if magnitude is not explicitly available, it is computed on-the-fly.

• plottype (int) –

  The requested plot type. A validation is performed for the selected loads to ensure they are valid for the specified plot type (e.g. a vector plot is not valid for temperature, but is for pressure). Valid values are:

  0 - Clear all graphics (default if not specified)

  1 - Vector plot

  2 - Interactive scalar plot

  3 - Static scalar plot

Example

Create a scalar plot of temperature load with ID 5

import hm
import hm.entities as ent

model = hm.Model()

temp_entity = ent.LoadTemperature(model, 5)

model.hm_plotloads_byentity(
    entity=temp_entity, dataname="magnitude", plottype=2
)