Skip to content

Result Table

Fetches result tables like reactions, displacements, forces, and stresses for given elements and load cases from MIDAS CIVIL NX.

Result.TABLE

Result.TABLE(tabletype, keys=[], loadcase=[], cs_stage=[], options=None)

General method to extract any type of result table from MIDAS CIVIL NX.

Parameters

  • tabletype (str): Analysis Results Table type.
Result Table Table Type
Reaction (Global) REACTIONG
Reaction (Local) REACTIONL
Displacement (Global) DISPLACEMENTG
Displacement (Local) DISPLACEMENTL
Truss Force TRUSSFORCE
Truss Stress TRUSSSTRESS
Beam Force BEAMFORCE
Beam Stress BEAMSTRESS

Details of all available tables can be found here.

  • keys (list[int] or str): Optional. Element or Node IDs (Default: All) | list[int] → IDs or str → Group Name.

  • loadcase (list[str]): Optional. Load case names (Default: All). Example: ["Dead Load(ST)", "Live Load(ST)"].

  • cs_stage (list or 'all'): Optional. Construction stages. Default: [].

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A high-performance DataFrame containing the result table.

Polars is a high-performance DataFrame library designed to provide fast and efficient data processing capabilities. Polars DataFrames support exporting tabular data as CSV and Excel sheets.

Write Excel: https://docs.pola.rs/api/python/dev/reference/api/polars.DataFrame.write_excel.html

Example Usage

1. Printing Result Table

# Reaction table for all nodes and load cases
rkn_res = Result.TABLE('REACTIONG')
print(rkn_res)

# Output
# shape: (36, 9)
# +-------+------+------------+-----------+-------+-----------+---------+---------+---------+
# | Index | Node |   Load     |    FX     |  ...  |    FZ     |   MX    |   MY    |   MZ    |
# +-------+------+------------+-----------+-------+-----------+---------+---------+---------+
# |   1   |   1  | Dead Load  |  338.647  |  ...  |  3273.412 |  0.000  |  0.000  |  0.000  |
# |   2   |  11  | Dead Load  |    0.000  |  ...  |  3687.690 |  0.000  |  0.000  |  0.000  |
# |   3   |  21  | Dead Load  | -338.647  |  ...  |  1463.059 |  0.000  |  0.000  |  0.000  |
# |  ...  | ...  |    ...     |    ...    |  ...  |    ...    |   ...   |   ...   |   ...   |
# +-------+------+------------+-----------+-------+-----------+---------+---------+---------+

2. Result Table for Displacement

Result.TABLE('DISPLACEMENTG',loadcase='UDL(ST)')

3. Multiple Result Tables to Excel

sheetloaction = 'D:\\ResultTest.xlsx'

sheetA = TableOptions('KN','M','Fixed',ExcelFileLoc=sheetloaction,ExcelSheetName='Displacement')
sheetB = TableOptions('KN','M','Fixed',ExcelFileLoc=sheetloaction,ExcelSheetName='Reaction')

Result.TABLE('DISPLACEMENTG',loadcase='UDL(ST)',options=sheetA)

sheetB.EXCEL_CELL_POS = "B5"
Result.TABLE.Reaction(options=sheetB)
sheetB.EXCEL_CELL_POS = "end"
Result.TABLE('REACTIONG',loadcase='UVL(ST)',options=sheetB)

TableOptions

TableOptions(force_unit=None, len_unit=None, num_format=None, decimal_place=None, JSONFileLoc=None, ExcelFileLoc=None, ExcelSheetName=None, ExcelCellPos=None)

Configuration class for customizing result table output formatting and export options.

