jointPrimitiveActuationForceTorque

Class: simscape.multibody.CompiledMultibody
Namespace: simscape.multibody

Return actuation force or torque of joint primitive

Since R2025a

Syntax

[act] = jointPrimitiveActuationForceTorque(cmb,jointPrimitive,dynamicsResult)

Description

[act] = jointPrimitiveActuationForceTorque(cmb,jointPrimitive,dynamicsResult) returns the actuation force or torque of the specified joint primitive in the given dynamics results. The dynamicsResult argument represented by a simscape.multibody.DynamicsResult object contains the dynamics results of a multibody model. The object must be generated from the same simscape.multibody.CompiledMultibody object that represents cmb.

You can query the actuation force of the prismatic joint primitive and the actuation torque of the revolute joint primitive.

Input Arguments

cmb — Compiled multibody system

simscape.multibody.CompiledMultibody object

Compiled multibody system, specified as a simscape.multibody.CompiledMultibody object.

jointPrimitive — Path of joint primitive

string scalar | character vector

Path of the joint primitive, specified as a string scalar or character vector. Separate the path elements by using forward slashes.

Example: "Bottom_Right_Joint/Rz"

dynamicsResult — Dynamics results of multibody model

simscape.multibody.DynamicsResult object

Dynamics results of the multibody model, specified as a simscape.multibody.DynamicsResult object.

Output Arguments

act — Actuation force or torque of joint primitive

simscape.Value object

Acceleration of the joint primitive, returned as a simscape.Value object. The form of the value depends on the type of the joint primitive:

Primitive Type	Type of Returned Position
Revolute	simscape.Value object that represents a scalar with a unit of torque
Prismatic	simscape.Value object that represents a scalar with a unit of force

Attributes

Access

public

To learn about attributes of methods, see Method Attributes.

Version History

Introduced in R2025a