cPropLinkGetTCFrictionIsolator Method

Retrieves link property data for a T/C friction isolator-type link property.

Namespace: ETABS2016
Assembly: ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)

Syntax

int GetTCFrictionIsolator(
	string Name,
	ref bool[] DOF,
	ref bool[] Fixed,
	ref bool[] Nonlinear,
	ref double[] Ke,
	ref double[] Ce,
	ref double[] K,
	ref double[] Slow,
	ref double[] Fast,
	ref double[] Rate,
	ref double[] Radius,
	ref double[] SlowT,
	ref double[] FastT,
	ref double[] RateT,
	ref double Kt,
	ref double Dis,
	ref double Dist,
	ref double Damping,
	ref double DJ2,
	ref double DJ3,
	ref string Notes,
	ref string GUID
)

Function GetTCFrictionIsolator ( 
	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 Slow As Double(),
	ByRef Fast As Double(),
	ByRef Rate As Double(),
	ByRef Radius As Double(),
	ByRef SlowT As Double(),
	ByRef FastT As Double(),
	ByRef RateT As Double(),
	ByRef Kt As Double,
	ByRef Dis As Double,
	ByRef Dist As Double,
	ByRef Damping As Double,
	ByRef DJ2 As Double,
	ByRef DJ3 As Double,
	ByRef Notes As String,
	ByRef GUID As String
) As Integer

int GetTCFrictionIsolator(
	String^ Name, 
	array<bool>^% DOF, 
	array<bool>^% Fixed, 
	array<bool>^% Nonlinear, 
	array<double>^% Ke, 
	array<double>^% Ce, 
	array<double>^% K, 
	array<double>^% Slow, 
	array<double>^% Fast, 
	array<double>^% Rate, 
	array<double>^% Radius, 
	array<double>^% SlowT, 
	array<double>^% FastT, 
	array<double>^% RateT, 
	double% Kt, 
	double% Dis, 
	double% Dist, 
	double% Damping, 
	double% DJ2, 
	double% DJ3, 
	String^% Notes, 
	String^% GUID
)

abstract GetTCFrictionIsolator : 
        Name : string * 
        DOF : bool[] byref * 
        Fixed : bool[] byref * 
        Nonlinear : bool[] byref * 
        Ke : float[] byref * 
        Ce : float[] byref * 
        K : float[] byref * 
        Slow : float[] byref * 
        Fast : float[] byref * 
        Rate : float[] byref * 
        Radius : float[] byref * 
        SlowT : float[] byref * 
        FastT : float[] byref * 
        RateT : float[] byref * 
        Kt : float byref * 
        Dis : float byref * 
        Dist : float byref * 
        Damping : float byref * 
        DJ2 : float byref * 
        DJ3 : float byref * 
        Notes : string byref * 
        GUID : string byref -> int

Parameters

Name

Type: SystemString
The name of an existing T/C friction isolator-type link property.

DOF

Type: SystemBoolean

Fixed

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

Value	Fixity
Fixed(0)	U1 fixity if DOF(0) = True
Fixed(1)	U2 fixity if DOF(1) = True
Fixed(2)	U3 fixity if DOF(2) = True
Fixed(3)	R1 fixity if DOF(3) = True
Fixed(4)	R2 fixity if DOF(4) = True
Fixed(5)	R3 fixity if DOF(5) = True

Nonlinear

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

Value	Nonlinear
Nonlinear(0)	U1 has nonlinear properties
Nonlinear(1)	U2 has nonlinear properties
Nonlinear(2)	U3 has nonlinear properties
Nonlinear(3)	R1, not used
Nonlinear(4)	R2, not used
Nonlinear(5)	R3, not used

Note that this item is applicable only for degrees of freedom U1, U2 and U3. For those degrees of freedom, the term Nonlinear(n) applies only when DOF(n) = True and Fixed(n) = False.

Ke

Type: SystemDouble

Ce

Type: SystemDouble

K

Type: SystemDouble

Slow

Type: SystemDouble
This is an array of the friction coefficient at zero velocity terms when U1 is in compression for the link property. This coefficient applies for nonlinear analyses.

