FreeBody object

The FreeBody object defines a section across which resultant forces and moments are computed.

This page discusses:

Access
FreeBodyFromEdges(...)
FreeBodyFromFaces(...)
FreeBodyFromNodesElements(...)
getFreeBodyData(...)
Members

Access

import visualization
session.freeBodies[name]

FreeBodyFromEdges(...)

This method creates a FreeBody object and places it in the freeBodies repository.

Path

session.FreeBodyFromEdges

Required arguments

name: A string name for the free body.
edges: A DisplayGroup leaf object that specifies the physical constituents of the free body.

Optional arguments

summationLoc: A SymbolicConstant specifying the location of the summation point. Possible values are CENTROID, NODAL_AVERAGE, and SPECIFY. The default value is CENTROID.
summationPoint: A tuple of 3 floats specifying the summation point.
componentResolution: A SymbolicConstant specifying the component resolution. Possible values are NORMAL_TANGENTIAL and CSYS. The default value is NORMAL_TANGENTIAL.
csysName: A string specifying the name of the coordinate system.

Return value

A FreeBody object.

Exceptions

None.

FreeBodyFromFaces(...)

This method creates a FreeBody object and places it in the freeBodies repository.

Path

session.FreeBodyFromFaces

Required arguments

name: A string name for the free body.
faces: A DisplayGroup leaf object that specifies the physical constituents of the free body.

Optional arguments

summationLoc: A SymbolicConstant specifying the location of the summation point. Possible values are CENTROID, NODAL_AVERAGE, and SPECIFY. The default value is CENTROID.
summationPoint: A tuple of 3 floats specifying the summation point.
componentResolution: A SymbolicConstant specifying the component resolution. Possible values are NORMAL_TANGENTIAL and CSYS. The default value is NORMAL_TANGENTIAL.
csysName: A string specifying the name of the coordinate system.

Return value

A FreeBody object.

Exceptions

None.

FreeBodyFromNodesElements(...)

This method creates a FreeBody object and places it in the freeBodies repository.

Path

session.FreeBodyFromNodesElements

Required arguments

name: A string name for the free body.
elements: A DisplayGroup leaf object that specifies the physical constituents of the free body.
nodes: A DisplayGroup leaf object that specifies the physical constituents of the free body.

Optional arguments

summationLoc: A SymbolicConstant specifying the location of the summation point. Possible values are CENTROID, NODAL_AVERAGE, and SPECIFY. The default value is CENTROID.
summationPoint: A tuple of 3 floats specifying the summation point.
componentResolution: A SymbolicConstant specifying the component resolution. Possible values are NORMAL_TANGENTIAL and CSYS. The default value is NORMAL_TANGENTIAL.
csysName: A string specifying the name of the coordinate system.

Return value

A FreeBody object.

Exceptions

None.

getFreeBodyData(...)

This method returns the force and moment data of a FreeBody object.

Path

session.freeBodies[name].getFreeBodyData

Required arguments

None.

Optional arguments

step: An Int specifying the step from which to obtain values. The default value is the current step.
frame: An Int specifying the frame from which to obtain values. The default value is the current frame.
allActiveStepFrame: A Boolean specifying whether to obtain the values from the specified step and frame or from all active steps and frames.

Return value

A tuple of tuples of dictionaries, for each requested step and frame, containing the force and moment data.

Exceptions

None.

Members

The FreeBody object has no members.