Model.hm_fbdplot

Model.hm_fbdplot(plot_type, collection, subcase_ids, resultid, absolute=0, arrlen=25, arroworigin=0, colorfx=255, colorfy=65280, colorfz=16711680, colorfxy=0, colorfyz=0, colorfxz=0, colorfxyz=0, colormx=255, colormy=65280, colormz=16711680, colormxy=0, colormyz=0, colormxz=0, colormxyz=0, createfield=1, createload=1, display=1, displacement=0, declim=2, envelope=0, freenode=0, fx=255, fxy=0, fxyz=0, fxz=0, fy=65280, fyz=0, fz=16711680, gpf=0, midarrow=0, minmax=0, mx=255, mxy=0, mxyz=0, mxz=0, my=65280, myz=0, mz=16711680, normalload=0, onelems=0, onnodes=0, plotdir=0, resfileid=1, resolvein_sys=0, rotation=0, scid=1, scientific=0, showvalue=0, stepid=0, sizescale=0, tangentialLoad=0, tolerance=1e-05, user_sys_id=Entity(), vecstyle=0, intf=0, mpcf=0, sumat=0, sysproj=0, spcf=0, appf=0, color=255, createtable=0, displayat=0, field_name='', interpolate=0, maxval=0.000000, range=1, report_tablename='', resultant=0, summf=0)

Creates FBD panel or bar plots. The plots can be cleared using Model.hm_fbdplot_clear().

Parameters:

• plot_type (hwString) –

  The type of plot to generate:

  barplot - Create FBD bar plot

  panelplot - Create FBD panel plot

• collection (Collection) – The collection containing the input panels or freebodysections.

• subcase_ids (hwTripleIList) – The subcase IDs to consider, as a list with integer triples. Each triple consisting of the result file ID, subcase ID and step ID. Example: subcase_ids=[[1 1 0], [1 2 0], [2 1 0], [2 1 1]].

• resultid (Entity) – The result entity to use. This is a mandatory option.

• absolute (int) –

  0 - Algebraic envelope plot (default)

  1 - Absolute envelope plot

• arrlen (double) – The plot arrow length in percentage (default 75).

• arroworigin (int) –

  For bar plots only:

  0 - Tail of arrow at node (default)

  1 - Tip of arrow at node

• colorfx (unsigned int) – The bar plot Fx force and panel plot normal load arrow color. Valid values are 1-64.

• colorfy (unsigned int) – The bar plot Fy force and panel plot tangential load arrow color. Valid values are 1-64.

• colorfz (unsigned int) – The bar plot Fz force arrow color. Valid values are 1-64.

• colorfxy (unsigned int) – The color of the Fxy arrow. Valid values are 1-64.

• colorfyz (unsigned int) – The color of the Fyz arrow. Valid values are 1-64.

• colorfxz (unsigned int) – The color of the Fxz arrow. Valid values are 1-64.

• colorfxyz (unsigned int) – The color of the Fxyz arrow. Valid values are 1-64.

• colormx (unsigned int) – The bar plot Mx moment arrow color. Valid values are 1-64.

• colormy (unsigned int) – The bar plot My moment arrow color. Valid values are 1-64.

• colormz (unsigned int) – The bar plot Mz moment arrow color. Valid values are 1-64.

• colormxy (unsigned int) – The color of the Mxy arrow. Valid values are 1-64.

• colormyz (unsigned int) – The color of the Myz arrow. Valid values are 1-64.

• colormxz (unsigned int) – The color of the Mxz arrow. Valid values are 1-64.

• colormxyz (unsigned int) – The color of the Mxyz arrow. Valid values are 1-64.

• createfield (int) –

  0 - Do not create a nodal displacement field (default)

  1 - Create a nodal displacement field

• createload (int) –

  0 - Do not create FBD displacement loads (default)

  1 - Create FBD displacement loads

• declim (int) – The decimal number limit (default 2).

• display (int) –

  0 - Do not plot FBD displacements

  1 - Plot FBD displacements (default)

• displacement (int) –

  0 - Applied forces are not participating in the FBD calculation (default)

  1 - Applied forces are participating in the FBD calculation

• envelope (int) –

  0 - No envelope calculation (default)

  1 - Envelope calculation

• freenode (int) –

  0 - Free nodes. Find the nodes which are shared by elements other than the elements contained in the freebodysection.

  1 - Boundary nodes. Find only the boundary nodes of the elements contained in the freebodysection.

  2 - All nodes. Find all nodes of the elements contained in the freebodysection.

• fx (int) –

  Display the Fx forces for bar plots:

  0 - Do not show (default)

  1 - Show

• fxy (int) –

  Display the Fxy forces for bar plots:

  0 - Do not show (default)

  1 - Show

• fxyz (int) –

  Display the Fxyz forces for bar plots:

  0 - Do not show (default)

  1 - Show

• fxz (int) –

  Display the Fxz forces for bar plots:

  0 - Do not show (default)

  1 - Show

