Model.freebodysectionforce#

Model.freebodysectionforce(freebodysection_ids, appf=0, arrlen=75.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=0, createload=0, declim=2, display=1, freenode=0, fx=3, fxy=1, fxyz=6, fxz=7, fy=4, fyz=2, fz=5, gpf=0, intf=0, mpcf=0, mx=3, mxy=1, mxyz=6, mxz=7, my=4, myz=2, mz=5, resFileID=INT_MAX, resolvein_sys=0, resultant=0, resultID=Entity(), scid=0, scientific=0, showvalue=0, sizescale=0, spcf=0, stepid=0, tolerance=0.0001, userSysID=Entity(), vecstyle=0)#

Creates an FBD force plot and fields or loads from the results for a freebodysection entity with config=3 (FBD Plot). This queries the GPF, Applied, SPC and MPC data from the result entity on a freebodysection.

Parameters:

  • freebodysection_ids (EntityList) – A list containing the freebodysection entity objects.

  • appf (unsigned int) –

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

    1 - Applied forces do participate in the FBD calculation.

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

  • arroworigin (unsigned int) –

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

    1 - Tip of arrow at node for the plot.

  • 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 (unsigned int) –

    0 - Do not create a nodal force and moment field (default).

    1 - Create a nodal force and moment field.

  • createload (unsigned int) –

    0 - Do not create FBD force and moment loads (default).

    1 - Create FBD force and moment loads.

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

  • display (unsigned int) –

    0 - Do not plot FBD forces.

    1 - Plot FBD forces (default).

  • freenode (unsigned int) –

    0 - Free nodes. Find the nodes shared by elements other than the elements in the freebodysection (default).

    2 - All nodes. Considers all nodes of the elements in the freebodysection.

  • fx (unsigned int) –

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

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

  • fxy (unsigned int) –

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

    1 - Fxy resultant forces are included in the plot.

  • fxyz (unsigned int) –

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

    1 - Fxyz resultant forces are included in the plot.

  • fxz (unsigned int) –

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

    1 - Fxz resultant forces are included in the plot.

  • fy (unsigned int) –

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

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

  • fyz (unsigned int) –

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

    1 - Fyz resultant forces are included in the plot.

  • fz (unsigned int) –

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

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

  • gpf (unsigned int) –

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

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

  • intf (unsigned int) –

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

    1 - Internal forces do participate in the FBD calculation.

  • mpcf (unsigned int) –

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

    1 - MPC forces do participate in the FBD calculation.

  • mx (unsigned int) –

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

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

  • mxy (unsigned int) –

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

    1 - Mxy resultant moments are included in the plot.

  • mxyz (unsigned int) –

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

    1 - Mxyz resultant moments are included in the plot.

  • mxz (unsigned int) –

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

    1 - Mxz resultant moments are included in the plot.

  • my (unsigned int) –

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

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

  • myz (unsigned int) –

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

    1 - Myz resultant moments are included in the plot.

  • mz (unsigned int) –

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

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

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

  • resolvein_sys (unsigned int) –

    1 - Resolve in global system.

    2 - Resolve in user system.

    3- freebody section system.

  • resultant (unsigned int) –

    0 - Free body force/moment plot.

    1 - Resultant force/moment plot.

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

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

  • scientific (unsigned int) –

    0 - Fixed format text (default).

    1 - Scientific format text.

  • showvalue (unsigned int) –

    0 - Show text (default).

    1 - Hide text.

  • sizescale (unsigned int) –

    0 - Constant FBD plot arrow length (default).

    1 - Magnitude FBD plot arrow length.

  • spcf (unsigned int) –

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

    1 - SPC forces do participate in the FBD calculation.

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

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

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

  • vecstyle (unsigned int) –

    0 - 3D FBD plot arrow (default).

    1 - 2D FBD plot arrow.

Example#

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

model = hm.Model()

model.freebodysectionforce(
freebodysection_ids=[ent.Freebodysection(model, i) for i in range(1, 4)],
appf=0,
arrlen=75.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=0,
createload=0,
declim=3,
display=1,
freenode=2,
fx=1,
fxy=0,
fxyz=0,
fxz=70,
fy=1,
fyz=0,
fz=1,
gpf=1,
intf=0,
mpcf=0,
mx=0,
mxy=0,
mxyz=0,
mxz=0,
my=0,
myz=0,
mz=0,
resFileID=2,
resolvein_sys=0,
resultant=0,
resultID=ent.Result(model, 1),
scid=1,
scientific=0,
showvalue=1,
sizescale=0,
spcf=0,
stepid=0,
tolerance=0.0001,
userSysID=ent.System(model, 1),
vecstyle=0,
)