Value	Slow
Slow(0)	U1, not used
Slow(1)	U2
Slow(2)	U3
Slow(3)	R1, not used
Slow(4)	R2, not used
Slow(5)	R3, not used

Note that this item is applicable only for degrees of freedom U2 and U3. For those degrees of freedom, the term Slow(n) applies only when DOF(n) = True, Fixed(n) = False, and Nonlinear(n) = True.

Fast

Type: SystemDouble
This is an array of the friction coefficient at fast velocity terms when U1 is in compression for the link property. This coefficient applies for nonlinear analyses.

Value	Fast
Fast(0)	U1, not used
Fast(1)	U2
Fast(2)	U3
Fast(3)	R1, not used
Fast(4)	R2, not used
Fast(5)	R3, not used

Note that this item is applicable only for degrees of freedom U2 and U3. For those degrees of freedom, the term Fast(n) applies only when DOF(n) = True, Fixed(n) = False, and Nonlinear(n) = True.

Rate

Type: SystemDouble
This is an array of the inverse of the characteristic sliding velocity terms when U1 is in compression for the link property. This item applies for nonlinear analyses.

Value	Rate
Rate(0)	U1, not used
Rate(1)	U2 [s/L]
Rate(2)	U3 [s/L]
Rate(3)	R1, not used
Rate(4)	R2, not used
Rate(5)	R3, not used

Note that this item is applicable only for degrees of freedom U2 and U3. For those degrees of freedom, the term Fast(n) applies only when DOF(n) = True, Fixed(n) = False, and Nonlinear(n) = True.

Radius

Type: SystemDouble
This is an array of the radius of the sliding contact surface terms for the link property. Inputting 0 means there is an infinite radius, that is, the slider is flat. This item applies for nonlinear analyses.

Value	Radius
Radius(0)	U1, not used
Radius(1)	U2 [L]
Radius(2)	U3 [L]
Radius(3)	R1, not used
Radius(4)	R2, not used
Radius(5)	R3, not used

Note that this item is applicable only for degrees of freedom U2 and U3. For those degrees of freedom, the term Fast(n) applies only when DOF(n) = True, Fixed(n) = False, and Nonlinear(n) = True.

SlowT

Type: SystemDouble
This is an array of the friction coefficient at zero velocity terms when U1 is in tesion for the link property. This coefficient applies for nonlinear analyses.

Value	Slow
SlowT(0)	U1, not used
SlowT(1)	U2
SlowT(2)	U3
SlowT(3)	R1, not used
SlowT(4)	R2, not used
SlowT(5)	R3, not used

Note that this item is applicable only for degrees of freedom U2 and U3. For those degrees of freedom, the term SlowT(n) applies only when DOF(n) = True, Fixed(n) = False, and Nonlinear(n) = True.

FastT

Type: SystemDouble
This is an array of the friction coefficient at fast velocity terms when U1 is in tesion for the link property. This coefficient applies for nonlinear analyses.

Value	Fast
FastT(0)	U1, not used
FastT(1)	U2
FastT(2)	U3
FastT(3)	R1, not used
FastT(4)	R2, not used
FastT(5)	R3, not used

Note that this item is applicable only for degrees of freedom U2 and U3. For those degrees of freedom, the term FastT(n) applies only when DOF(n) = True, Fixed(n) = False, and Nonlinear(n) = True.

RateT

Type: SystemDouble
This is an array of the inverse of the characteristic sliding velocity terms when U1 is in tesion for the link property. This item applies for nonlinear analyses.

Value	Rate
RateT(0)	U1, not used
RateT(1)	U2 [s/L]
RateT(2)	U3 [s/L]
RateT(3)	R1, not used
RateT(4)	R2, not used
RateT(5)	R3, not used

Note that this item is applicable only for degrees of freedom U2 and U3. For those degrees of freedom, the term RateT(n) applies only when DOF(n) = True, Fixed(n) = False, and Nonlinear(n) = True.

Kt

Type: SystemDouble

Dis

