simscape.multibody.UniformGravity Class

R2026b

Namespace: simscape.multibody

Uniform gravitational acceleration

Since R2026b

Description

Use an object of the simscape.multibody.UniformGravity class to specify a uniform gravitational acceleration. For example, pass a UniformGravity object to the computeDynamics method to apply gravity when computing the dynamics of a multibody system.

Class Attributes

Sealed	true
ConstructOnLoad	true

For information on class attributes, see Class Attributes.

Creation

Description

g = simscape.multibody.UniformGravity creates a uniform gravity object with a default gravitational acceleration of [0 0 -9.8066] m/s^2.

g = simscape.multibody.UniformGravity(gravity) creates a uniform gravity object with the specified gravitational acceleration.

Properties

Gravity — Gravitational acceleration

simscape.Value([0 0 -9.8066], "m/s^2") (default) | simscape.Value([gx gy gz], "Linear acceleration unit")

Gravitational acceleration, specified as a simscape.Value object that must have a 1-by-3 or 3-by-1 array and linear acceleration unit.

Example: simscape.Value([0 -9.81 0], "m/s^2")

Examples

Specify Gravitational Acceleration for Dynamics Computation

This example shows how to create uniform gravity objects with different gravitational acceleration directions.

Create a uniform gravity object with the default gravitational acceleration directed along the negative z-axis.

g = simscape.multibody.UniformGravity

g =
  UniformGravity with properties:

    Gravity: [0 0 -9.8066] (m/s^2)

Create a uniform gravity object with the gravitational acceleration directed along the negative y-axis, which is common in models that use the y-axis as the vertical direction.

g = simscape.multibody.UniformGravity(simscape.Value([0 -9.81 0],"m/s^2"))

g =
  UniformGravity with properties:

    Gravity: [0 -9.8100 0] (m/s^2)

Version History

Introduced in R2026b