Parameters

  • force_unit (str): Force unit. Options: KN, N, KGF, TONF, LBF, KIPS. Default: KN.

  • len_unit (str): Length unit. Options: M, CM, MM, FT, IN. Default: M.

  • num_format (str): Number format. Options: Fixed, Scientific, General. Default: Fixed.

  • decimal_place (int): Number of decimal places for result output (0-15). Default: 5.

  • JSONFileLoc (str): Optional. File path to save the raw JSON response.

  • ExcelFileLoc (str): Optional. File path to save or update the result table as an Excel file.

  • ExcelSheetName (str): Optional. Sheet name for Excel output. If not provided, a default name is generated.

  • ExcelCellPos (str): Optional. Starting cell position for writing to Excel (e.g., "A1"). Use "end" to append to the end of the sheet. Default: "end".

Example Usage

# Create custom table options
options = TableOptions(
    force_unit='KN',
    len_unit='M',
    num_format='Fixed',
    decimal_place=3,
    ExcelFileLoc='D:\\results.xlsx',
    ExcelSheetName='Reactions',
    ExcelCellPos='A1'
)

# Use options with Result.Table
reaction_df = Result.Table('REACTIONG', loadcase=['Dead Load(ST)'], options=options)

Result.TABLE Methods

The Result.TABLE class provides specialized methods to fetch various types of result tables from MIDAS CIVIL NX, including reactions, displacements, forces, and stresses for different element types.

Reaction

Fetches Reaction result tables (Global, Local, or Surface Spring).

Result.TABLE.Reaction(keys=[], loadcase=[], components=['all'], cs_stage=[], type="Global", options=None)

Parameters

  • keys (list[int] or str): Optional. List of Node IDs or a Structure Group Name. Default: All nodes.

  • loadcase (list[str]): Optional. List of load case names. Example: ["DL(ST)", "LL(ST)"]. Default: All load cases.

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • type (str): Reaction type. Options: Global, Local, SurfaceSpring. Default: Global.

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the reaction result table.

Example Usage

# Get global reactions for specific nodes
reaction_df = Result.TABLE.Reaction(
    keys=[1, 2, 3, 10],
    loadcase=["Dead Load(ST)", "Live Load(ST)"],
    type="Global"
)
print(reaction_df)

# Export reaction table to Excel with custom options
options = TableOptions(ExcelFileLoc="reactions.xlsx", ExcelSheetName="Reactions")
Result.TABLE.Reaction(loadcase=["DL(ST)", "LL(ST)"], options=options)

Displacement

Fetches Displacement result tables (Global or Local).

Result.TABLE.Displacement(keys=[], loadcase=[], components=['all'], cs_stage=[], type="Global", displacement_type="Accumulative", options=None)

Parameters

  • keys (list[int] or str): Optional. List of Node IDs or a Structure Group Name. Default: All nodes.

  • loadcase (list[str]): Optional. List of load case names. Example: ["Self(ST)", "Wind(ST)"]. Default: All load cases.

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • type (str): Displacement type. Options: Global, Local. Default: Global.

  • displacement_type (str): Displacement option. Options: Accumulative, Current, Real. Default: Accumulative.

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the displacement result table.

Example Usage

# Get global displacements with accumulative type
disp_df = Result.TABLE.Displacement(
    keys=[5, 6, 7],
    loadcase=["Self(ST)", "Wind(ST)"],
    displacement_type="Accumulative",
    type="Global"
)
print(disp_df)

# Export displacements for construction stages
options = TableOptions(ExcelFileLoc="displacements_cs.xlsx")
Result.TABLE.Displacement(
    cs_stage='all',
    options=options
)

TrussForce

Fetches Truss Force result tables.

