Model.createfbdreport

Model.createfbdreport(report_type, collection, subcase_ids, resultid, envelope=0, gpf=0, tolerance=1e-05, arrlen=25.000000, 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, declim=2, display=1, displacement=0, freenode=0, fx=0, fxy=0, fxyz=0, fxz=0, fy=0, fyz=0, fz=0, mx=0, mxy=0, mxyz=0, mxz=0, my=0, myz=0, mz=0, resfileid=1, resolvein_sys=0, rotation=0, scid=1, scientific=0, showvalue=0, sizescale=0, stepid=0, user_sys_id=hwDescriptor::Entity(), vecstyle=0, intf=0, mpcf=0, sumat=0, sysproj=0, spcf=0, appf=0, absolute=0, color=1, createtable=0, displayat=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 a report for FBD panel and FBD bar from panel and freebodysection entities respectively. This queries the raw grid-point and element force data from result entities multiple subcases of the elements and nodes contained under the panel/freebodysection entities. It is then formalized and calculated with respect to local or elemental system to get the final FBD force values. A table is then created which contains the detailed panel/freebodysection entities, subcase details and FBD force values.

Parameters:

• report_type (hwString) – The type of report to generate. Valid values are “panel” and “bar”.

• collection (Collection) – The collection containing the entities to report. If report_type="panel" the there must be a panel entities in the collection. If report-type="bar, then there must be freebodysection entities.

• subcase_ids (hwTripleIList) – The subcase IDs to consider, as a comma separated string with each substring consisting of the result file ID, subcase ID and step ID. For example: {1_1_0,1_2_0, 2_1_0, 2_1_1}.

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

• envelope (int) –

  0 - No envelope calculation (default)

  1 - Envelope calculation

• gpf (int) –

  For panel reports only:

  0 - Element forces (default)

  1 - Grid-point forces

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

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

• arroworigin (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 (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

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

  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

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

• resolvein_sys (int) – Reserved for future development.

• rotation (int) – Reserved for future development.

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

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

• vecstyle (int) – Reserved for future development.

• 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

• sumat (int) – Reserved for future development.

• sysproj (int) – Reserved for future development.

• 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

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

• minmax (int) –

  0 - Create FBD summary table (default)

  1 - Create FBD min/max table

• 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

• range (int) – Reserved for future development.

• report_tablename (hwString) – Reserved for future development.

• resultant (int) –

  0 - Free body force/moment plot.

  1 - Resultant force/moment plot.

• summf (int) – Reserved for future development.

• tangentialLoad (int) – Reserved for future development.

Example

Create an FBD panel report with element forces

import hm
import hm.entities as ent

model = hm.Model()

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

model.createfbdreport(
    report_type="panel",
    collection=panels,
    subcase_ids={1_1_0, 1_2_0, 2_1_0, 2_1_1},
    resultid=ent.Result(model,1),
)

Create an FBD panel report with grid - point forces

import hm
import hm.entities as ent

model = hm.Model()

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

model.createfbdreport(
    report_type="panel",
    collection=panels,
    subcase_ids={1_1_0, 1_2_0, 2_1_0, 2_1_1},
    resultid=ent.Result(model,1),
    gpf=1,
)

Create an FBD panel report with envelope

import hm
import hm.entities as ent

model = hm.Model()

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

model.createfbdreport(
    report_type="panel",
    collection=panels,
    subcase_ids={1_1_0, 1_2_0, 2_1_0, 2_1_1},
    resultid=ent.Result(model,1),
    gpf=1,
    envelope=1,
)

Create an FBD bar report

import hm
import hm.entities as ent

model = hm.Model()

freebodysections = hm.Collection(model, ent.Freebodysection, [1, 2, 3])

model.createfbdreport(
    report_type="bar",
    collection=freebodysections,
    subcase_ids={1_1_0, 1_2_0, 2_1_0, 2_1_1},
    resultid=ent.Result(model,1),
)

Create an FBD bar report

import hm
import hm.entities as ent

model = hm.Model()

freebodysections = hm.Collection(model, ent.Freebodysection, [1, 2, 3])

model.createfbdreport(
    report_type="bar",
    collection=freebodysections,
    subcase_ids={1_1_0, 1_2_0, 2_1_0, 2_1_1}
    resultid=ent.Result(model,1),
    envelope=1,
)