Model.fbdtraceplot#

Model.fbdtraceplot(freebodygroup, arrLen=25.0, arrowOrigin=0, colorfx=3, colorfy=4, colorfz=5, colorfxy=1, colorfyz=2, colorfxz=7, colorfxyz=6, colormx=3, colormy=4, colormz=5, colormxy=1, colormyz=2, colormxz=7, colormxyz=6, createField=1, createLoad=1, decLim=2, display=1, displacement=0, freenode=2, fx=3, fxy=1, fxyz=6, fxz=7, fy=4, fyz=2, fz=5, mx=3, mxy=1, mxyz=6, mxz=7, my=4, myz=2, mz=5, resFileID=INT_MAX, resolveInSys=0, resultID=Entity(), rotation=0, scID=0, scientific=0, showValue=0, sizeScale=0, stepID=0, tolerance=0.001000, userSysID=Entity(), vecStyle=0, gpf=0, intf=0, mpcf=0, sumAt=0, sysProj=0, spcf=0, appf=0, absolute=0, color=3, createTable=0, displayAt=0, envelope=0, fieldName='', interpolate=0, maxVal=0.0, midArrow=0, minMax=0, normalLoad=0, oneLems=0, onNodes=0, plotDir=0, range=0, reportTablename='', resultant=0, summf=0, tangentialLoad=0)#

Creates an FBD trace plot.

This queries the GPF, Applied, SPC and MPC data from the result entity on a freebodysection.

