Home
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
MotionView
Model Definition Language (MDL)
MDL Command Set Statements
MDL command set statements are used to create a solver command file when a solver input deck is exported from MotionView. A command set can contain MDL command set statements, Templex templates, or a combination of both. The commands in a command set are exported to the solver command file.
*SetState() - for command sets
Sets the state of a force/forcepair, joint/jointpair or motion/motionpair.

Welcome
What's New
View new features for version 2024.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover product functionality with interactive tutorials.
API, Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running applications in batch mode, using Tcl/Tk commands, translators, and result math.
- Extensions
  Extensions are programs integrated with the application to enhance or extend the user experience.
- External Readers and Altair Binary Format
  Altair Binary Format (ABF) is the standard binary format read by the program. A library called abflib allows you to create files in ABF.
- Generic ASCII Reader
  A generic ASCII reader is now available which allows you to bring custom results directly into HyperView. The Altair ASCII format is useful for reading the results of any in-house or propriety codes which are saved in a generic format.
- Batch Mode
  Batch mode allows you perform a series of operations outside the program interface.
- External Resources
  External resources can be registered in preference files, session files, or Templex files. If an external resource is registered in a program session, it is automatically registered in the session file when the session is saved.
- Python API
  The Python API documentation for HyperMesh applications.
- Tcl/Tk Commands
  The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
- Translators
  Translators are utilities that are run from the command line of the operating system to convert various types of files into different formats.
- Result Math
  XML commands in the Result Math Module.
- HWC Console
  Record playback workflows in the application.
- HyperMesh Report
- Task Manager
  Use the Task Manager to load an XML file that defines tasks and their attributes.
- HyperMesh
- MotionView
  - Model Definition Language (MDL)
    - MDL Model Statements
      Reference to all MDL statements and blocks that can be used to model a mechanical system.
    - Model Functions
      In MotionView, math or string functions can be used in property fields. These functions help in setting the value of the property that could range from simple arithmetic calculations to complex math equations. These functions also help in setting parametric relations to other properties.
    - MDL Command Set Statements
      MDL command set statements are used to create a solver command file when a solver input deck is exported from MotionView. A command set can contain MDL command set statements, Templex templates, or a combination of both. The commands in a command set are exported to the solver command file.
      - *CommandSet()
        Creates a command set.
      - *DefineCommandSet()
        Defines a command set.
      - *SetActiveCommandSet()
        Creates a set active command set.
      - *SetForce() - line of action for command sets
        Creates a set force.
      - *SetForce() - translational for command sets
        Creates a set force.
      - *SetForce() - rotational for command sets
        Creates a set force with torque.
      - *SetForce() - single component rotation for command sets
        Sets the value for a single component rotational action-reaction force.
      - *SetForce() - single force with user subroutine for command sets
        Sets the values for a translational, rotational line of action and single component rotational force when a user-defined subroutine is used to model the force expression.
      - *SetForce() - translational and rotational for command sets
        Creates a set force with torque.
      - *SetForce() - asymmetric line of action for command sets
        Sets the value for an asymmetric line of action action-reaction force pair.
      - *SetForce() - asymmetric translational for command sets
        Creates a set force for a pair.
      - *SetForce() - asymmetric rotational for command sets
        Creates a set force for a torque pair.
      - *SetForce() - asymmetric translational and rotational for command sets
        Creates a set force for a pair.
      - *SetForce() - asymmetric single component rotation for command sets
        Sets the value for an asymmetric single component rotational action-reaction force pair.
      - *SetForce() - asymmetric force pair with user subroutine for command sets
        Sets the value for a translational, rotational, line of action, and single component rotational asymmetric force pair when a user-defined subroutine is used to model the force expression.
      - *SetForce() - symmetric line of action for command sets
        Creates a set force for a pair.
      - *SetForce() - symmetric translational for command sets
        Creates a set force for a pair.
      - *SetForce() - symmetric translational and rotational for command sets
        Creates a set force for a pair.
      - *SetForce() - symmetric rotational for command sets
        Creates a set force for a torque pair.
      - *SetForce() - symmetric single component rotation for command sets
        Sets the value for a symmetric single component rotational action-reaction force pair.
      - *SetMotion() - single motion for command sets
        Creates a set motion.
      - *SetMotion() - symmetric motion pair for command sets
        Creates a set motion for a pair.
      - *SetMotion() - asymmetric motion pair for command sets
        Creates a set motion for a pair.
      - *SetSolverVariable() - for command sets
        Creates a set solver variable.
      - *SetState() - for command sets
        Sets the state of a force/forcepair, joint/jointpair or motion/motionpair.
      - *Simulate()
        Creates a simulation.
      - *Write() - for command sets
        Writes a previously defined template to the solver command file.
    - Wizard Description Statements
    - Custom Wizard Statements
      Custom wizards allow you to define data processing wizards for use in MotionView sessions. Custom wizards can access data from, and output data to, files and curves in a session using data sets, templates, user-defined forms, curves, procedures and systems.
    - MDL Variables, Implicit Entities, and Templex
      MDL variables, implicit entities, and Templex statements that can be used while creating an entity or expressions in MDL models.
  - Tire Modeling
    Tires are critical elements to modeling a vehicle’s interaction with a road, with some tire models better suited to specific simulation domains.
  - MDL Library Reference Guide
    Overview of the MDL Library reference guide.
- Templex and Math Reference Guide
- Script and Model Library
  The Script and Model Library is a database of freely accessible scripts and models posted by users and Altair engineers.

View All Altair HyperWorks Help

*SetState() - for command sets

Sets the state of a force/forcepair, joint/jointpair or motion/motionpair.

Syntax

*SetState(force/forepair|joint/jointpair|motion/motionpair, ON/OFF)

Arguments

force/forcepair|joint/jointpair|motion/motionpair: An existing force/forcepair, joint/jointpair, or motion/motionpair for which the state is being specified.; Type: force|joint|motion
ON/OFF: ON turns on the specified force/forcepair, joint/jointpair, or motion/motionpair.; OFF turns off the specified force/forcepair, joint/jointpair, or motion/motionpair.; Type: boolean

Example

In the example below, the *SetState() statement inside the event definition deactivates the motion m_0:

*BeginMDL(the_model, "MBD Model")
     *Motion(m_0, "Motion 0", MODEL.j_0, ROT)
     *Analysis(analysis_0, "Analysis", def_analysis)
*EndMDL()

*Define Analysis(def_analysis)
     *Event(event_1, "Event", def_event)
*EndDefine()

*DefineEvent(def_event)
     *SetState(MODEL.m_0, OFF)
*EndDefine()

Context

*BeginMDL()

*DefineCommandSet()

Comments

Setting the state of a force, joint, or motion to ON causes that force, joint, or motion to be activated through the solver command file. Setting the state of a force, joint, or motion to OFF causes that force, joint, or motion, or force|joint|motion pair to be deactivated through the solver command file. These commands appear in the solver command file in the order that they appear in the corresponding *DefineCommandSet block and where the *CommandSet() statement occurs within the *DefineAnalysis block.