Hide Table of Contents
GetFreeBodyForcesAndMoments Method (ICWResults)

Gets the x-, y-, and z-component and resultant free body forces and moments for the specified entities and the entire model.

.NET Syntax

Visual Basic (Declaration) 
Function GetFreeBodyForcesAndMoments( _
   ByVal DispPlane As System.Object, _
   ByVal SelectedRefPoint As System.Object, _
   ByVal ArraySelectedEntities As System.Object, _
   ByVal NUnits As System.Integer, _
   ByRef ErrorCode As System.Integer _
) As System.Object
Visual Basic (Usage) 
Dim instance As ICWResults
Dim DispPlane As System.Object
Dim SelectedRefPoint As System.Object
Dim ArraySelectedEntities As System.Object
Dim NUnits As System.Integer
Dim ErrorCode As System.Integer
Dim value As System.Object
 
value = instance.GetFreeBodyForcesAndMoments(DispPlane, SelectedRefPoint, ArraySelectedEntities, NUnits, ErrorCode)
C# 
System.object GetFreeBodyForcesAndMoments( 
   System.object DispPlane,
   System.object SelectedRefPoint,
   System.object ArraySelectedEntities,
   System.int NUnits,
   out System.int ErrorCode
)
C++/CLI 
System.Object^ GetFreeBodyForcesAndMoments( 
&   System.Object^ DispPlane,
&   System.Object^ SelectedRefPoint,
&   System.Object^ ArraySelectedEntities,
&   System.int NUnits,
&   [Out] System.int ErrorCode
) 

Parameters

DispPlane
Plane, axis, or coordinate system relative to which the results are listed
SelectedRefPoint
Reference point used to list the moments for the forces that are available in ArraySelectedEntities; NULL to not list the moments
ArraySelectedEntities
Selected faces, edges, vertices, and components
NUnits
Output units as defined in swsUnit_e
ErrorCode

Error as defined in swsResultsError_e

Return Value

If SelectedRefPoint is NULL:

Array of eight doubles of the free body forces for all selections in ArraySelectedEntities and for the entire model:

  • Summation of x-components of free body force for all selections
  • Summation of y-components of free body force for all selections
  • Summation of z-components of free body force for all selections
  • Resultant free body force for all selections
  • Summation of x-components of free body moment for the entire model
  • Summation of y-components of free body moment for the entire model
  • Summation of z-components of free body moment for the entire model
  • Resultant free body moment for the entire model

If SelectedRefPoint is not NULL:

Array of sixteen doubles of the free body forces and moments for all selections in ArraySelectedEntities and for the entire model:

  • Summation of x-components of free body force for all selections
  • Summation of y-components of free body force for all selections
  • Summation of z-components of free body force for all selections
  • Resultant free body force for all selections
  • Summation of x-components of free body moment for all selections
  • Summation of y-components of free body moment for all selections
  • Summation of z-components of free body moment for all selections
  • Resultant free body moment for all selections
  • Summation of x-components of free body force for the entire model
  • Summation of y-components of free body force for the entire model
  • Summation of z-components of free body force for the entire model
  • Resultant free body force for the entire model
  • Summation of x-components of free body moment for the entire model
  • Summation of y-components of free body moment for the entire model
  • Summation of z-components of free body moment for the entire model
  • Resultant free body moment for the entire model

Example

 

See Also

Availability

SolidWorks Simulation API 2013 SP0


Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

 
*Email:  
Subject:   Feedback on Help Topics
Page:   GetFreeBodyForcesAndMoments Method (ICWResults)
*Comment:  
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:

x

We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again
x

Web Help Content Version: API Help (English only) 2013 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.