Parameters:

  • freebodygroup (Entity) – The freebodygroup entity ID.

  • arrLen (double) – Controls the FBD plot arrow length. Default is 75 (%).

  • arrowOrigin (int) – Reserved for future use. Must be set to 0.

  • colorfx (int) – Reserved for future use. Must be set to 0.

  • colorfy (int) – Reserved for future use. Must be set to 0.

  • colorfz (int) – Reserved for future use. Must be set to 0.

  • colorfxy (int) – Reserved for future use. Must be set to 0.

  • colorfyz (int) – Reserved for future use. Must be set to 0.

  • colorfxz (int) – Reserved for future use. Must be set to 0.

  • colorfxyz (int) – Reserved for future use. Must be set to 0.

  • colormx (int) – Reserved for future use. Must be set to 0.

  • colormy (int) – Reserved for future use. Must be set to 0.

  • colormz (int) – Reserved for future use. Must be set to 0.

  • colormxy (int) – Reserved for future use. Must be set to 0.

  • colormyz (int) – Reserved for future use. Must be set to 0.

  • colormxz (int) – Reserved for future use. Must be set to 0.

  • colormxyz (int) – Reserved for future use. Must be set to 0.

  • createField (int) – Reserved for future use. Must be set to 0.

  • createLoad (int) – Reserved for future use. Must be set to 0.

  • decLim (int) – Controls the decimal limit. Default is 2.

  • display (int) –

    0 - Allong the cutting nodes (default)

    1 - Along the centroid of each freebodysection

  • displacement (int) – Reserved for future use. Must be set to 0.

  • freenode (int) – Reserved for future use. Must be set to 0.

  • fx (int) –

    0 - Do not display Fx forces (default)

    1 - Display Fx forces

  • fxy (int) – Reserved for future use. Must be set to 0.

  • fxyz (int) – Reserved for future use. Must be set to 0.

  • fxz (int) – Reserved for future use. Must be set to 0.

  • fy (int) –

    0 - Do not display Fy forces (default)

    1 - Display Fy forces

  • fyz (int) – Reserved for future use. Must be set to 0.

  • fz (int) –

    0 - Do not display Fz forces (default)

    1 - Display Fz forces

  • mx (int) –

    0 - Do not display Mx moments (default)

    1 - Display Mx moments

  • mxy (int) – Reserved for future use. Must be set to 0.

  • mxyz (int) – Reserved for future use. Must be set to 0.

  • mxz (int) – Reserved for future use. Must be set to 0.

  • my (int) –

    0 - Do not display My moments (default)

    1 - Display My moments

  • myz (int) – Reserved for future use. Must be set to 0.

  • mz (int) –

    0 - Do not display Mz moments (default)

    1 - Display Mz moments

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

  • resolveInSys (int) – Reserved for future use. Must be set to 0.

  • resultID (Entity) – The object describing the entity.

  • rotation (int) – Reserved for future use. Must be set to 0.

  • scID (int) – The results subcase ID for resultid.

  • scientific (int) –

    0 - Fixed format text (default)

    1 - Scientific format text

  • showValue (int) –

    0 - Show text (default)

    1 - Hide text

  • sizeScale (int) – Reserved for future use. Must be set to 0.

  • stepID (int) – The step/simulation ID for scid.

  • tolerance (double) – The tolerance to limit the values. Default is 0.00001.

  • userSysID (Entity) – The object describing the entity.

  • vecStyle (int) – Reserved for future use. Must be set to 0.

  • gpf (int) –

    0 - Grid-point forces do not participate in the FBD calculation (default)

    1 - Grid-point forces do participate in the FBD calculation

  • intf (int) –

    0 - Internal forces do not participate in the FBD calculation (default)

    1 - Internal forces do participate in the FBD calculation

  • mpcf (int) –

    0 - MPC forces do not participate in the FBD calculation (default)

    1 - MPC forces do participate in the FBD calculation

  • sumAt (int) –

    0 - Along cutting nodes (default)

    1 - Along the centroid of each freebodysection

  • sysProj (int) –

    0 - Do not project the system along the plot (default)

    1 - Project the system along the plot

  • spcf (int) –

    0 - SPC forces do not participate in the FBD calculation (default)

    1 - SPC forces do participate in the FBD calculation

  • appf (int) –

    0 - Applied forces do not participate in the FBD calculation (default)

    1 - Applied forces do participate in the FBD calculation

  • absolute (int) – Reserved for future use. Must be set to 0.

  • color (int) – Reserved for future use. Must be set to 0.

  • createTable (int) – Reserved for future use. Must be set to 0.

  • displayAt (int) – Reserved for future use. Must be set to 0.

  • envelope (int) – Reserved for future use. Must be set to 0.

  • fieldName (hwString) – Reserved for future use. Must be set to 0.

  • interpolate (int) – Reserved for future use. Must be set to 0.

  • maxVal (double) – Reserved for future use. Must be set to 0.

  • midArrow (int) – Reserved for future use. Must be set to 0.

  • minMax (int) – Reserved for future use. Must be set to 0.

  • normalLoad (int) – Reserved for future use. Must be set to 0.

  • oneLems (int) – Reserved for future use. Must be set to 0.

  • onNodes (int) – Reserved for future use. Must be set to 0.

  • plotDir (int) –

    0 - Auto. The direction axis is automatically determined on the basis of values (default)

    1 - Global x-direction

    2 - Global x-direction negative

    3 - Global y-direction

    4 - Global y-direction negative

    5 - Global z-direction

    6 - Global z-direction negative

  • range (int) – Reserved for future use. Must be set to 0.

  • reportTablename (hwString) – Reserved for future use. Must be set to 0.

  • resultant (int) – Reserved for future use. Must be set to 0.

  • summf (int) – Reserved for future use. Must be set to 0.

  • tangentialLoad (int) – Reserved for future use. Must be set to 0.

Example#

Create an FBD trace plot#
import hm
import hm.entities as ent

model = hm.Model()

model.fbdtraceplot(
      freebodygroup=24,
      arrLen=75.0,
      decLim=2,
      freenode=2,
      fx=3,
      fxy=1,
      fxyz=6,
      fxz=7,
      fy=4,
      fyz=2,
      fz=5,
      mx=3,
      mxy=1,
      mxyz=6,
      mxz=7,
      my=4,
      myz=2,
      mz=5,
      resFileID=1,
      resultID=ent.Result(model, 1),
      scID=0,
      scientific=0,
      tolerance=0.00001,
      gpf=1,
      intf=1,
      mpcf=1,
      sumAt=0,
      sysProj=0,
      spcf=1,
      appf=1,
      displayAt=0,
      plotDir=0,
)
On this page