GetDamper

GetDamper

Syntax

SapObject.SapModel.PropLink.GetDamper

VB6 Procedure

Function GetDamper(ByVal Name As String, ByRef DOF() As Boolean, ByRef Fixed() As Boolean, ByRef NonLinear() As Boolean, ByRef Ke() As Double, ByRef Ce() As Double, ByRef k() As Double, ByRef c() As Double, ByRef cexp() As Double, ByRef dj2 As Double, ByRef dj3 As Double, ByRef Notes As String, ByRef GUID As String) As Long

Parameters

Name

The name of an existing exponential damper-type link property.

DOF

This is a boolean array, dimensioned to 5, indicating if properties exist for a specified degree of freedom.

DOF(0) = U1

DOF(1) = U2

DOF(2) = U3

DOF(3) = R1

DOF(4) = R2

DOF(5) = R3

Fixed

This is a boolean array, dimensioned to 5, indicating if the specified degree of freedom is fixed (restrained).

Fixed(0) = U1 fixity

Fixed(1) = U2 fixity

Fixed(2) = U3 fixity

Fixed(3) = R1 fixity

Fixed(4) = R2 fixity

Fixed(5) = R3 fixity

The term Fixed(n) applies only when DOF(n) = True.

NonLinear

This is a boolean array, dimensioned to 5, indicating if nonlinear properties exist for a specified degree of freedom.

NonLinear(0) = U1 has nonlinear properties

NonLinear(1) = U2 has nonlinear properties

NonLinear(2) = U3 has nonlinear properties

NonLinear(3) = R1 has nonlinear properties

NonLinear(4) = R2 has nonlinear properties

NonLinear(5) = R3 has nonlinear properties

The term NonLinear(n) applies only when DOF(n) = True and Fixed(n) = False.

Ke

This is an array of effective stiffness terms for the link property. The effective stiffness applies for linear analyses.

Ke(0) = U1 [F/L]

Ke(1) = U2 [F/L]

Ke(2) = U3 [F/L]

Ke(3) = R1 [FL]

Ke(4) = R2 [FL]

Ke(5) = R3 [FL]

The term Ke(n) applies only when DOF(n) = True and Fixed(n) = False.

Ce

This is an array of effective damping terms for the link property. The effective damping applies for linear analyses.

Ce(0) = U1 [F/L]

Ce(1) = U2 [F/L]

Ce(2) = U3 [F/L]

Ce(3) = R1 [FL]

Ce(4) = R2 [FL]

Ce(5) = R3 [FL]

The term Ce(n) applies only when DOF(n) = True and Fixed(n) = False.

k

This is an array of initial stiffness terms for the link property. The initial stiffness applies for nonlinear analyses.

k(0) = U1 [F/L]

k(1) = U2 [F/L]

k(2) = U3 [F/L]

k(3) = R1 [FL]

k(4) = R2 [FL]

k(5) = R3 [FL]

The term k(n) applies only when DOF(n) = True, Fixed(n) = False and NonLinear(n) = True.

c

This is an array of nonlinear damping coefficient terms for the link property. The nonlinear damping coefficient applies for nonlinear analyses.

c(0) = U1 [F/(L^cexp)]

c(1) = U2 [F/(L^cexp)]

c(2) = U3 [F/(L^cexp)]

c(3) = R1 [FL]

c(4) = R2 [FL]

c(5) = R3 [FL]

The term c(n) applies only when DOF(n) = True, Fixed(n) = False and NonLinear(n) = True.

cexp

This is an array of the nonlinear damping exponent terms. The nonlinear damping exponent applies for nonlinear analyses. It is applied to the velocity across the damper in the equation of motion.

cexp(0) = U1

cexp(1) = U2

cexp(2) = U3

cexp(3) = R1

cexp(4) = R2

cexp(5) = R3

The term cexp(n) applies only when DOF(n) = True, Fixed(n) = False and NonLinear(n) = True.

dj2

The distance from the J-End of the link to the U2 shear spring. This item applies only when DOF(1) = True. [L]

dj3

The distance from the J-End of the link to the U3 shear spring. This item applies only when DOF(2) = True. [L]

Notes

The notes, if any, assigned to the property.

GUID

The GUID (global unique identifier), if any, assigned to the property.

Remarks

This function retrieves link property data for an exponential damper-type link property.

The function returns zero if the property data is successfully retrieved; otherwise it returns a nonzero value.

VBA Example

Sub GetLinkPropDamper()

 'dimension variables

 Dim SapObject as cOAPI

 Dim SapModel As cSapModel

 Dim ret As Long

 Dim MyDOF() As Boolean

 Dim MyFixed() As Boolean

 Dim MyNonLinear() As Boolean

 Dim MyKe() As Double

 Dim MyCe() As Double

 Dim MyK() As Double

 Dim MyC() As Double

 Dim MyCexp() As Double

 Dim DOF() As Boolean

 Dim Fixed() As Boolean

 Dim Nonlinear() As Boolean

 Dim Ke() As Double

 Dim Ce() As Double

 Dim k() As Double

 Dim c() As Double

 Dim cexp() As Double

 Dim dj2 As Double

 Dim dj3 As Double

 Dim Notes As String

 Dim GUID As String

'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

 'create model from template

 ret = SapModel.File.New2DFrame(PortalFrame, 2, 144, 2, 288)

 'add link property

 ReDim MyDOF(5)

 ReDim MyFixed(5)

 ReDim MyNonLinear(5)

 ReDim MyKe(5)

 ReDim MyCe(5)

 ReDim MyK(5)

 ReDim MyC(5)

 ReDim MyCexp(5)

 MyDOF(0) = True

 MyKe(0) = 12

 MyCe(0) = 0.01

 MyDOF(1) = True

 MyNonLinear(1) = True

 MyKe(1) = 12

 MyCe(1) = 0.01

 MyK(1) = 20

 MyC(1)=0.08

 MyCexp(1) = 1.2

 MyDOF(2) = True

 MyFixed(2) = True

 ret = SapModel.PropLink.SetDamper("D1", MyDOF, MyFixed, MyNonLinear,

MyKe, MyCe, MyK, MyC, MyCexp, 1, 0)

'get link property data

ret = SapModel.PropLink.GetDamper ("D1", DOF, Fixed, NonLinear, Ke, Ce, k, c, cexp, dj2, dj3, Notes, GUID)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 11.02.

Clarification that damper type is exponential added in version 16.0.2.

See Also

SetDamper