cAnalysisResultsAreaJointForceShell Method

Reports the area joint forces for the point elements at each corner of the specified area elements that have shell-type properties

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int AreaJointForceShell(
	string Name,
	eItemTypeElm ItemTypeElm,
	ref int NumberResults,
	ref string[] Obj,
	ref string[] Elm,
	ref string[] PointElm,
	ref string[] LoadCase,
	ref string[] StepType,
	ref double[] StepNum,
	ref double[] F1,
	ref double[] F2,
	ref double[] F3,
	ref double[] M1,
	ref double[] M2,
	ref double[] M3
)

Parameters

Name
Type: SystemString
The name of an existing area object, area element or group of objects, depending on the value of the ItemTypeElm item
ItemTypeElm
Type: ETABS2016eItemTypeElm
This is one of the following items in the eItemTypeElm enumeration.

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

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

If this item is GroupElm, the result request is for the area elements corresponding to all area objects included in the group specified by the Name item.

If this item is SelectionElm, the result request is for area elements corresponding to all selected area objects and the Name item is ignored.

NumberResults
Type: SystemInt32
The total number of results returned by the program
Obj
Type: SystemString
This is an array that includes the area object name associated with each result, if any
Elm
Type: SystemString
This is an array that includes the area element name associated with each result
PointElm
Type: SystemString
This is an array that includes the name of the point element where the results are reported
LoadCase
Type: SystemString
This is an array that includes the name of the analysis case or load combination associated with each result
StepType
Type: SystemString
This is an array that includes the step type, if any, for each result
StepNum
Type: SystemDouble
This is an array that includes the step number, if any, for each result
F1
Type: SystemDouble
This is an array that contains the joint force component in the point element local 1 axis direction. [F].
F2
Type: SystemDouble
This is an array that contains the joint force component in the point element local 2 axis direction. [F].
F3
Type: SystemDouble
This is an array that contains the joint force component in the point element local 3 axis direction. [F].
M1
Type: SystemDouble
This is an array that contains the joint moment component about the point element local 1 axis direction. [FL].
M2
Type: SystemDouble
This is an array that contains the joint moment component about the point element local 2 axis direction. [FL].
M3
Type: SystemDouble
This is an array that contains the joint moment component about the point element local 3 axis direction. [FL].

Return Value

Type: Int32
Returns zero if the forces are successfully recovered, otherwise it returns a nonzero value.
Remarks
Examples
VB
Copy
Public Sub Example()

   '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 PointElm() As String
   Dim LoadCase() As String
   Dim StepType() As String
   Dim StepNum() As Double
   Dim F1() As Double
   Dim F2() As Double
   Dim F3() As Double
   Dim M1() As Double
   Dim M2() As Double
   Dim M3() 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)

   'run analysis
       System.IO.Directory.CreateDirectory("c:\CSI_API_temp")
       ret = SapModel.File.Save("C:\CSI_API_temp\example.edb")
       ret = SapModel.Analyze.RunAnalysis()

   'deselect all cases and combos
       ret = SapModel.Results.Setup.DeselectAllCasesAndCombosForOutput()

   'set case selected for output
       ret = SapModel.Results.Setup.SetCaseSelectedForOutput("DEAD")

   'get area joint forces for area object "1"
       ret = SapModel.Results.AreaJointForceShell("1", eItemTypeElm.ObjectElm, NumberResults, Obj, Elm, PointElm, LoadCase, StepType, StepNum, F1, F2, F3, M1, M2, M3)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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