Result.TABLE.TrussForce(keys=[], loadcase=[], components=['all'], cs_stage=[], options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["DL(ST)", "LL(ST)"]. Default: All load cases.

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the truss force result table.

Example Usage

# Get truss forces for specific elements
truss_df = Result.TABLE.TrussForce(
    keys=[1, 2, 3],
    loadcase=["DL(ST)", "LL(ST)"]
)
print(truss_df)

TrussStress

Fetches Truss Stress result tables.

Result.TABLE.TrussStress(keys=[], loadcase=[], components=['all'], cs_stage=[], options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["DL(ST)", "LL(ST)"]. Default: All load cases.

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the truss stress result table.

Example Usage

# Get truss stresses with custom units
options = TableOptions(force_unit='N', len_unit='MM')
stress_df = Result.TABLE.TrussStress(
    keys=[1, 2, 3],
    loadcase=["DL(ST)"],
    options=options
)
print(stress_df)

BeamForce

Fetches standard Beam Force result tables.

Result.TABLE.BeamForce(keys=[], loadcase=[], parts=["PartI", "PartJ"], components=['all'], cs_stage=[], options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["Selfweight(ST)"]. Default: All load cases.

  • parts (list[str]): Element parts: ["PartI", "Part1/4", "PartJ"], etc. Default: ["PartI", "PartJ"].

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the beam force result table.

Example Usage

# Get beam forces at specific parts
beam_df = Result.TABLE.BeamForce(
    keys=[10, 20, 30],
    loadcase=["Selfweight(ST)", "Dead Load(ST)"],
    parts=["PartI", "Part1/4", "PartJ"]
)
print(beam_df)

BeamForce_VBM

Fetches Beam Force (View by Max Value) result tables.

Result.TABLE.BeamForce_VBM(keys=[], loadcase=[], items=['all'], parts=["PartI", "PartJ"], components=['all'], cs_stage=[], options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["STLENV_STR(CB:max)"]. Default: All load cases.

  • items (list[str]): Items to display: ["Axial", "Shear-y", "Moment-z"], etc. Default: ['all'].

  • parts (list[str]): Element parts: ["PartI", "Part1/4", "PartJ"], etc. Default: ["PartI", "PartJ"].

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the beam force (view by max) result table.

Example Usage

# Get maximum beam forces
beam_max_df = Result.TABLE.BeamForce_VBM(
    loadcase=["STLENV_STR(CB:max)"],
    items=["Axial", "Shear-y", "Moment-z"]
)
print(beam_max_df)

BeamForce_StaticPrestress

Fetches Beam Force (Static Prestress) result tables.

Note: Construction Stage options are not applicable to this table type.

Result.TABLE.BeamForce_StaticPrestress(keys=[], loadcase=[], parts=["PartI", "PartJ"], components=['all'], options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["Prestress(ST)"]. Default: All load cases.

  • parts (list[str]): Element parts: ["PartI", "PartJ"], etc. Default: ["PartI", "PartJ"].

  • components (list[str]): Table components to include. Default: ['all'].

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the beam force (static prestress) result table.

Example Usage

# Get prestress beam forces
prestress_df = Result.TABLE.BeamForce_StaticPrestress(
    loadcase=["Prestress(ST)"],
    parts=["PartI", "PartJ"]
)
print(prestress_df)

BeamStress

Fetches standard Beam Stress result tables.

Result.TABLE.BeamStress(keys=[], loadcase=[], parts=["PartI", "PartJ"], components=['all'], cs_stage=[], options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["Selfweight(ST)"]. Default: All load cases.

  • parts (list[str]): Element parts: ["PartI", "PartJ"], etc. Default: ["PartI", "PartJ"].

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the beam stress result table.

Example Usage

# Get beam stresses
stress_df = Result.TABLE.BeamStress(
    keys=[10, 20],
    loadcase=["Selfweight(ST)", "Live Load(ST)"]
)
print(stress_df)

BeamStress_VBM

Fetches Beam Stress (View by Max Value) result tables.

Result.TABLE.BeamStress_VBM(keys=[], loadcase=[], items=['all'], parts=["PartI", "PartJ"], components=['all'], cs_stage=[], options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["STLENV_SER(CB:max)"]. Default: All load cases.

  • items (list[str]): Items to display: ["Axial", "Shear-y", "Bend(+y)"], etc. Default: ['all'].

  • parts (list[str]): Element parts: ["PartI", "PartJ"], etc. Default: ["PartI", "PartJ"].

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the beam stress (view by max) result table.

Example Usage

# Get maximum beam stresses
stress_max_df = Result.TABLE.BeamStress_VBM(
    loadcase=["STLENV_SER(CB:max)"],
    items=["Axial", "Bend(+y)", "Bend(-y)"]
)
print(stress_max_df)

BeamStress_7DOF

Fetches Beam Stress (7th DOF) result tables.

Result.TABLE.BeamStress_7DOF(keys=[], loadcase=[], parts=["PartI", "PartJ"], section_position=['Max'], components=['all'], cs_stage=[], options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["EccentricLoads(ST)"]. Default: All load cases.

  • parts (list[str]): Element parts: ["PartI", "PartJ"], etc. Default: ["PartI", "PartJ"].

  • section_position (list[str]): Section positions: ["Pos-1", "Pos-4", "Max"], etc. Default: ['Max'].

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the beam stress (7th DOF) result table.

Example Usage

# Get beam stresses with 7th DOF
stress_7dof_df = Result.TABLE.BeamStress_7DOF(
    loadcase=["EccentricLoads(ST)"],
    section_position=["Pos-1", "Max"]
)
print(stress_7dof_df)

BeamStress_PSC

Fetches Beam Stress (PSC) result tables.

Result.TABLE.BeamStress_PSC(keys=[], loadcase=[], parts=["PartI", "PartJ"], section_position=['All'], components=['all'], cs_stage=[], options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["Selfweight(ST)"]. Default: All load cases.

  • parts (list[str]): Element parts: ["PartI", "PartJ"], etc. Default: ["PartI", "PartJ"].

  • section_position (list[str]): Section positions: ["Pos-1", "Pos-10", "Max", "Min", "All"]. Default: ['All'].

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the beam stress (PSC) result table.

Example Usage

# Get PSC beam stresses
psc_df = Result.TABLE.BeamStress_PSC(
    loadcase=["Selfweight(ST)"],
    section_position=["Max", "Min"]
)
print(psc_df)

BeamStress_7DOF_PSC

Fetches Beam Stress (7th DOF PSC) result tables.

Result.TABLE.BeamStress_7DOF_PSC(keys=[], loadcase=[], parts=["PartI", "PartJ"], section_position=['All'], components=['all'], cs_stage=[], options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["EccentricLoads(ST)"]. Default: All load cases.

  • parts (list[str]): Element parts: ["PartI", "PartJ"], etc. Default: ["PartI", "PartJ"].

  • section_position (list[str]): Section positions: ["Pos-1", "Pos-10", "Max", "Min", "All"]. Default: ['All'].

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the beam stress (7th DOF PSC) result table.

Example Usage

# Get 7DOF PSC beam stresses
psc_7dof_df = Result.TABLE.BeamStress_7DOF_PSC(
    loadcase=["EccentricLoads(ST)"],
    section_position=["All"]
)
print(psc_7dof_df)

BeamStress_Equivalent

Fetches Beam Stress (Equivalent) result tables.

Result.TABLE.BeamStress_Equivalent(keys=[], loadcase=[], parts=["PartI", "PartJ"], section_position=['Maximum'], components=['all'], cs_stage=[], options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["Selfweight(ST)"]. Default: All load cases.

  • parts (list[str]): Element parts: ["PartI", "PartJ"], etc. Default: ["PartI", "PartJ"].

  • section_position (list[str]): Section positions: ["Maximum", "1", "12"], etc. Default: ['Maximum'].

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the beam stress (equivalent) result table.

Example Usage

# Get equivalent beam stresses
equiv_df = Result.TABLE.BeamStress_Equivalent(
    loadcase=["Selfweight(ST)"],
    section_position=["Maximum"]
)
print(equiv_df)

PlateForce

Fetches Plate Force (Local or Global) result tables.

Result.TABLE.PlateForce(keys=[], loadcase=[], components=['all'], cs_stage=[], avg_nodal_result=False, type="Local", options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["DL(ST)"]. Default: All load cases.

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • avg_nodal_result (bool): Option to average nodal results. Default: False.

  • type (str): Plate Force type. Options: Local, Global. Default: Local.

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the plate force result table.

Example Usage

# Get local plate forces
plate_df = Result.TABLE.PlateForce(
    loadcase=["DL(ST)", "LL(ST)"],
    avg_nodal_result=True,
    type="Local"
)
print(plate_df)

PlateForce_UnitLength

Fetches Plate Force (Unit Length) for Local or Global coordinates.

Result.TABLE.PlateForce_UnitLength(keys=[], loadcase=[], components=['all'], cs_stage=[], avg_nodal_result=False, node_flag_center=False, node_flag_nodes=True, type="Local", options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["DL(ST)"]. Default: All load cases.

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • avg_nodal_result (bool): Option to average nodal results. Default: False.

  • node_flag_center (bool): Retrieve results at the center of the plate. Default: False.

  • node_flag_nodes (bool): Retrieve results at the nodes of the plate. Default: True.

  • type (str): Plate Force type. Options: Local, Global. Default: Local.

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the plate force (unit length) result table.

Example Usage

# Get plate forces per unit length
plate_ul_df = Result.TABLE.PlateForce_UnitLength(
    loadcase=["DL(ST)"],
    node_flag_center=True,
    node_flag_nodes=True,
    type="Local"
)
print(plate_ul_df)

PlateForce_UnitLength_VBM

Fetches Plate Force (Unit Length, View by Max Value) for Local or Global coordinates.

Result.TABLE.PlateForce_UnitLength_VBM(keys=[], loadcase=[], items=['all'], components=['all'], cs_stage=[], avg_nodal_result=False, node_flag_center=False, node_flag_nodes=True, type="Local", options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["STLENV_STR(CB:max)"]. Default: All load cases.

  • items (list[str]): Items to display: ["Fxx", "Fyy", "Mxx"], etc. Default: ['all'].

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • avg_nodal_result (bool): Option to average nodal results. Default: False.

  • node_flag_center (bool): Retrieve results at the center of the plate. Default: False.

  • node_flag_nodes (bool): Retrieve results at the nodes of the plate. Default: True.

  • type (str): Plate Force type. Options: Local, Global. Default: Local.

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the plate force (unit length, view by max) result table.

Example Usage

# Get maximum plate forces per unit length
plate_ul_max_df = Result.TABLE.PlateForce_UnitLength_VBM(
    loadcase=["STLENV_STR(CB:max)"],
    items=["Fxx", "Fyy", "Mxx"],
    node_flag_center=True
)
print(plate_ul_max_df)

PlateForce_UnitLength_WA

Fetches Plate Force (Unit Length, W-A Moment) result tables.

Result.TABLE.PlateForce_UnitLength_WA(keys=[], loadcase=[], components=['all'], cs_stage=[], avg_nodal_result=False, node_flag_center=False, node_flag_nodes=True, options=None)

Parameters

  • keys (list[int] or str): Optional. List of Element IDs or a Structure Group Name. Default: All elements.

  • loadcase (list[str]): Optional. List of load case names. Example: ["DL(ST)"]. Default: All load cases.

  • components (list[str]): Table components to include. Default: ['all'].

  • cs_stage (list or 'all'): Optional. Construction Stage options. Default: [].

  • avg_nodal_result (bool): Option to average nodal results. Default: False.

  • node_flag_center (bool): Retrieve results at the center of the plate. Default: False.

  • node_flag_nodes (bool): Retrieve results at the nodes of the plate. Default: True.

  • options (TableOptions): Optional. Table options object for formatting and output settings.

Returns

  • Polars DataFrame: A DataFrame containing the plate force (unit length, W-A moment) result table.

Example Usage

# Get W-A moment plate forces
plate_wa_df = Result.TABLE.PlateForce_UnitLength_WA(
    loadcase=["DL(ST)"],
    node_flag_center=True,
    node_flag_nodes=True
)
print(plate_wa_df)