GetLoadSurfacePressure {Plane Element}

GetLoadSurfacePressure

Syntax

SapObject.SapModel.PlaneElm.GetLoadSurfacePressure

VB6 Procedure

Function GetLoadSurfacePressure(ByVal Name As String, ByRef NumberItems As Long, ByRef PlaneName() As String, ByRef LoadPat() As String, ByRef Face() As Long, ByRef Value() As Double, ByRef PatternName() As String, Optional ByVal ItemTypeElm As eItemTypeElm = Element) As Long

Parameters

Name

The name of an existing plane element or group, depending on the value of the ItemType item.

NumberItems

The total number of surface pressure loads retrieved for the specified plane elements.

PlaneName

This is an array that includes the name of the plane element associated with each surface pressure load.

LoadPat

This is an array that includes the name of the load pattern associated with each surface pressure load.

Face

This is an array that includes -1, -2 or a nonzero, positive integer, indicating the area element face to which the specified load assignment applies.

-1 = Bottom face

-2 = Top face

>0 = Edge face

Note that edge face n is from plane element point n to plane element point n + 1. For example, edge face 2 is from plane element point 2 to plane element point 3.

Value

This is an array that includes the surface pressure load value. [F/L
2
]

PatternName

This is an array that includes the joint pattern name, if any, used to specify the surface pressure load.

ItemTypeElm

This is one of the following items in the eItemTypeElm enumeration:

ObjectElm = 0

Element = 1

GroupElm = 2

SelectionElm = 3

If this item is ObjectElm, the load assignments are retrieved for the plane elements corresponding to the area object specified by the Name item.

If this item is Element, the load assignments are retrieved for the plane element specified by the Name item.

If this item is GroupElm, the load assignments are retrieved for the plane elements corresponding to all area objects included in the group specified by the Name item.

If this item is SelectionElm, the load assignments are retrieved for plane elements corresponding to all selected area objects, and the Name item is ignored.

Remarks

This function retrieves the surface pressure load assignments to plane elements.

The function returns zero if the load assignments are successfully retrieved; otherwise it returns a nonzero value.

VBA Example

Sub GetPlaneElementSurfacePressureLoad()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim NumberItems As Long

Dim PlaneName() As String

Dim LoadPat() As String

Dim Face() As Long

Dim Value() As Double

Dim PatternName() 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

'open existing model

ret = SapModel.File.OpenFile("C:\SapAPI\Example 3-001-incomp.sdb")

'assign area object surface pressure load

ret = SapModel.AreaObj.SetLoadSurfacePressure("ALL", "Membrane", -1, .1, , , Group)

'create analysis model

ret = SapModel.Analyze.CreateAnalysisModel

'get plane element surface pressure load

ret = SapModel.PlaneElm.GetLoadSurfacePressure("ALL", NumberItems, PlaneName, LoadPat, Face, Value, PatternName, GroupElm)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 11.00.

Changed nomenclature from Load Cases, Analysis Cases and Response Combinations to Load Patterns, Load Cases and Load Combinations, respectively, in version 12.00.

See Also