User's Guide

Home
Reference Guides
Reference guides are available for functions and commands supported by OML, Tcl, and Python.
Reference Guide for OpenMatrix Language Functions
The Reference Guide contains documentation for all functions supported in the OpenMatrix language.
CAE Reader Commands

What's New
Get Started
Tutorials
User Guide
Reference Guides
Appendix
Frequently Asked Questions

Index

User's Guide

What's New
Discover new features and enhancements.
Get Started
Discover Compose, including its language support and system requirements.
Tutorials
The Compose tutorials and associated example model files help introduce you to the basic functionality of the software.
User Guide
Learn about the features and functionality available in Compose.
Reference Guides
Reference guides are available for functions and commands supported by OML, Tcl, and Python.
- Scripting Guide for OpenMatrix Language
  OpenMatrix is a mathematical scripting language.
- Reference Guide for OpenMatrix Language Functions
  The Reference Guide contains documentation for all functions supported in the OpenMatrix language.
  - ABF Commands
  - Altair Integration Commands
  - Audio Commands
  - CAE Commands
  - CAE Reader Commands
    - extract
      Extracts specific subcase-type-request-component selections from the result of readmultvectors command.
    - getcompindex
      Returns the index of a component for a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
    - getcomplist
      Returns the valid components for a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
    - getcompname
      Returns the name of a component for a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
    - getfilteredcomplist
      Returns the component list for a given data type and request. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
    - getfilteredtypelist
      Returns a list of data types in a file, excludes time.
    - getnumcomps
      Returns the number of components within a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
    - getnumreqs
      Returns the number of requests for a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
    - getnumtypes
      Returns the number of data types in a file. By default the first subcase is used.
    - getreqindex
      Returns the index of a request for a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
    - getreqlist
      Returns a list requests for a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
    - getreqname
      Returns the name of a request within a data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
    - getsubcaseindex
      Returns the index of a subcase.
    - getsubcaselist
      Returns a list of all subcases within a file.
    - getsubcasename
      Returns the name of a subcase in a file.
    - gettimesteplist
      Returns a list of time steps associated with the given subcase, type, request, and component.
    - gettotalsubcases
      Returns total count of subcases in a data file.
    - gettypeindex
      Return the index of a datatype in a data file. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
    - gettypelist
      Returns a list of data types in a file. By default, the first subcase is used.
    - gettypename
      Gets the name of a data type from its index. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
    - getunitlist
      Returns a list of supported units for a given unittype.
    - getunittypelist
      Returns supported unit types.
    - readcae
      Reads data from a given file. readcae uses the CAE readers provided with Compose and supports a large set of file formats.
    - readfiletoc
      Reads a file and display its table of contents (data structure) in a hierarchical way using nested cells. Files are read using the CAE readers provided with Compose, which support a large set of file formats.
    - readmultvectors
      Reads data from a given file. readmultvectors uses the CAE readers provided with Compose and supports a large set of file formats. The function has two main forms. See the Comments section for more information on these forms.
    - readunits
      Returns a cell with the unit type and unit associated with the subcase, datatype, request and component of a given file.
    - readvector
      Reads data vector from a file. The data is organized in terms of subcase, type, request, and component. The function has two forms. Use the first form when there is zero or at most one subcase and use the second form when there are multiple subcases.
    - readvectorbuilder
      readvectorbuilder is a utility tool that reads CAE results/data files supported by Compose. It helps you create the right readvector() and readmultvectors() commands. The tool opens a dialog that can be used to select results files and navigate into the subcases, time steps, types, requests, and components contained in the selected file. Upon making your selections and selecting Print, the appropriate OML command (using either the readvector or readmultvectors command) is displayed.
    - releasedata
      Releases data from memory after using the functions readvectors, readmultvectors or readcae. The function has two forms and take similar arguments as readvector.
    - releasefileinfo
      The data read through readvectors, readcae , readmultvectors and metadata read through getsubcaselist, gettypelist, getreqlist, getcomplist and readfiletoc is not necessarily auto-released from memory when the vectors they were assigned to are emptied. They can be released explicitly, though, as shown below.
  - CAE Reader 3D Commands
  - CAE Writer Commands
  - Calculus Commands
  - Computer Vision Commands
  - Control System Commands
  - Core Minimal Interpreter Commands
  - Data Structure Commands
  - Differential Equations Commands
  - Elementary Math Commands
  - File I/O Commands
  - Geometry Commands
  - GUI Commands
  - HDF5 Reader Commands
  - HDF5 Writer Commands
  - hstpyfit Commands
  - Image Commands
  - Library Manager Commands
  - Linear Algebra Commands
  - Logical Commands
  - Machine Learning Commands
  - Optimization Commands
  - Plotting Commands
  - Polynomial Math Commands
  - Signal Processing Commands
  - Statistical Analysis Commands
  - String Operations Commands
  - System Commands
  - Table Commands
  - Tcl Bridge OML Commands
  - Tcl Bridge Tcl Commands
  - Time Commands
  - Trigonometry Commands
  - OML to Python Bridge Commands
  - Python to OML Bridge Commands
