Model.hm_visualizeloads

Model.hm_visualizeloads(entities, config, plottype, showlabel=0, locationentitytype=EntityFullType())

Plots engineering loads referenced by a load collector honoring the scale factor defined in the collector.

Parameters:

• entities (Collection) – The collection containing the load entities.

• config (int) – The config of the load to be reviewed.

• plottype (int) –

  The requested plot type. A validation is performed for the referred loads to ensure they are valid for the specified plot type.

  0 - Clear all graphics

  1 - Vector plot

  2 - Interactive scalar plot

  3 - Static scalar plot

• showlabel (int) –

  The labels for the vector plot. The display of labels is also dependent on the global load handle flag.

  0 - Off

  1 - On

• locationentitytype (EntityFullType) – The entity type where the load is applied. If specified, only the loads which are applied on the specified entity type will be reviewed. Valid values are nodes and elements.

Returns:

• hwReturnStatus - Status object

Examples

Create a vector plot of force loads in all load collectors with labels

import hm
import hm.entities as ent

model = hm.Model()

all_loadcols = hm.Collection(model, ent.Loadcol)

model.hm_visualizeloads(
    entities=all_loadcols,
    config=1,
    plottype=1,
    showlabel=1,
    locationentitytype=ent.Node
)

Create a scalar plot of temperature loads referenced by load collectors with IDs 1 - 10 applied on nodes

import hm
import hm.entities as ent

model = hm.Model()

loadcols = hm.Collection(model, ent.Loadcol, list(range(1,11)))

model.hm_visualizeloads(
    entities=loadcols,
    config=1,
    plottype=5,
    showlabel=0,
    locationentitytype=ent.Node
)

Create all graphics

import hm
import hm.entities as ent

model = hm.Model()

all_loadcols = hm.Collection(model, ent.Loadcol)

model.hm_visualizeloads(
    entities=all_loadcols,
    config=1,
    plottype=0
)