Type: SystemDouble

Dist

Type: SystemDouble

Damping

Type: SystemDouble

DJ2

Type: SystemDouble

DJ3

Type: SystemDouble

Notes

Type: SystemString

GUID

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

Return Value

Type: Int32
Returns zero if the property is successfully retrieved; otherwise it returns a nonzero value.

Remarks

Examples

Copy

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1
       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 MySlow() As Double
       Dim MyFast() As Double
       Dim MyRate() As Double
       Dim MyRadius() As Double
       Dim MySlowT() As Double
       Dim MyFastT() As Double
       Dim MyRateT() 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 Slow() As Double
       Dim Fast() As Double
       Dim Rate() As Double
       Dim Radius() As Double
       Dim SlowT() As Double
       Dim FastT() As Double
       Dim RateT() As Double
       Dim kt As Double
       Dim dis As Double
       Dim dist As Double
       Dim Damping As Double
       Dim dj2 As Double
       Dim dj3 As Double
       Dim Notes As String
       Dim GUID As String

   'create ETABS object
       EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")

   'start ETABS application
       ret = EtabsObject.ApplicationStart()

   'create SapModel object
       SapModel = EtabsObject.SapModel

   'initialize model
       ret = SapModel.InitializeNewModel()

   'create steel deck template model
       ret = SapModel.File.NewSteelDeck(4,12,12,4,4,24,24)

   'add link property
       ReDim MyDOF(5)
       ReDim MyFixed(5)
       ReDim MyNonLinear(5)
       ReDim MyKe(5)
       ReDim MyCe(5)
       ReDim MyK(5)
       ReDim MySlow(5)
       ReDim MyFast(5)
       ReDim MyRate(5)
       ReDim MyRadius(5)
       ReDim MySlowT(5)
       ReDim MyFastT(5)
       ReDim MyRateT(5)

       MyDOF(0) = True
       MyNonLinear(0) = True
       MyKe(0) = 12
       MyCe(0) = 0.01
       MyK(0) = 1000

       MyDOF(1) = True
       MyNonLinear(1) = True
       MyKe(1) = 12
       MyCe(1) = 0.01
       MyK(1) = 20
       MySlow(1)= 0.6
       MyFast(1)= 0.5
       MyRate(1)= 10
       MyRadius(1)= 80
       MySlowT(1)= 0.61
       MyFastT(1)= 0.51
       MyRateT(1)= 10.1

       MyDOF(2) = True
       MyNonLinear(2) = True
       MyKe(2) = 14
       MyCe(2) = 0.008
       MyK(2) = 22
       MySlow(2)= 0.66
       MyFast(2)= 0.55
       MyRate(2)= 12
       MyRadius(2)= 75
       MySlowT(2)= 0.67
       MyFastT(2)= 0.56
       MyRateT(2)= 12.1

       MyDOF(3) = True
       MyKe(3) = 15
       MyCe(3) = 0

       MyDOF(4) = True
       MyFixed(4) = True

       ret = SapModel.PropLink.SetTCFrictionIsolator("TCFI1", MyDOF, MyFixed, MyNonLinear, MyKe, MyCe, MyK, MySlow, MyFast, MyRate, MyRadius, MySlowT, MyFastT, MyRateT, 18, 2, 3, 0.1, 2, 3)

   'get link property data
       ret = SapModel.PropLink.GetTCFrictionIsolator("TCFI1", DOF, Fixed, NonLinear, Ke, Ce, k, Slow, Fast, Rate, Radius, SlowT, FastT, RateT, kt, dis, dist, Damping, dj2, dj3, Notes, GUID)

   'close ETABS
       EtabsObject.ApplicationExit(False)

   'clean up variables
       SapModel = Nothing
       EtabsObject = Nothing
   End Sub

Reference

cPropLink Interface

ETABS2016 Namespace

cPropLinkAddLanguageSpecificTextSet("LST4D99A0F_0?cpp=::|nu=.");GetTCFrictionIsolator Method

Parameters

Return Value

Reference

cPropLinkGetTCFrictionIsolator Method