LinkDeformation

LinkDeformation

Syntax

SapObject.SapModel.Results.LinkDeformation

VB6 Procedure

Function LinkDeformation(ByVal Name As String, ByVal ItemTypeElm As eItemTypeElm, ByRef NumberResults As Long, ByRef Obj() As String, ByRef Elm() As String, ByRef LoadCase() As String, ByRef StepType() As String, ByRef StepNum() As Double, ByRef U1() As Double, ByRef U2() As Double, ByRef U3() As Double, ByRef R1() As Double, ByRef R2() As Double, ByRef R3() As Double) As Long

Parameters

Name

The name of an existing link object, link element, or group of objects, depending on the value of the ItemTypeElm item.

ItemTypeElm

This is one of the following items in the eItemTypeElm enumeration:

ObjectElm = 0

Element = 1

GroupElm= = 2

SelectionElm = 3

If this item is ObjectElm, the result request is for the link element corresponding to the link object specified by the Name item.

If this item is Element, the result request is for the link element specified by the Name item.

If this item is GroupElm, the result request is for all link elements directly or indirectly specified in the group specified by the Name item.

If this item is SelectionElm, the result request is for link elements directly or indirectly selected, and the Name item is ignored.

For GroupElm and SelectionElm a link element may be indirectly specified through point objects that have panel zone assignments and through line, area, and solid objects that have spring assignments.

NumberResults

The total number of results returned by the program.

Obj

This is an array that includes the link object name associated with each result, if any.

Elm

This is an array that includes the link element name associated with each result.

LoadCase

This is an array that includes the name of the analysis case or load combination associated with each result.

StepType

This is an array that includes the step type, if any, for each result. See 
Analysis Results Step Type
.

StepNum

This is an array that includes the step number, if any, for each result.See 
Analysis Results Step Number
.

U1, U2, U3

These are one dimensional arrays that include the internal translational deformation of the link in the link element local axes directions. [L]

R1, R2, R3

These are one dimensional arrays that include the internal rotational deformation of the link about the link element local axes. [rad]

Remarks

This function reports the link internal deformations.

The function returns zero if the deformations are successfully recovered, otherwise it returns a nonzero value.

See 
Analysis Results Remarks
 for more information.

VBA Example

Sub GetLinkDeformations()

 'dimension variables

 Dim SapObject as cOAPI

 Dim SapModel As cSapModel

 Dim ret As Long

 Dim NumberResults As Long

 Dim Obj() As String

 Dim Elm() As String

 Dim LoadCase() As String

 Dim StepType() As String

 Dim StepNum() As Double

 Dim U1() As Double

 Dim U2() As Double

 Dim U3() As Double

 Dim R1() As Double

 Dim R2() As Double

 Dim R3() As Double

 'create Sap2000 object

 Set SapObject = CreateObject("CSI.SAP2000.API.SapObject")

 'start Sap2000 application

 SapObject.ApplicationStart

 'create SapModel object

 Set SapModel = SapObject.SapModel

 'initialize model

 ret = SapModel.InitializeNewModel

 'open existing model

 ret = SapModel.File.OpenFile("C:\SapAPI\Example 6-003a.sdb")

 'run analysis

 ret = SapModel.Analyze.RunAnalysis

 'clear all case and combo output selections

 ret = SapModel.Results.Setup.DeselectAllCasesAndCombosForOutput

 'set case and combo output selections

 ret = SapModel.Results.Setup.SetCaseSelectedForOutput("NLMHIST1")

 'set modal history output option to step-by-step

 ret = SapModel.Results.Setup.SetOptionModalHist(2)

 'get link deformations for link object "1"

 ret = SapModel.Results.LinkDeformation("1", ObjectElm, NumberResults, Obj, Elm, LoadCase, StepType, StepNum, U1, U2, U3, R1, R2, R3)

 'close Sap2000

 SapObject.ApplicationExit False

 Set SapModel = Nothing

 Set SapObject = Nothing

 End Sub

Release Notes

Initial release in version 11.00.

Changed nomenclature from Load Cases, Analysis Cases and Response Combinations to Load Patterns, Load Cases and Load Combinations, respectively, in version 12.00.

See Also

LinkForce

LinkJointForce