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.
Tcl/Tk Commands
The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
Tcl/Tk Commands
Tcl/Tk classes for the following Altair HyperWorks applications.
HyperView
poITensorCtrl Class
poITensorCtrl GetAverageEnabled
Gets the averaging state.

Welcome
What's New
View new features for version 2024.1.
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.
  - Program with APIs for Beginners
    APIs can be used to perform various actions in an application. For example, the AddPage API can be used to add a page within the project.
  - Object Hierarchy
    Overview of object hierarchy for HyperView, HyperGraph, HyperMesh, MotionView, MediaView and TextView.
  - Tcl/Tk Classes
    Links to the introductory pages for the Tcl/Tk commands that can be used in HyperView, MotionView, HyperGraph, HyperGraph 3D, TextView and MediaView.
  - Script Use Cases
    Examples of script uses cases.
  - Tcl/Tk Example
    Learn more about Tcl/Tk with this basic example.
  - Program with Tcl/Tk Command Tutorials
    Learn more about programming with Tcl/Tk commands with this tutorial.
  - Tcl/Tk Commands
    Tcl/Tk classes for the following Altair HyperWorks applications.
    - Framework
    - MotionView
    - HyperView
      - Hotspot Finder API Structure
      - HyperView - MultiCore APIs
      - poI3DViewCtrl Class
      - poIAdvancedQuery Class
      - poIAssembly Class
      - poIBestView Class
      - poICFD Class
      - poICFD_rake Class
      - poICollisionCtrl Class
      - poICollisionSet Class
      - poIComplexCtrl Class
      - poIComponent Class
      - poIContourCtrl Class
      - poICrossSectionPlanar Class
      - poICrossSectionSet Class
      - poIExplosion Class
      - poIFBDCtrl Class
      - poIFLDCtrl Class
      - poIGraphicMaterial Class
      - poIImagePlaneCtrl Class
      - poIImagePlane Class
      - poIIsoValueCtrl Class
      - poILayerFilter Class
      - poILegend Class
      - poIMeasure Class
      - poIModel Class
      - poINote Class
      - poIPart Class
      - poIPartAssembly Class
      - poIPartSet Class
      - poIPost Class
      - poIPostManager Class
      - poIQueryCtrl Class
      - poIQueryDistanceRule Class
      - poIQueryExpressionRule Class
      - poIQueryExtremeRule Class
      - poIQueryIgnoreElemTypeRule Class
      - poIQueryIterator Class
      - poIQueryRule Class
      - poIQuerySetRule Class
      - poIRenderOptions Class
      - poIResultCtrl Class
      - poIResultMathCtrl Class
      - poIScalarDefine Class
      - poIScaleCtrl Class
      - poISCL Class
      - poISection Class
      - poISelectionSet Class
      - poIStressLinearizationCtrl Class
      - poISubcase Class
      - poISweepCtrl Class
      - poISymmetry Class
      - poISystem Class
      - poISystemCtrl Class
      - poITensorCtrl Class
        poITensorCtrl CopyToClipBoard
        Copies tensor data to the clipboard.
        poITensorCtrl GetAverageEnabled
        Gets the averaging state.
        poITensorCtrl GetColor
        Gets the color for a given tensor component.
        poITensorCtrl GetColorMode
        Gets the color mode for tensors.
        poITensorCtrl GetCornerDataEnabled
        Gets the flag to indicate if corner data is requested.
        poITensorCtrl GetCurrentPlotStyle
        Gets the current plot style.
        poITensorCtrl GetDataComponent
        Gets the current data component label.
        poITensorCtrl GetDataType
        Gets the current tensor data type.
        poITensorCtrl GetDimensionEnabled
        Gets the dimension state, either enabled or disabled.
        poITensorCtrl GetDisplayMode
        Gets the tensor control display mode.
        poITensorCtrl GetDisplayModeList
        Gets the display mode list used for drawing the tensors.
        poITensorCtrl GetEnabled
        Gets the pool state, either enabled or disabled.
        poITensorCtrl GetEnableState
        Gets the auto load/unload tensor data state.
        poITensorCtrl GetFont
        Gets the font name being used to draw the tensor plot text in the graphics area.
        poITensorCtrl GetFontHandle
        Gets a handle to the poITextAttribute interface for the tensor plot text.
        poITensorCtrl GetHeadType
        Gets the type of head that is being drawn on each tensor.
        poITensorCtrl GetHeadTypeList
        Gets a list of valid head types that can be used when calling SetHeadType.
        poITensorCtrl GetLayer
        Gets the current layer label.
        poITensorCtrl GetLegendHandle
        Gets the legend control object for tensor control.
        poITensorCtrl GetMultiplier
        Gets the multiplier for tensor results.
        poITensorCtrl GetPlotStyleList
        Gets a list of all the tensor plot styles stored in the tensor controller.
        poITensorCtrl GetResultSystem
        Gets the result system ID.
        poITensorCtrl GetScale
        Gets the scale value used to display tensors.
        poITensorCtrl GetScaleMode
        Gets the scale mode used to display tensors.
        poITensorCtrl GetSelectionSetSize
        Gets the size of the selection set.
        poITensorCtrl GetShearComponentScale
        Gets the scale factor for the shear component.
        poITensorCtrl GetShowMidsideNodeResults
        Gets the state of the "Show Midside Node Results" option for the tensor control.
        poITensorCtrl GetShowPrefixMode
        Gets the state of the tensor's prefix draw mode.
        poITensorCtrl GetShowValueMode
        Gets the state of the tensor's value draw mode.
        poITensorCtrl GetTensorFormat
        Gets the tensor format.
        poITensorCtrl GetTextColor
        Gets the tensor plot text color.
        poITensorCtrl GetThresholdMax
        Gets the maximum threshold.
        poITensorCtrl GetThresholdMaxEnableState
        Gets the enable/disable state of the maximum threshold.
        poITensorCtrl GetThresholdMin
        Gets the minimum threshold.
        poITensorCtrl GetThresholdMinEnableState
        Gets the enable/disable state of the minimum threshold.
        poITensorCtrl GetValueList
        When nodal results are in use, multiple results may exist for nodes along part boundaries. In these cases, the returned list will contain the first nodal value encountered, while the nodal values for the other parts will be omitted.
        poITensorCtrl RemovePlotStyle
        Removes a plot style with the specified name.
        poITensorCtrl RenamePlotStyle
        Renames an existing/old plot style with a new name.
        poITensorCtrl RestorePlotStyle
        Resets the contour controller settings with a memorized plot style.
        poITensorCtrl SavePlotStyle
        Captures the current tensor controller settings and saves it with the given name.
        poITensorCtrl SetAverageEnabled
        Sets the flag to indicate if results are element/node associated.
        poITensorCtrl SetColor
        Sets the color for a given tensor component
        poITensorCtrl SetColorMode
        Sets the color mode for tensors.
        poITensorCtrl SetCornerDataEnabled
        Sets the flag to indicate if corner data is requested.
        poITensorCtrl SetCurrentPlotStyle
        Sets the current plot style.
        poITensorCtrl SetDataComponent
        Sets the data component for a given component label.
        poITensorCtrl SetDataType
        Sets the data type for the tensor control.
        poITensorCtrl SetDimensionEnabled
        Sets the dimension state: enabled or disabled.
        poITensorCtrl SetDisplayMode
        Sets the tensor control display mode.
        poITensorCtrl SetEnabled
        Sets the dimension state, either enabled or disabled.
        poITensorCtrl SetEnableState
        Sets the auto load/unload tensor data state.
        poITensorCtrl SetFont
        Sets the font by name.
        poITensorCtrl SetHeadType
        Sets the type of head that is drawn on each tensor.
        poITensorCtrl SetLayer
        Sets the current layer for the specified pool.
        poITensorCtrl SetMultiplier
        Sets the multiplier for tensor results.
        poITensorCtrl SetResultSystem
        Sets the result system ID.
        poITensorCtrl SetScale
        Sets the scale value used to display tensors.
        poITensorCtrl SetScaleMode
        Sets the scale mode used to display tensors.
        poITensorCtrl SetSelectionSet
        Sets the selected elements to be used by the tensor control.
        poITensorCtrl SetShearComponentScale
        Sets the scale factor for the shear component.
        poITensorCtrl SetShellLayer
        Sets the current shell layer.
        poITensorCtrl SetShowMidsideNodeResults
        Sets the state of the "Show Midside Node Results" option for the tensor control.
        poITensorCtrl SetShowPrefixMode
        Sets the show prefix mode used for drawing tensor prefixes in the graphics area.
        poITensorCtrl SetShowValueMode
        Sets the show value mode used for drawing tensor values in the graphics area.
        poITensorCtrl SetTensorFormat
        Sets the tensor format.
        poITensorCtrl SetTextColor
        Sets the tensor plot text color.
        poITensorCtrl SetThresholdMax
        Sets the maximum threshold.
        poITensorCtrl SetThresholdMaxEnableState
        Sets the enable/disable state of the maximum threshold.
        poITensorCtrl SetThresholdMin
        Sets the minimum threshold.
        poITensorCtrl SetThresholdMinEnableState
        Sets the enable/disable state of the minimum threshold.
      - poITensorDefine Class
      - poITextAttribute Class
      - poITracingCtrl Class
      - poITrackingSystem Class
      - poIVectorCtrl Class
      - poIVectorDefine Class
    - HyperGraph 2D
    - HyperGraph 3D
    - MediaView
    - TextView
    - HgTrans
    - TableView
    - Postquery Commands
    - Context Commands
    - Framework Commands
- 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
- 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.

poITensorCtrl GetAverageEnabled

Gets the averaging state.

Syntax

poITensorCtrl_handle GetAverageEnabled

Application

HyperView Tcl Query

Description

This command returns the averaging state.

Errors

Returns 0 if successful, otherwise an error code.