Model.system#

Model.system(entity_type, axisname='', axisnode=0, axisx=0.0, axisy=0.0, axisz=0.0, nodeCollection=Collection(), planename='', originnode=0, originx=0.0, originy=0.0, originz=0.0, planenode=0, planex=0.0, planey=0.0, planez=0.0, system=0, type='')#

Creates and updates a coordinate system.

Parameters:

  • entity_type (EntityFullType) – The class of input entity. Must be set to nodes.

  • axisname (hwString) – The name of the axis to define. This is required. Valid values are x-axis, y-axis, and z-axis.

  • axisnode (int) – The axis node ID. This is required if coordinate values axisx, axisy and axisz are not given.

  • axisx (double) – The axis x coordinate value. This is required if axisnode is not given.

  • axisy (double) – The axis y coordinate value. This is required if axisnode is not given.

  • axisz (double) – The axis z coordinate value. This is required if axisnode is not given.

  • nodeCollection (Collection) – The collection containing origin nodes at which to create systems. This is required if originx, originy and originz or originnode are not given.

  • planename (hwString) – The name of the plane to define. This is required. Valid values are xy-plane and xz-plane.

  • originnode (int) – The origin node ID. This is required if originx, originy and originz or originnode are not given.

  • originx (double) – The origin x coordinate value. This is required if originnode and nodeCollection are not given.

  • originy (double) – The origin y coordinate value. This is required if originnode and nodeCollection are not given.

  • originz (double) – The origin z coordinate value. This is required if originnode and nodeCollection are not given.

  • planenode (int) – The plane node ID. This is required if planex, planey and planez are not given.

  • planex (double) – The plane x direction coordinate value. This is required if planenode is not given.

  • planey (double) – The plane y direction coordinate value. This is required if planenode is not given.

  • planez (double) – The plane z direction coordinate value. This is required if planenode is not given.

  • system (int) – The ID of the system to be edited.

  • type (int) –

    The type of system to create. This is required. Valid values are:

    0 - Rectangular

    1 - Cylindrical

    2 - Spherical

Example#

Create a new rectangular system#
import hm
import hm.entities as ent

model = hm.Model()

model.system(
    entity_type=ent.Node,
    type=0,
    originx=0.01,
    originy=0.2,
    originz=0.3,
    axisname="z-axis",
    axisx=0.3,
    axisy=0.4,
    axisz=0.2,
    planename="xz-plane",
    planex=0.4,
    planey=0.6,
    planez=0.7
)
Update system ID 10#
import hm
import hm.entities as ent

model = hm.Model()

model.system(
    entity_type=ent.Node,
    system=10,
    type=0,
    originx=0.01,
    originy=0.2,
    originz=0.3,
)
On this page