SetPlasticWen Method

cPropLink SetPlasticWen Method

CSi API ETABS 2015

Initializes a plastic Wen-type link property. If this function is called for an existing link property, all items for the property are reset to their default values.

Namespace: ETABS2015
Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)

Syntax

C++

Copy to Clipboard Print

int SetPlasticWen(
	string Name,
	ref bool[] DOF,
	ref bool[] Fixed,
	ref bool[] Nonlinear,
	ref double[] Ke,
	ref double[] Ce,
	ref double[] K,
	ref double[] Yield,
	ref double[] Ratio,
	ref double[] Exp,
	double DJ2,
	double DJ3,
	string Notes = "",
	string GUID = ""
)

int SetPlasticWen(
	string Name,
	ref bool[] DOF,
	ref bool[] Fixed,
	ref bool[] Nonlinear,
	ref double[] Ke,
	ref double[] Ce,
	ref double[] K,
	ref double[] Yield,
	ref double[] Ratio,
	ref double[] Exp,
	double DJ2,
	double DJ3,
	string Notes = "",
	string GUID = ""
)

Function SetPlasticWen ( _
	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 Yield As Double(), _
	ByRef Ratio As Double(), _
	ByRef Exp As Double(), _
	DJ2 As Double, _
	DJ3 As Double, _
	Optional Notes As String = "", _
	Optional GUID As String = "" _
) As Integer

Function SetPlasticWen ( _
	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 Yield As Double(), _
	ByRef Ratio As Double(), _
	ByRef Exp As Double(), _
	DJ2 As Double, _
	DJ3 As Double, _
	Optional Notes As String = "", _
	Optional GUID As String = "" _
) As Integer

int SetPlasticWen(
	String^ Name, 
	array<bool>^% DOF, 
	array<bool>^% Fixed, 
	array<bool>^% Nonlinear, 
	array<double>^% Ke, 
	array<double>^% Ce, 
	array<double>^% K, 
	array<double>^% Yield, 
	array<double>^% Ratio, 
	array<double>^% Exp, 
	double DJ2, 
	double DJ3, 
	String^ Notes = L"", 
	String^ GUID = L""
)

int SetPlasticWen(
	String^ Name, 
	array<bool>^% DOF, 
	array<bool>^% Fixed, 
	array<bool>^% Nonlinear, 
	array<double>^% Ke, 
	array<double>^% Ce, 
	array<double>^% K, 
	array<double>^% Yield, 
	array<double>^% Ratio, 
	array<double>^% Exp, 
	double DJ2, 
	double DJ3, 
	String^ Notes = L"", 
	String^ GUID = L""
)

Parameters

Name: Type: System String
The name of an existing or new link property. If this is an existing property, that property is modified; otherwise, a new property is added.

DOF: Type: System Boolean

Fixed

Type:

System Boolean
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:

System Boolean
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 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: Type: System Double

Ce: Type: System Double

K: Type: System Double

Yield

Type:

System Double
This is an array of yield force terms for the link property. The yield force applies for nonlinear analyses.

Value	Yield
yield(0)	U1 [F]
yield(1)	U2 [F]
yield(2)	U3 [F]
yield(3)	R1 [F/L]
yield(4)	R2 [F/L]
yield(5)	R3 [F/L]

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

Ratio

Type:

System Double
This is an array of post-yield stiffness ratio terms for the link property. The post-yield stiffness ratio applies for nonlinear analyses. It is the post-yield stiffness divided by the initial stiffness.

Value	Ratio
Ratio(0)	U1
Ratio(1)	U2
Ratio(2)	U3
Ratio(3)	R1
Ratio(4)	R2
Ratio(5)	R3

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

Exp: Type: System Double

DJ2: Type: System Double

DJ3: Type: System Double

Notes (Optional): Type: System String

GUID (Optional): Type: System String
The GUID (global unique identifier), if any, assigned to the property. If this item is input as Default, the program assigns a GUID to the property.

Return Value

Returns zero if the property is successfully initialized; otherwise it returns a nonzero value.

Remarks

Examples

C++

Copy to Clipboard Print

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 MyYield() As Double 
       Dim MyRatio() As Double 
       Dim MyExp() As Double 

   '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 MyYield(5)
       ReDim MyRatio(5)
       ReDim MyExp(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
       MyYield(1)= 50
       MyRatio(1)= 0.1
       MyExp(1)= 3

       MyDOF(2) = True
       MyFixed(2) = True

       ret = SapModel.PropLink.SetPlasticWen("PW1", MyDOF, MyFixed, MyNonLinear, MyKe, MyCe, MyK, MyYield, MyRatio, MyExp, 2, 0)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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

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 MyYield() As Double 
       Dim MyRatio() As Double 
       Dim MyExp() As Double 

   '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 MyYield(5)
       ReDim MyRatio(5)
       ReDim MyExp(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
       MyYield(1)= 50
       MyRatio(1)= 0.1
       MyExp(1)= 3

       MyDOF(2) = True
       MyFixed(2) = True

       ret = SapModel.PropLink.SetPlasticWen("PW1", MyDOF, MyFixed, MyNonLinear, MyKe, MyCe, MyK, MyYield, MyRatio, MyExp, 2, 0)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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