Get frame section modifiers as a structured object. Args: model: SAP2000 SapModel object frame_name: Frame object name

Get frame section modifiers as a tuple. Args: model: SAP2000 SapModel object frame_name: Frame object name Retu

Infer the release preset from the current frame release state. Args: model: `SapModel` object frame_name: Frame name

Get the assigned section property name of a frame. Args: model: SAP2000 SapModel object frame_name: Frame object name

Get section assignment details for a frame, including auto-select data. Args: model: SAP2000 SapModel object frame_name:

Get nonprismatic section assignment data for a frame. Wraps the `FrameObj.GetSectionNonPrismatic` API. This is only valid when the frame

Return the frame transformation matrix. The matrix is a 3x3 matrix (9 values) used to transform between local and global coordinates.

Create a hinge object from an existing frame assignment.

Get the number of functions. Args: model: SAP2000 SapModel object func_type: Function type, or `None` for all types

Get the list of function names. Args: model: SAP2000 SapModel object func_type: Function type, or `None` for all types

Get parameters for a GB 50011-2010 response-spectrum function. Args: model: SAP2000 SapModel object name: Function name

Get parameters for a file-based response-spectrum function. Args: model: SAP2000 SapModel object name: Function name

Get user-defined response-spectrum data. Args: model: SAP2000 SapModel object name: Function name Returns:

Get cosine time-history function parameters. Args: model: SAP2000 SapModel object name: Function name Retur

Get parameters for a file-based time-history function. Args: model: SAP2000 SapModel object name: Function name

Get ramp time-history function parameters. Args: model: SAP2000 SapModel object name: Function name Returns

Get sawtooth time-history function parameters. Args: model: SAP2000 SapModel object name: Function name Ret

Get sine time-history function parameters. Args: model: SAP2000 SapModel object name: Function name Returns

Get triangular time-history function parameters. Args: model: SAP2000 SapModel object name: Function name R

Get user-defined time-history function data. Args: model: SAP2000 SapModel object name: Function name Retur

Get user-defined periodic time-history function data. Args: model: SAP2000 SapModel object name: Function name

