MotionSolve

Home
MotionSolve Reference Guide
This manual provides a detailed list and usage information regarding command statements, model statements, functions and the Subroutine Interface available in MotionSolve.
MSolve API Statements

What's New
Overview
Tutorials
MotionSolve User Guide
MotionSolve Reference Guide
HyperWorks Solver Run Manager

Index

MotionSolve

What's New
View new features for MotionSolve 2020.1.
Overview
MotionSolve^® is an integrated solution to analyze, evaluate, and optimize the performance of multi-body systems.
Tutorials
Discover MotionSolve functionality with interactive tutorials.
MotionSolve User Guide
MotionSolve is a system level, multi-body solver that is based on the principles of mechanics.
MotionSolve Reference Guide
This manual provides a detailed list and usage information regarding command statements, model statements, functions and the Subroutine Interface available in MotionSolve.
- Notation and Syntax
- Creating MotionSolve XML Files
- Writing Custom Elements for MotionSolve
- Writing Custom Functions for MotionSolve
- Supported Versions - Third Party Software
- Command Statements
- Model Statements
- Functions
- The Subroutine Interface for MotionSolve
- ADM/ACF Entities
- NLFE Statements
- MSolve API Statements
  - Conventions
    The MotionSolve API statements adhere to the following style conventions.
  - Accgrav
    Model ElementAccgrav defines the acceleration due to gravity along the global X, Y, and Z directions.
  - Arc
    Model ElementThe Arc element allows you to generate an Arc graphic defined by a center marker and a reference marker or a radius.
  - Array
    Model ElementThe Array model statement specifies a list of variables (which are used by other MotionSolve modeling elements) or constants.
  - Beam
    Model ElementBeam defines a straight, massless beam of uniform cross section acting between two markers, I and J, that belong to two different parts.
  - BodyResult
    Results ElementBodyResult is an object that contains all the results associated with single body from a simulation.
  - Box
    Model ElementThe Box element allows you to generate a rectangular Box graphic. It can be defined from the center or from the corner.
  - Bushing
    Model ElementBushing defines a linear force and torque acting between two markers, I and J.
  - Circle
    Model ElementThe Circle element allows you to generate a circle graphic defined by a center marker and a reference marker or a radius.
  - Contact
    Model ElementContact defines a 3-D contact force between geometries on two rigid bodies.
  - Coupler
    Model ElementCoupler defines an algebraic relationship between the degrees of freedom of two or three joints. This constraint element may be used to model idealized spur gears, rack and pinion gears, and differentials as simple constraints that relate the displacements in a set of joints.
  - Curve
    Model ElementCurve defines a parametric curve in 3D space.
  - Cvcv
    Model ElementCvcv defines higher pair constraint.
  - Cvsf
    Model ElementCvsf defines a higher pair constraint.
  - Cylinder
    Model ElementThe Cylinder element allows you to represent a geometric figure with straight parallel sides and a circular cross section.
  - Dcurve/DeformableCurve
    Model ElementDcurve defines a deformed curve in MotionSolve.
  - DeformCurve (Graphics)
    Model ElementThe DeformCurve element allows you to represent a curve defined in the model as a DeformableCurve element. The graphic is defined by a number of straight line segments connecting vertices on the curve defined by DeformableCurve reference.
  - DeformSurface (Graphics)
    Model ElementThe DeformSurface element allows you to represent a deformable surface defined in the model as a DeformSurface element. The graphic is defined by a number of straight line segments connecting vertices on the surface defined by DeformSurface reference.
  - Diff
    Model ElementDiff defines a single, first order, user-defined differential equation in MotionSolve.
  - Dsurface/DeformableSurface
    Model ElementDsurface defines a deformable surface in MotionSolve. It is referred to by PTDSF and PTDSFF.
  - Dv
    Model ElementDv defines a special type of solver state variable. It is used in the evaluation and computation of design sensitivity as a design parameter. Its value is modified during the simulation in case of Design Sensitivity Analysis.
  - Ellipsoid
    Model ElementThe Ellipsoid element allows you to represent a geometric figure whose plane sections are ellipses or circles.
  - Equilibrium
    Model ElementEquilibrium defines the solution control parameters for Static and Quasi-static analysis. These parameters control the accuracy the solution and the method to be used for solution.
  - External
    Model ElementThe External element allows you to represent a geometric figure using an external file. Supported file types are .x_t (Parasolid) or .fem
  - Field
    Model ElementField defines a force and torque acting between two markers, I and J. The force and torque can only be a function of time and the relative displacement between the I and J markers. The six components (three forces and three moments) are defined in the coordinate system of the J marker.
  - Flex_Body
    Model ElementFlex_Body defines a flexible body object in MotionSolve. This entity has mass and inertia properties just like a rigid body. In addition, it has flexibility properties that allow it to deform under loads.
  - FMU
    FMU (Functional Mock-up Unit) is an abstract modeling element that defines a generic modeling element in MotionSolve.
  - Friction
    Model ElementThe Friction element is used to specify joint friction in a specific joint in your model. Friction is supported only in the following types of joints: revolute, spherical, translational, cylindrical and universal. MotionSolve uses the LuGre (Lundt-Grenoble) model for friction.
  - Frustrum
    Model ElementThe Frustumelement allows you to represent the portion of a cone that remains after its upper part has been cut off by a plane parallel to its base, or that is intercepted between two such planes.
  - Gcon
    Model ElementThe GCON element is used to specify a user defined general constraint. Your constraint equations may involve position as well as velocity measures of the system. Although MotionSolve provides a large set of constraints to choose from (see JOINT), there are situations that require non-standard constraints.
  - Gear
    Model ElementGear defines a gear constraint between two bodies.
  - Gforce
    Model ElementGforce defines a general force and torque acting between two markers.
  - GraCurve
    Model ElementThe GraCurve element allows you to represent a curve defined in the model as a Curve element.
  - Gse
    Model ElementGse is an abstract modeling element that defines a generic dynamic system. The dynamic system is characterized by a vector of inputs u, a vector of dynamic states x, and a vector of outputs y. The state vector x is defined through a set of differential equations.
  - H3dOutput
    Model ElementThe H3dOutput element allows you specify various options for generating an H3dOutput file.
  - Integrator
    Model ElementIntegrator defines the simulation control parameters for a time-domain-based nonlinear dynamic analysis.
  - Joint
    Model ElementJoint is used to create an idealized connector between two bodies.
  - Jprim
    Model ElementJprim is used to remove degrees of freedom between two bodies by specifying conditions in which the relative translational or rotational motion can occur. Jprim differs from JOINT in that the former specifies mathematical constraints, which may not have concrete physical realizations like the latter.
  - LineMesh
    Model ElementThe LineMesh element connects a number of vertices in space with straight lines. It is similar to the Outline element except it does not require markers. You can pass coordinates to the LineMesh geometry.
  - Lse
    Model ElementLse is an abstract modeling element that defines a linear dynamic system.
  - Marker
    Model ElementMarker defines an orthonormal, right-handed coordinate system and reference frame in MotionSolve. A Marker must belong to a part. The body can be any type: rigid, flexible, or point.
  - Mate
    Model ElementMate is used to specify general mating constraints between geometric primitives. Mate differs from JOINT and JPRIM in that it specifies more general constraints based on distance, tangency, and coincidence relations between mating geometries.
  - Matrix
    Model ElementMatrix defines a general, real-valued, M x N matrix for use in MotionSolve.
  - MdlLikeMethod Overview
  - Mforce
    Model ElementMforce defines a distributed force on a flexible body (CMS) in MotionSolve.
  - Model
    Model ElementModel is the container for all objects of a simulation.
  - Motion
    Model ElementMotion defines a motion input into the system.
  - Nforce
    Model ElementNforce defines a force and torque acting between many markers. The force and the torque can only be linear functions of the relative displacement and velocity of the various markers.
  - Optimizer
    Model ElementOptimizer is an object that contains all the elements required for optimization.
  - Outline
    Model ElementThe Outline element creates line segments between the specified markers.
  - ParamCurve
    Model ElementThe ParamCurve element allows you to represent a curve defined in the model as a Curve element. The graphic is defined by a number of straight line segments connecting vertices on the curve defined by Curve reference.
  - ParamSurface
    Model ElementThe ParamSurface element allows you to represent a surface defined in the model as a Surface element.
  - Part
    Model ElementPart defines a rigid body object in MotionSolve. This entity has mass and inertia properties.
  - Pforce
    Model ElementPforce defined in a MotionSolve expression.
  - Pinput
    Model ElementPinput element defines the inputs to a mechanical system or plant.
  - Plane
    Model ElementThe Plane element allows you to generate a simple planar graphic.
  - Point_Mass
    Model ElementThe Point_Mass is an entity that has mass but no inertia properties.
  - POUTPUT
    Model ElementThe POUTPUT element defines the outputs from a mechanical system or plant.
  - Ptcv
    Model ElementPtcv defines a higher pair constraint. A fixed point on one body slides on a curve that is fixed on a second body. The point is not allowed to lift off the curve.
  - Ptdcv
    Model ElementPtdcv defines a constraint of a point to a deformed curve.
  - Ptdsf
    Model ElementPtdsf defines a constraint of a point to a deformable surface.
  - Ptdsff
    Model ElementPtdsff defines a force between a point and a deformable surface.
  - Ptsf
    Model ElementPTSF defines a higher pair constraint. A fixed point on one body slides on a surface that is fixed on a second body. The point is not allowed to lift off the surface.
  - Request
    Model ElementRequest defines an output request entity in MotionSolve.
  - RequestResult
    Results ElementRequestResult is an object that contains all the simulation results associated with a single Request.
  - RV
    Model ElementRv defines a special type of solver state variable. It is used in the evaluation and computation of design sensitivity as a response variable.
  - RVResult
    Model ElementRVResult is an object that contains all the simulation results associated with a single RV. At each output time,
  - Sensor
    Model ElementSensor defines an event sensor in the model. Once an event of interest occurs, you can take action to respond to the event.
  - Sforce
    Model ElementSforce defines a force or torque acting between two Markers.
  - Sfsf
    Model ElementSfsf defines a higher pair constraint. The constraint consists of a surface on one body rolling and sliding on a surface on a second body. The surfaces are required to have a unique contact point.
  - SimulationResults
    Results ElementSimulationResults is a container object containing the results from a simulation. A simulation can contain many output time steps.
  - Spdp
    Model ElementThe Spdp element allows you to generate a spring damper geometry.
  - Sphere
    Model ElementThe Sphere element creates line segments between the specified markers.
  - Spline
    Model ElementSplines are piecewise polynomial functions that possess a user controlled degree of smoothness.
  - SpringDamper
    Model ElementSpringDamper defines a spring damper acting between two markers.
  - String
    Model ElementString defines a user defined text string in MotionSolve.
  - Surface
    Model ElementSurface defines a parametric surface element in 3D space.
  - Tfsiso
    Model ElementTfsiso is an abstract modeling element that defines a linear, time invariant dynamic system in the Laplace domain.
  - Triamesh
    Model ElementThe Triamesh element allows you to represent a geometric figure using a series of nodes and faces.
  - Units
    Model ElementUnits defines the units for the model being defined.
  - Upost
    Model ElementThe UPOST element allows you to generate your own results file.
  - UserGraphic
    Model ElementThe UserGraphic element allows you to generate your own user defined geometry.
  - UserMsg
    Model ElementThe UserMsg element allows you to control the output of MotionSolve messages. Any message that MotionSolve prints to standard output goes through the
  - Variable
    Model ElementVariable defines an algebraic state in MotionSolve.
  - Vforce
    Model ElementVFORCE defines a general force acting between two markers.
  - Vtorque
    Model ElementTorque defined in a MotionSolve expression
