Model.createfbdsummarytable#

Model.createfbdsummarytable(freebodysection_ids, subcase_ids, arrlen=25.0, arroworigin=0, colorfx=225, 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, declim=2, display=1, displacement=0, freenode=0, fx=255, fxy=0, fxyz=0, fxz=0, fy=65280, fyz=0, fz=16711680, mx=255, mxy=0, mxyz=0, mxz=0, my=65280, myz=0, mz=16711680, resfileid=1, resolvein_sys=0, resultid=Entity(), rotation=0, scid=1, scientific=0, showvalue=0, sizescale=0, stepid=0, tolerance=0.00001, user_sys_id=Entity(), vecstyle=0, gpf=0, intf=0, mpcf=0, sumat=0, sysproj=0, spcf=0, appf=0, absolute=0, color=255, createtable=0, displayat=0, envelope=0, field_name='', interpolate=0, maxval=0.000000, midarrow=0, minmax=0, normalload=0, onelems=0, onnodes=0, plotdir=0, range=1, report_tablename='', resultant=0, summf=0, tangentialLoad=0)#

Creates an FBD summary table or min/max table. This queries the GPF, Applied, SPC and MPC data from the result entity on a freebodysection.

Parameters:
  • freebodysection_ids (EntityList) – The list of freebodysection entities.

  • subcase_ids (hwTripleIList) – The subcase info as an array. Values are specified as [<resultfile_id>,<subcase_id>,<step_id>], with each list separated by a comma. For example: [[1,1,0],[1,2,0],[2,1,0],[2,1,1]].

  • arrlen (double) – The length of the string array that contains the additional input parameters.

  • 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.

  • resultid (Entity) – The object describing the result entity.

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

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

  • 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) –

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

    1 - Grid-point forces are participating in the FBD calculation

  • minmax (int) –

    0 - Create FBD summary table (default)

    1 - Create FBD min/max table

  • scientific (int) –

    0 - Fixed format text (default)

    1 - Scientific format text

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

  • showvalue (int) –

    0 - Show text (default).

    1 - Hide text.

  • sizescale (int) –

    0 - Constant FBD plot arrow length (default)

    1 - Magnitude FBD plot arrow length

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

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

  • arroworigin (int) –

    0 - Tail of arrow at node for the plot (default)

    1 - Tip of arrow at node for the plot

  • fx (int) –

    0 - Fx translations are not included in the plot, load or field creation (default)

    1 - Fx translations are included in the plot, load or field creation

  • fxy (int) –

    0 - Fxy resultant translations are not included in the plot (default)

    1 - Fxy resultant translations are included in the plot

  • fxyz (int) –

    0 - Fxyz resultant translations are not included in the plot (default)

    1 - Fxyz resultant translations are included in the plot

  • fxz (int) –

    0 - Fxz resultant translations are not included in the plot (default)

    1 - Fxz resultant translations are included in the plot

  • fy (int) –

    0 - Fy translations are not included in the plot, load or field creation (default)

    1 - Fy translations are included in the plot, load or field creation

  • fyz (int) –

    0 - Fyz resultant translations are not included in the plot (default)

    1 - Fyz resultant translations are included in the plot

  • fz (int) –

    0 - Fz translations are not included in the plot, load or field creation (default)

    1 - Fz translations are included in the plot, load or field creation

  • mx (int) –

    0 - Mx rotations are not included in the plot, load or field creation (default)

    1 - Mx rotations are included in the plot, load or field creation

  • mxy (int) –

    0 - Mxy resultant rotations are not included in the plot (default)

    1 - Mxy resultant rotations are included in the plot

  • mxyz (int) –

    0 - Mxyz resultant rotations are not included in the plot (default)

    1 - Mxyz resultant rotations are included in the plot

  • mxz (int) –

    0 - Mxz resultant rotations are not included in the plot (default)

    1 - Mxz resultant rotations are included in the plot

  • my (int) –

    0 - My rotations are not included in the plot, load or field creation (default)

    1 - My rotations are included in the plot, load or field creation

  • myz (int) –

    0 - Myz resultant rotations are not included in the plot (default)

    1 - Myz resultant rotations are included in the plot

  • mz (int) –

    0 - Mz rotations are not included in the plot, load or field creation (default)

    1 - Mz rotations are included in the plot, load or field creation

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

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

  • colorfz (unsigned int) – The color of the Fz arrow. 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 color of the Mx arrow. Valid values are 1-64.

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

  • colormz (unsigned int) – The color of the Mz arrow. 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) – Controls the decimal limit. Default is 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

  • resultant (int) –

    0 - Free body force/moment plot.

    1 - Resultant force/moment plot.

  • sumat (int) – Reserved for future development.

  • sysproj (int) – Reserved for future development.

  • vecstyle (int) – Reserved for future development.

  • rotation (int) – Reserved for future development.

  • resolvein_sys (int) – Reserved for future development.

  • absolute (int) – Reserved for future development.

  • color (int) – Reserved for future development.

  • createtable (int) – Reserved for future development.

  • displayat (int) – Reserved for future development.

  • envelope (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 (int) – Reserved for future development.

  • normalload (int) – Reserved for future development.

  • onelems (int) – Reserved for future development.

  • onnodes (int) – Reserved for future development.

  • plotdir (int) – Reserved for future development.

  • range (int) – Reserved for future development.

  • report_tablename (hwString) – Reserved for future development.

  • summf (int) – Reserved for future development.

  • tangentialLoad (int) – Reserved for future development.

Examples#

Create an FBD summary table#
import hm
import hm.entities as ent

model = hm.Model()

model.createfbdsummarytable(
    freebodysection_ids=[
        ent.Freebodysection(model, 1),
        ent.Freebodysection(model, 2),
        ent.Freebodysection(model, 3),
    ],
    subcase_ids=[[1, 1, 0], [1, 2, 0], [2, 1, 0], [2, 1, 1]],
    arrlen=9,
    tolerance=0.00001,
    resultid=ent.Result(model,1),
    gpf=1,
    appf=1,
    spcf=1,
    intf=1,
    mpcf=1,
    freenode=0,
    minmax=0,
)
Create an FBD min/max table#
import hm
import hm.entities as ent

model = hm.Model()

model.createfbdsummarytable(
    freebodysection_ids=[
        ent.Freebodysection(model, 1),
        ent.Freebodysection(model, 2),
        ent.Freebodysection(model, 3),
    ],
    subcase_ids=[[1, 1, 0], [1, 2, 0], [2, 1, 0], [2, 1, 1]],
    arrlen=9,
    tolerance=0.00001,
    resultid=ent.Result(model,1),
    gpf=1,
    appf=1,
    spcf=1,
    intf=1,
    mpcf=1,
    freenode=0,
    minmax=1,
)