• fy (int) –

  Display the Fy forces for bar plots:

  0 - Do not show (default)

  1 - Show

• fyz (int) –

  Display the Fyz forces for bar plots:

  0 - Do not show (default)

  1 - Show

• fz (int) –

  Display the Fz forces for bar plots:

  0 - Do not show (default)

  1 - Show

• intf (int) –

  0 - Internal forces are not participating in the FBD calculation (default)

  1 - Internal forces are participating in the FBD calculation

• mpcf (int) –

  0 - MPC forces are not participating in the FBD calculation (default)

  1 - MPC forces are participating in the FBD calculation

• spcf (int) –

  0 - SPC forces are not participating in the FBD calculation (default)

  1 - SPC forces are participating in the FBD calculation

• appf (int) –

  0 - Applied forces are not participating in the FBD calculation (default)

  1 - Applied forces are participating in the FBD calculation

• gpf (int) –

  For panel plots only:

  0 - Element forces (default)

  1 - Grid-point forces

• midarrow (int) –

  For panel plots only:

  0 - Do not show mid arrow (default)

  1 - Show mid arrow

• minmax (int) –

  0 - Min envelope plot (default)

  1 - Max envelope plot

• mx (int) –

  Display the Mx moments for bar plots:

  0 - Do not show (default)

  1 - Show

• mxy (int) –

  Display the Mxy moments for bar plots:

  0 - Do not show (default)

  1 - Show

• mxyz (int) –

  Display the Mxyz moments for bar plots:

  0 - Do not show (default)

  1 - Show

• mxz (int) –

  Display the Mxz moments for bar plots:

  0 - Do not show (default)

  1 - Show

• my (int) –

  Display the My moments for bar plots:

  0 - Do not show (default)

  1 - Show

• myz (int) –

  Display the Myz moments for bar plots:

  0 - Do not show (default)

  1 - Show

• mz (int) –

  Display the Mz moments for bar plots:

  0 - Do not show (default)

  1 - Show

• normalload (int) –

  0 - Do not show normal load (default)

  1 - Show normal load

• onelems (int) –

  For bar plots only:

  0 - Do not plot on element centroids (default)

  1 - Plot on element centroids

• onnodes (int) –

  For bar plots only:

  0 - Do not plot on element nodes (default)

  1 - Plot on element nodes

• plotdir (int) –

  For bar plots only and normalload=1, the plot direction of the normal load:

  0 - Auto (default)

  1 - Global x axis

  2 - Global -x axis

  3 - Global y axis

  4 - Global -y axis

  5 - Global z axis

  6 - Global -z axis

• resfileid (int) – The result file ID for resultid. Useful when multiple result files are loaded for a single result entity.

• resultant (int) –

  0 - Free body force/moment plot.

  1 - Resultant force/moment plot.

• scid (int) – The results subcase ID for result entity specified by resultid.

• scientific (int) –

  0 - Fixed format text (default)

  1 - Scientific format text

• showvalue (int) –

  0 - Show value text

  1 - Hide value text (default)

• sizescale (int) –

  For bar plots only:

  0 - Constant scaling of arrow length (default)

  1 - Magnitude scaling of arrow length

• stepid (int) – The step/simulation ID for results subcase specified by scid.

• sumat (int) – Reserved for future development.

• sysproj (int) – Reserved for future development.

• tangentialLoad (int) –

  For panel plots only:

  0 - Do not show tangential load (default)

  1 - Show tangential load

• tolerance (double) – The tolerance to limit the values for the plot creation (default 0.00001).

• user_sys_id (Entity) – The object describing the system entity.

• vecstyle (int) –

  For bar plots only:

  0 - 3D style arrow (default)

  1 - 2D style arrow

• range (int) – Reserved for future development.

• report_tablename (hwString) – Reserved for future development.

• rotation (int) – Reserved for future development.

• resolvein_sys (int) – Reserved for future development.

• color (int) – Reserved for future development.

• createtable (int) – Reserved for future development.

• displayat (int) – Reserved for future development.

• field_name (hwString) – Reserved for future development.

• interpolate (int) – Reserved for future development.

• maxval (double) – Reserved for future development.

• midarrow – Reserved for future development.

• summf (int) – Reserved for future development.

• tangentialLoad – Reserved for future development.

Returns:

• hwReturnStatus - Status object

Example

Create a panel plot for panels ID 1, 2, and 3

import hm
import hm.entities as ent

model = hm.Model()

panels = hm.Collection(model, ent.Panel, [1, 2, 3])

model.hm_fbdplot(
    plot_type="panelplot",
    collection=panels,
    subcase_ids=[[1 1 0], [1 2 0], [2 1 0], [2 1 1]],
    resultid=ent.Result(model, 1),
    scientific=False,
    gpf=0,
    arrlen=75,
    declim=2,
    showvalue=True,
    midarrow=0,
    tangentialload=True,
    normalload=True,
    envelope=False,
    absolute=1,
    minmax=1,
    colorfx=3,
    colorfy=4,
)