HyperWorks Solver Run Manager
The HyperWorks Solver Run Manager is a unified utility that allows the user to start different HyperWorks Solvers.

View All Altair HyperWorks Help

MotionSolve

Home
MotionSolve Reference Guide
This manual provides a detailed list and usage information regarding command statements, model statements, functions and the Subroutine Interface available in MotionSolve.
MSolve API Statements

What's New
Overview
Tutorials
MotionSolve User Guide
MotionSolve Reference Guide
HyperWorks Solver Run Manager

Index

MSolve API Statements

Conventions
The MotionSolve API statements adhere to the following style conventions.
Accgrav
Model ElementAccgrav defines the acceleration due to gravity along the global X, Y, and Z directions.
Arc
Model ElementThe Arc element allows you to generate an Arc graphic defined by a center marker and a reference marker or a radius.
Array
Model ElementThe Array model statement specifies a list of variables (which are used by other MotionSolve modeling elements) or constants.
Beam
Model ElementBeam defines a straight, massless beam of uniform cross section acting between two markers, I and J, that belong to two different parts.
BodyResult
Results ElementBodyResult is an object that contains all the results associated with single body from a simulation.
Box
Model ElementThe Box element allows you to generate a rectangular Box graphic. It can be defined from the center or from the corner.
Bushing
Model ElementBushing defines a linear force and torque acting between two markers, I and J.
Circle
Model ElementThe Circle element allows you to generate a circle graphic defined by a center marker and a reference marker or a radius.
Contact
Model ElementContact defines a 3-D contact force between geometries on two rigid bodies.
Coupler
Model ElementCoupler defines an algebraic relationship between the degrees of freedom of two or three joints. This constraint element may be used to model idealized spur gears, rack and pinion gears, and differentials as simple constraints that relate the displacements in a set of joints.
Curve
Model ElementCurve defines a parametric curve in 3D space.
Cvcv
Model ElementCvcv defines higher pair constraint.
Cvsf
Model ElementCvsf defines a higher pair constraint.
Cylinder
Model ElementThe Cylinder element allows you to represent a geometric figure with straight parallel sides and a circular cross section.
Dcurve/DeformableCurve
Model ElementDcurve defines a deformed curve in MotionSolve.
DeformCurve (Graphics)
Model ElementThe DeformCurve element allows you to represent a curve defined in the model as a DeformableCurve element. The graphic is defined by a number of straight line segments connecting vertices on the curve defined by DeformableCurve reference.
DeformSurface (Graphics)
Model ElementThe DeformSurface element allows you to represent a deformable surface defined in the model as a DeformSurface element. The graphic is defined by a number of straight line segments connecting vertices on the surface defined by DeformSurface reference.
Diff
Model ElementDiff defines a single, first order, user-defined differential equation in MotionSolve.
Dsurface/DeformableSurface
Model ElementDsurface defines a deformable surface in MotionSolve. It is referred to by PTDSF and PTDSFF.
Dv
Model ElementDv defines a special type of solver state variable. It is used in the evaluation and computation of design sensitivity as a design parameter. Its value is modified during the simulation in case of Design Sensitivity Analysis.
Ellipsoid
Model ElementThe Ellipsoid element allows you to represent a geometric figure whose plane sections are ellipses or circles.
Equilibrium
Model ElementEquilibrium defines the solution control parameters for Static and Quasi-static analysis. These parameters control the accuracy the solution and the method to be used for solution.
External
Model ElementThe External element allows you to represent a geometric figure using an external file. Supported file types are .x_t (Parasolid) or .fem
Field
Model ElementField defines a force and torque acting between two markers, I and J. The force and torque can only be a function of time and the relative displacement between the I and J markers. The six components (three forces and three moments) are defined in the coordinate system of the J marker.
Flex_Body
Model ElementFlex_Body defines a flexible body object in MotionSolve. This entity has mass and inertia properties just like a rigid body. In addition, it has flexibility properties that allow it to deform under loads.
FMU
FMU (Functional Mock-up Unit) is an abstract modeling element that defines a generic modeling element in MotionSolve.
Friction
Model ElementThe Friction element is used to specify joint friction in a specific joint in your model. Friction is supported only in the following types of joints: revolute, spherical, translational, cylindrical and universal. MotionSolve uses the LuGre (Lundt-Grenoble) model for friction.
Frustrum
Model ElementThe Frustumelement allows you to represent the portion of a cone that remains after its upper part has been cut off by a plane parallel to its base, or that is intercepted between two such planes.
Gcon
Model ElementThe GCON element is used to specify a user defined general constraint. Your constraint equations may involve position as well as velocity measures of the system. Although MotionSolve provides a large set of constraints to choose from (see JOINT), there are situations that require non-standard constraints.
Gear
Model ElementGear defines a gear constraint between two bodies.
Gforce
Model ElementGforce defines a general force and torque acting between two markers.
GraCurve
Model ElementThe GraCurve element allows you to represent a curve defined in the model as a Curve element.
Gse
Model ElementGse is an abstract modeling element that defines a generic dynamic system. The dynamic system is characterized by a vector of inputs u, a vector of dynamic states x, and a vector of outputs y. The state vector x is defined through a set of differential equations.
H3dOutput
Model ElementThe H3dOutput element allows you specify various options for generating an H3dOutput file.
Integrator
Model ElementIntegrator defines the simulation control parameters for a time-domain-based nonlinear dynamic analysis.
Joint
Model ElementJoint is used to create an idealized connector between two bodies.
Jprim
Model ElementJprim is used to remove degrees of freedom between two bodies by specifying conditions in which the relative translational or rotational motion can occur. Jprim differs from JOINT in that the former specifies mathematical constraints, which may not have concrete physical realizations like the latter.
LineMesh
Model ElementThe LineMesh element connects a number of vertices in space with straight lines. It is similar to the Outline element except it does not require markers. You can pass coordinates to the LineMesh geometry.
Lse
Model ElementLse is an abstract modeling element that defines a linear dynamic system.
Marker
Model ElementMarker defines an orthonormal, right-handed coordinate system and reference frame in MotionSolve. A Marker must belong to a part. The body can be any type: rigid, flexible, or point.
Mate
Model ElementMate is used to specify general mating constraints between geometric primitives. Mate differs from JOINT and JPRIM in that it specifies more general constraints based on distance, tangency, and coincidence relations between mating geometries.
Matrix
Model ElementMatrix defines a general, real-valued, M x N matrix for use in MotionSolve.
MdlLikeMethod Overview
Mforce
Model ElementMforce defines a distributed force on a flexible body (CMS) in MotionSolve.
Model
Model ElementModel is the container for all objects of a simulation.
Motion
Model ElementMotion defines a motion input into the system.
Nforce
Model ElementNforce defines a force and torque acting between many markers. The force and the torque can only be linear functions of the relative displacement and velocity of the various markers.
Optimizer
Model ElementOptimizer is an object that contains all the elements required for optimization.
Outline
Model ElementThe Outline element creates line segments between the specified markers.
ParamCurve
Model ElementThe ParamCurve element allows you to represent a curve defined in the model as a Curve element. The graphic is defined by a number of straight line segments connecting vertices on the curve defined by Curve reference.
ParamSurface
Model ElementThe ParamSurface element allows you to represent a surface defined in the model as a Surface element.
Part
Model ElementPart defines a rigid body object in MotionSolve. This entity has mass and inertia properties.
Pforce
Model ElementPforce defined in a MotionSolve expression.
Pinput
Model ElementPinput element defines the inputs to a mechanical system or plant.
Plane
Model ElementThe Plane element allows you to generate a simple planar graphic.
Point_Mass
Model ElementThe Point_Mass is an entity that has mass but no inertia properties.
POUTPUT
Model ElementThe POUTPUT element defines the outputs from a mechanical system or plant.
Ptcv
Model ElementPtcv defines a higher pair constraint. A fixed point on one body slides on a curve that is fixed on a second body. The point is not allowed to lift off the curve.
Ptdcv
Model ElementPtdcv defines a constraint of a point to a deformed curve.
Ptdsf
Model ElementPtdsf defines a constraint of a point to a deformable surface.
Ptdsff
Model ElementPtdsff defines a force between a point and a deformable surface.
Ptsf
Model ElementPTSF defines a higher pair constraint. A fixed point on one body slides on a surface that is fixed on a second body. The point is not allowed to lift off the surface.
Request
Model ElementRequest defines an output request entity in MotionSolve.
RequestResult
Results ElementRequestResult is an object that contains all the simulation results associated with a single Request.
RV
Model ElementRv defines a special type of solver state variable. It is used in the evaluation and computation of design sensitivity as a response variable.
RVResult
Model ElementRVResult is an object that contains all the simulation results associated with a single RV. At each output time,
Sensor
Model ElementSensor defines an event sensor in the model. Once an event of interest occurs, you can take action to respond to the event.
Sforce
Model ElementSforce defines a force or torque acting between two Markers.
Sfsf
Model ElementSfsf defines a higher pair constraint. The constraint consists of a surface on one body rolling and sliding on a surface on a second body. The surfaces are required to have a unique contact point.
SimulationResults
Results ElementSimulationResults is a container object containing the results from a simulation. A simulation can contain many output time steps.
Spdp
Model ElementThe Spdp element allows you to generate a spring damper geometry.
Sphere
Model ElementThe Sphere element creates line segments between the specified markers.
Spline
Model ElementSplines are piecewise polynomial functions that possess a user controlled degree of smoothness.
SpringDamper
Model ElementSpringDamper defines a spring damper acting between two markers.
String
Model ElementString defines a user defined text string in MotionSolve.
Surface
Model ElementSurface defines a parametric surface element in 3D space.
Tfsiso
Model ElementTfsiso is an abstract modeling element that defines a linear, time invariant dynamic system in the Laplace domain.
Triamesh
Model ElementThe Triamesh element allows you to represent a geometric figure using a series of nodes and faces.
Units
Model ElementUnits defines the units for the model being defined.
Upost
Model ElementThe UPOST element allows you to generate your own results file.
UserGraphic
Model ElementThe UserGraphic element allows you to generate your own user defined geometry.
UserMsg
Model ElementThe UserMsg element allows you to control the output of MotionSolve messages. Any message that MotionSolve prints to standard output goes through the
Variable
Model ElementVariable defines an algebraic state in MotionSolve.
Vforce
Model ElementVFORCE defines a general force acting between two markers.
Vtorque
Model ElementTorque defined in a MotionSolve expression

Intellectual Property Rights Notice | Technical Support