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 3D Commands
getcompindex3d
Returns the index of a component for a given data type using the 3D CAE Readers. The function has two forms. Use the first form when there are no subcases and second form when there are multiple subcases.

Welcome
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
  - CAE Reader 3D Commands
    - getcompindex3d
      Returns the index of a component for a given data type using the 3D CAE Readers. The function has two forms. Use the first form when there are no subcases and second form when there are multiple subcases.
    - getcomplist3d
      Returns the valid components for a given data type using the 3D CAE Readers. The function has two forms. Use the first form when there are no subcases and second form when there are multiple subcases.
    - getcompname3d
      Returns the name of a component for a given data type using the 3D CAE Readers. The function has two forms. Use the first form when there are no subcases and second form when there are multiple subcases.
    - getelemindex3d
      Returns the element index for a given file and element name.
    - getelemlist3d
      Returns the valid elements for a given file using the 3D CAE Readers.
    - getelemname3d
      Returns the element name for a given file and element index.
    - getlayerindex3d
      Returns the index of a layer for a given data type using the 3D CAE Readers. The function has two forms. Use the first form when there are no subcases and second form when there are multiple subcases.
    - getlayername3d
      Returns the name of a layer for a given data type using the 3D CAE Readers. The function has two forms. Use the first form when there are no subcases and second form when there are multiple subcases.
    - getlayerslist3d
      Returns the valid layers for a given data type using the 3D CAE Readers. The function has two forms. Use the first form when there are no subcases and second form when there are multiple subcases.
    - getnodeindex3d
      Returns the node index for a given file and node name.
    - getnodelist3d
      Returns the valid nodes for a given file using the 3D CAE Readers.
    - getnodename3d
      Returns the node name for a given file and node index.
    - getnumcomps3d
      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 the second form when there are multiple subcases.
    - getnumelems3d
      Returns the number of elements in a file.
    - getnumlayers3d
      Returns the number of layers within a given data type. The function has two forms. Use the first form when there is zero or at most one subcase and the second form when there are multiple subcases.
    - getnumnodes3d
      Returns the number of nodes in a file.
    - getnumsubcases3d
      Returns the number of subcases in a file.
    - getnumtypes3d
      Returns the number of data types in a file. By default the first subcase is used.
    - getsubcaseindex3d
      Returns the subcase index for a given file and subcase name.
    - getsubcaselist3d
      Returns the valid subcases for a given file using the 3D CAE Readers.
    - getsubcasename3d
      Returns the subcase name for a given file and subcase index.
    - gettimesteplist3d
      Returns a list of time steps in a file using the 3D CAE Readers. By default, the first subcase is used.
    - gettypeindex3d
      Return the index of a datatype in a data file using the 3D CAE Readers. The function has two forms. Use the first form when there are no subcases and second form when there are multiple subcases.
    - gettypelist3d
      Returns a list of data types in a file using the 3D CAE Readers. By default, the first subcase is used.
    - gettypename3d
      Gets the name of a data type from its index using the 3D CAE Readers. The function has two forms. Use the first form when there are no subcases and second form when there are multiple subcases.
    - readcae3d
      Reads data from a given file using the 3D CAE Readers. readcae3d uses the CAE readers provided with Compose that require access to model information, such as corner data, averaging method, layer and coordinate system.
    - releasefileinfo3d
      The data read through readcae3d , and meta data read through readcae3d, gettypename3d,gettypelist3d, gettypeindex3d,getcompname3d, getcomplist3d and getcompindex3d 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 Writer Commands
  - Calculus Commands
  - Computer Vision Commands
  - Communication 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
  - JSON Commands
  - Library Manager Commands
  - Linear Algebra Commands
  - Logical Commands
  - Machine Learning Commands
  - Optimization Commands
  - Plotting Commands
  - PSIM Commands
  - Polynomial Math Commands
  - Signal Processing Commands
  - Special Functions 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!

getcompindex3d

Returns the index of a component for a given data type using the 3D CAE Readers. The function has two forms. Use the first form when there are no subcases and second form when there are multiple subcases.

Attention: Valid only with Altair CAE Readers and Writers Extension.

Syntax

getcompindex3d(filename, datatype, component)

getcompindex3d(filename, subcase, datatype, component)

R = getcompindex3d(...)

Inputs

filename: Path of the file.; Type: string
subcase: Subcase name or index in the file.; Type: string | int
datatype: Data type name or index in the file.; Type: string | int
component: Component name to find the index of.; Type: string

Outputs

R: Index of the component.

Examples

Basic getcompindex3d example with subcase:

getcompindex3d('Comp-plate-1LC.h3d',1,1,'X')

ans = 1