- Python in Compose Reference Guide
Appendix
Get help for the optional libraries that are available in the Extension Manager.
Frequently Asked Questions
You've got questions? We've got answers!

User's Guide

Home
Reference Guides
Reference guides are available for functions and commands supported by OML, Tcl, and Python.
Reference Guide for OpenMatrix Language Functions
The Reference Guide contains documentation for all functions supported in the OpenMatrix language.
CAE Reader Commands

What's New
Get Started
Tutorials
User Guide
Reference Guides
Appendix
Frequently Asked Questions

Index

CAE Reader Commands

extract
Extracts specific subcase-type-request-component selections from the result of readmultvectors command.
getcompindex
Returns the index of a component for a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
getcomplist
Returns the valid components for a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
getcompname
Returns the name of a component for a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
getfilteredcomplist
Returns the component list for a given data type and request. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
getfilteredtypelist
Returns a list of data types in a file, excludes time.
getnumcomps
Returns the number of components within a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
getnumreqs
Returns the number of requests for a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
getnumtypes
Returns the number of data types in a file. By default the first subcase is used.
getreqindex
Returns the index of a request for a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
getreqlist
Returns a list requests for a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
getreqname
Returns the name of a request within a data type. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
getsubcaseindex
Returns the index of a subcase.
getsubcaselist
Returns a list of all subcases within a file.
getsubcasename
Returns the name of a subcase in a file.
gettimesteplist
Returns a list of time steps associated with the given subcase, type, request, and component.
gettotalsubcases
Returns total count of subcases in a data file.
gettypeindex
Return the index of a datatype in a data file. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
gettypelist
Returns a list of data types in a file. By default, the first subcase is used.
gettypename
Gets the name of a data type from its index. The function has two forms. Use the first form when there is zero or at most one subcase and second form when there are multiple subcases.
getunitlist
Returns a list of supported units for a given unittype.
getunittypelist
Returns supported unit types.
readcae
Reads data from a given file. readcae uses the CAE readers provided with Compose and supports a large set of file formats.
readfiletoc
Reads a file and display its table of contents (data structure) in a hierarchical way using nested cells. Files are read using the CAE readers provided with Compose, which support a large set of file formats.
readmultvectors
Reads data from a given file. readmultvectors uses the CAE readers provided with Compose and supports a large set of file formats. The function has two main forms. See the Comments section for more information on these forms.
readunits
Returns a cell with the unit type and unit associated with the subcase, datatype, request and component of a given file.
readvector
Reads data vector from a file. The data is organized in terms of subcase, type, request, and component. The function has two forms. Use the first form when there is zero or at most one subcase and use the second form when there are multiple subcases.
readvectorbuilder
readvectorbuilder is a utility tool that reads CAE results/data files supported by Compose. It helps you create the right readvector() and readmultvectors() commands. The tool opens a dialog that can be used to select results files and navigate into the subcases, time steps, types, requests, and components contained in the selected file. Upon making your selections and selecting Print, the appropriate OML command (using either the readvector or readmultvectors command) is displayed.
releasedata
Releases data from memory after using the functions readvectors, readmultvectors or readcae. The function has two forms and take similar arguments as readvector.
releasefileinfo
The data read through readvectors, readcae , readmultvectors and metadata read through getsubcaselist, gettypelist, getreqlist, getcomplist and readfiletoc is not necessarily auto-released from memory when the vectors they were assigned to are emptied. They can be released explicitly, though, as shown below.

Intellectual Property Rights Notice | Technical Support