BaseReactWithCentroid

Syntax

SapObject.SapModel.Results.BaseReactWithCentroid

VB6 Procedure

Function BaseReactWithCentroid(ByRef NumberResults As Long, ByRef ACase() As String, ByRef StepType() As String, ByRef StepNum() As Double, ByRef Fx() As Double, ByRef Fy() As Double, ByRef Fz() As Double, ByRef Mx() As Double, ByRef My() As Double, ByRef Mz() As Double, ByRef gx as Double, ByRef gy as Double, ByRef gz as Double, ByRef XCentroidForFX() as Double, ByRef YCentroidForFX() as Double, ByRef ZCentroidForFX() as Double, ByRef XCentroidForFY() as Double, ByRef YCentroidForFY() as Double, ByRef ZCentroidForFY() as Double, ByRef XCentroidForFZ() as Double, ByRef YCentroidForFZ() as Double, ByRef ZCentroidForFZ() as Double) As Long

Parameters

NumberResults

The total number of results returned by the program.

ACase

This is an array that includes the name of the analysis case or response combination associated with each result.

StepType

This is an array that includes the step type, if any, for each result.

StepNum

This is an array that includes the step number, if any, for each result.

Fx, Fy, Fz

These are one dimensional arrays that include the base reaction forces in the global X, Y and Z directions, respectively, for each result. [F]

Mx, My, Mz

These are one dimensional arrays that include the base reaction moments about the global X, Y and Z axes, respectively, for each result. [FL]

gx, gy, gz

These are the global X, Y and Z coordinates of the point at which the base reactions are reported. [L]

XCentroidForFx, YCentroidForFx, ZCentroidForFx

These are arrays of the global X, Y and Z coordinates, respectively, of the centroid of all global X-direction translational reaction forces for each result. See Base Reaction Centroids for more information. [L]

XCentroidForFy, YCentroidForFy, ZCentroidForFy

These are arrays of the global X, Y and Z coordinates, respectively, of the centroid of all global Y-direction translational reaction forces for each result. See Base Reaction Centroids for more information. [L]

XCentroidForFz, YCentroidForFz, ZCentroidForFz

These are arrays of the global X, Y and Z coordinates, respectively, of the centroid of all global Z-direction translational reaction forces for each result. See Base Reaction Centroids for more information. [L]

Remarks

This function reports the structure total base reactions and includes information on the centroid of the translational reaction forces.

The function returns zero if the reactions are successfully recovered, otherwise it returns a nonzero value.

See Analysis Results Remarks for more information.

Note that the reported base reaction centroids are not the same as the centroid of the applied loads. See Base Reaction Centroids for additional information.

VBA Example

Sub GetBaseReactionsWithCentroids()
   'dimension variables
      Dim SapObject As Sap2000.SapObject
      Dim SapModel As cSapModel
      Dim ret As Long
      Dim NumberResults As Long
      Dim PointElm() As String
      Dim ACase() As String
      Dim StepType() As String
      Dim StepNum() As Double
      Dim Fx() As Double
      Dim Fy() As Double
      Dim Fz() As Double
      Dim Mx() As Double
      Dim My() As Double
      Dim Mz() As Double
      Dim gx As Double
      Dim gy As Double
      Dim gz As Double
      Dim XCentroidForFx() As Double
      Dim YCentroidForFx() As Double
      Dim ZCentroidForFx() As Double
      Dim XCentroidForFy() As Double
      Dim YCentroidForFy() As Double
      Dim ZCentroidForFy() As Double
      Dim XCentroidForFz() As Double
      Dim YCentroidForFz() As Double
      Dim ZCentroidForFz() As Double

   'create Sap2000 object
      Set SapObject = New SAP2000.SapObject

   'start Sap2000 application
      SapObject.ApplicationStart

   'create SapModel object
      Set SapModel = SapObject.SapModel

   'initialize model
      ret = SapModel.InitializeNewModel

   'create model from template
      ret = SapModel.File.New2DFrame(PortalFrame, 3, 124, 3, 200)

   'run analysis
      ret = SapModel.File.Save("C:\SapAPI\x.sdb")
      ret = SapModel.Analyze.RunAnalysis

   'clear all case and combo output selections
      ret = SapModel.Results.Setup.DeselectAllCasesAndCombosForOutput

   'set case and combo output selections
      ret = SapModel.Results.Setup.SetCaseSelectedForOutput("DEAD")

   'get base reactions with centroids
      ret = SapModel.Results.BaseReactWithCentroid(NumberResults, ACase, StepType, StepNum, Fx, Fy, Fz, Mx, My, Mz, gx, gy, gz, XCentroidForFx, YCentroidForFx, ZCentroidForFx, XCentroidForFy, YCentroidForFy, ZCentroidForFy, XCentroidForFz, YCentroidForFz, ZCentroidForFz)

   'close Sap2000
      SapObject.ApplicationExit False
      Set SapModel = Nothing
      Set SapObject = Nothing
End Sub

Release Notes

Initial release in version 11.00.