GetDamping Method

cPropMaterial GetDamping Method

CSi API ETABS 2015

Retrieves the additional material damping data for the material.

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

Syntax

int GetDamping(
	string Name,
	ref double ModalRatio,
	ref double ViscousMassCoeff,
	ref double ViscousStiffCoeff,
	ref double HystereticMassCoeff,
	ref double HystereticStiffCoeff,
	double Temp = 0
)

int GetDamping(
	string Name,
	ref double ModalRatio,
	ref double ViscousMassCoeff,
	ref double ViscousStiffCoeff,
	ref double HystereticMassCoeff,
	ref double HystereticStiffCoeff,
	double Temp = 0
)

Function GetDamping ( _
	Name As String, _
	ByRef ModalRatio As Double, _
	ByRef ViscousMassCoeff As Double, _
	ByRef ViscousStiffCoeff As Double, _
	ByRef HystereticMassCoeff As Double, _
	ByRef HystereticStiffCoeff As Double, _
	Optional Temp As Double = 0 _
) As Integer

Function GetDamping ( _
	Name As String, _
	ByRef ModalRatio As Double, _
	ByRef ViscousMassCoeff As Double, _
	ByRef ViscousStiffCoeff As Double, _
	ByRef HystereticMassCoeff As Double, _
	ByRef HystereticStiffCoeff As Double, _
	Optional Temp As Double = 0 _
) As Integer

int GetDamping(
	String^ Name, 
	double% ModalRatio, 
	double% ViscousMassCoeff, 
	double% ViscousStiffCoeff, 
	double% HystereticMassCoeff, 
	double% HystereticStiffCoeff, 
	double Temp = 0
)

int GetDamping(
	String^ Name, 
	double% ModalRatio, 
	double% ViscousMassCoeff, 
	double% ViscousStiffCoeff, 
	double% HystereticMassCoeff, 
	double% HystereticStiffCoeff, 
	double Temp = 0
)

Parameters

Name: Type: System String
The name of an existing material property.

ModalRatio: Type: System Double
The modal damping ratio.

ViscousMassCoeff: Type: System Double
The mass coefficient for viscous proportional damping.

ViscousStiffCoeff: Type: System Double
The stiffness coefficient for viscous proportional damping.

HystereticMassCoeff: Type: System Double
The mass coefficient for hysteretic proportional damping.

HystereticStiffCoeff: Type: System Double
The stiffness coefficient for hysteretic proportional damping.

Temp (Optional): Type: System Double
The temperature at which the specified data is to be retrieved. The temperature must have been previously defined for the material
This item applies only if the specified material has properties that are temperature dependent. That is, it applies only if properties are specified for the material at more than one temperature

Return Value

Returns zero if the data is successfully retrieved; 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 ModalRatio As Double 
       Dim ViscousMassCoeff As Double 
       Dim ViscousStiffCoeff As Double 
       Dim HystereticMassCoeff As Double 
       Dim HystereticStiffCoeff 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)

   'assign material damping data
     ret = SapModel.PropMaterial.SetDamping("4000Psi", 0.04, 0, 0, 0, 0)

   'get material damping data
     ret = SapModel.PropMaterial.GetDamping("4000Psi", ModalRatio, ViscousMassCoeff, ViscousStiffCoeff, HystereticMassCoeff, HystereticStiffCoeff)

   '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 ModalRatio As Double 
       Dim ViscousMassCoeff As Double 
       Dim ViscousStiffCoeff As Double 
       Dim HystereticMassCoeff As Double 
       Dim HystereticStiffCoeff 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)

   'assign material damping data
     ret = SapModel.PropMaterial.SetDamping("4000Psi", 0.04, 0, 0, 0, 0)

   'get material damping data
     ret = SapModel.PropMaterial.GetDamping("4000Psi", ModalRatio, ViscousMassCoeff, ViscousStiffCoeff, HystereticMassCoeff, HystereticStiffCoeff)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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