Get the type of a function. Args: model: SAP2000 SapModel object name: Function name Returns: `Func

Get function values. Args: model: SAP2000 SapModel object name: Function name Returns: Tuple `(x_va

Get generalized displacement results. Args: model: SAP2000 SapModel object name: Generalized displacement name

Get currently selected generalized displacements. Args: model: SapModel object Returns:

Return the groups assigned to the point. Returns: List of group names

Get group assignments

Get groups containing this area object

Return the point GUID. Returns: GUID string, or `None` on failure

Get area-object GUID

Get inner contour points (for boolean operations)

Get joint acceleration results. Args: model: SAP2000 SapModel object name: Point object name, point element name, or gro

Get absolute joint acceleration results, typically for multi-support excitation. Args: model: SAP2000 SapModel object na

Get joint displacement results. Args: model: SAP2000 SapModel object name: Point object name, point element name, or gro

Get absolute joint displacement results, typically for multi-support excitation. Args: model: SAP2000 SapModel object na

Get joint reaction results. Reactions come from restraints, springs, and grounded link elements. Args: model: SAP2000 SapMo

Get joint response spectrum results. Args: model: SAP2000 SapModel object name: Point object name, point element name, o

Get currently selected joint-response-spectrum named sets. Args: model: SapModel object Returns

Get joint velocity results. Args: model: SAP2000 SapModel object name: Point object name, point element name, or group n

Get absolute joint velocity results, typically for multi-support excitation. Args: model: SAP2000 SapModel object name:

Get a line constraint definition. Args: name: Constraint name Returns: Tuple `(dof_values, csys)`, or `None

Get deformation results for link elements. Args: model: SAP2000 SapModel object name: Link object name, link element nam

Get internal force results for link elements. Args: model: SAP2000 SapModel object name: Link object name, link element

Get joint force results for link elements. Args: model: SAP2000 SapModel object name: Link object name, link element nam

Get link object deformation load. Args: model: SapModel object link_name: Link object name item_type: Operation scop

Get link object gravity load. Args: model: SapModel object link_name: Link object name item_type: Operation scope

Get link object target-force load. Args: model: SapModel object link_name: Link object name item_type: Operation sco

Get the local-axis rotation angle of a link object. Args: model: SAP2000 SapModel object link_name: Link object name

Get advanced local-axis settings for a link object. Args: model: SAP2000 SapModel object link_name: Link object name

Return both standard and frequency-dependent property information. Args: model: `SapModel` object link_name: Link object

Get the transformation matrix of a link object. Returns a 3x3 matrix with 9 values for converting between local and global coordinates.

Get all links in the group

Get currently selected load cases. Args: model: SapModel object Returns: (load_case

Get currently selected load combinations. Args: model: SapModel object Returns: (lo

Get area gravity loads

Get currently selected load patterns. Args: model: SapModel object Returns: (load_p

Get area pore-pressure loads

Get area rotation loads

Get area strain loads

Get area surface-pressure loads

Get area temperature loads

Get area uniform loads

Get area uniform loads transferred to frame.

Get area wind-pressure loads

Get a local constraint definition. Args: name: Constraint name Returns: Boolean list `[U1, U2, U3, R1, R2,

Get advanced local-axis settings API: GetLocalAxesAdvanced(Name, Active, AxVectOpt, AxCSys, AxDir[], AxPt[], AxVect[],

Get advanced area local-axis settings Returns: AreaLocalAxesAdvanced object, or `None` on failure

Get added area mass

Get area material temperature

Get area material override

Get the maximum and minimum displacement in a given direction. Args: load_case: Load case name load_

Get the maximum cable force.

Get modal load participation ratios. Returns static and dynamic participation ratios for each load pattern. Args: model: SA

Get modal participating mass ratios. Returns participating mass ratios and cumulative ratios for each mode. Args: model: SA

Get modal participation factors. Returns participation factors, modal mass, and modal stiffness for each mode. Args: model:

Get modal period results. Returns period, frequency, and eigenvalue data for all selected modal cases. Args: model: SAP2000

Get the modal subtype. Only valid when `case_type == MODAL`. Returns: `ModalSubType` or `None`.

Get mode shape results. Args: model: SAP2000 SapModel object name: Point object name, point element name, or group name

Get the model file name (no path). API: GetModelFilename() -> String

Return the active model directory path. Returns: Directory containing the model file Raises

Get the full model file path. API: GetModelFilepath() -> String

Get area modifiers.

Get property modifiers.

Get obsolete table-key mapping. Returns a mapping from obsolete keys to replacement keys. Args:

Get area offsets

Get the buckling mode result option. Args: model: SAP2000 SapModel object Returns: Buckling mode number (1-

Get the direct-integration time-history result option. Args: model: SAP2000 SapModel object Returns: Option

Get the modal time-history result option. Args: model: SAP2000 SapModel object Returns: Option value:

Get the mode-shape result option. Args: model: SAP2000 SapModel object Returns: Tuple `(mode_num, run_case_

Get the multi-step static result option. Args: model: SAP2000 SapModel object Returns: Option value:

Get the multi-valued combination result option. Args: model: SAP2000 SapModel object Returns: Option value:

Get the nonlinear static result option. Args: model: SAP2000 SapModel object Returns: Option value:

Get the power spectral density result option. Args: model: SAP2000 SapModel object Returns: Option value:

Get the steady-state result option. Args: model: SAP2000 SapModel object Returns: Option value: `1`

Get panel zone deformation results. Args: model: SAP2000 SapModel object name: Element name or group name item_t

Get panel zone force results. Args: model: SAP2000 SapModel object name: Element name or group name item_type: E

Get a plate constraint definition. Args: name: Constraint name Returns: Tuple `(axis, csys)`, or `None` if

Get currently selected plot-function-trace named sets. Args: model: SapModel object Returns:

Return point local-axis angles. Args: model: `SapModel` object point_name: Point name Returns: Angle tu

Return advanced local-axis settings for a point. Args: model: `SapModel` object point_name: Point name Returns: