HyperWorks Desktop

2021.2

Home
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
HyperWorks Desktop
Tcl/Tk Commands
The HyperWorks Desktop 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 HyperWorks Desktop applications.
HyperView
poIResultMathCtrl Class

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Desktop Reference Guides

2021.2

HyperWorks Desktop

What's New
View new features for HyperWorks Desktop 2021.2.
Get Started
Learn the basics and discover the workspace.
Tutorials
Discover HyperWorks Desktop functionality with interactive tutorials.
Startup Procedures and Customizations
Start HyperWorks Desktop and configure the applications.
Manage Files and Data
Create, open, import, and save models.
Display Controls
Control the view and display of your model in the modeling window.
Session Navigation
Use the Session Browser to view the current session and all the pages and windows it contains in a hierarchical display.
Publish Sessions
Publish your HyperWorks Desktop session to HTML, PowerPoint, or Report files.
Parameterize Report Templates
Use the Parameters Browser to parameterize the contents of a session file or report template and automate a variety of analysis processes.
Workflow Automation
Automate common workflows using the Process Manager or Automate tool.
HyperWorks Collaboration Tools
Explore, organize and manage your personal data, collaborate in teams, and connect to other data sources, such as corporate PLM systems to access CAD data or publish simulation data.
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
- Extensions
  Extensions are programs integrated with HyperWorks to enhance or extend the user experience.
- HyperWorks Desktop
  - 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.
  - Tcl/Tk Commands
    The HyperWorks Desktop scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.
    - Program with HyperWorks APIs for Beginners
      APIs can be used to perform various actions in HyperWorks. For example, the AddPage API can be used to add a page within the project.
    - Object Hierarchy
      Overview of object hierarchy for HyperView, HyperGraph, HyperWorks Desktop, 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 HyperWorks Tcl/Tk Command Tutorials
      Learn more about programming with HyperWorks Tcl/Tk commands with this tutorial.
    - Tcl/Tk Commands
      Tcl/Tk classes for the following HyperWorks Desktop applications.
      - HyperWorks Desktop
      - MotionView
      - HyperView
        
        Hotspot Finder API Structure
        
        Upfront Data Loader 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
        
        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
        
        poIResultMathCtrl AddExpression
        Adds a new result math expression.
        
        poIResultMathCtrl AddResource
        Adds an external resource file to the current model.
        
        poIResultMathCtrl Commit
        Commits the result math expression to the data base to create a new user-defined data type.
        
        poIResultMathCtrl GetAlias
        Gets the alias string for the passed string.
        
        poIResultMathCtrl GetEquation
        Gets the result math equation string.
        
        poIResultMathCtrl GetEquationModeList
        Gets a list of possible modes which can be used with the GetEquation command.
        
        poIResultMathCtrl GetExpressionHandle
        Gets a handle to the result math expression.
        
        poIResultMathCtrl GetExpressionList
        Gets a list of result math expression IDs.
        
        poIResultMathCtrl GetID
        Gets the ID of the result math expression.
        
        poIResultMathCtrl GetLabel
        Gets the label of the result math expression.
        
        poIResultMathCtrl GetLibraryList
        Gets a list of result math libraries.
        
        poIResultMathCtrl GetNumResultMathResources
        Gets the number of additional result files that were loaded while using the Result Module to load models into HyperView.
        
        poIResultMathCtrl GetOperatorArgumentCount
        Gets the number of arguments for a particular result math operator.
        
        poIResultMathCtrl GetOperatorArgumentList
        Gets the argument names for a particular result math operator.
        
        poIResultMathCtrl GetOperatorDefaultArgumentSyntax
        Gets the syntax of the operator used in the expression builder when the default arguments are ignored.
        
        poIResultMathCtrl GetOperatorDescription
        Returns a brief description regarding the functionality of a result math operator.
        
        poIResultMathCtrl GetOperatorHelp
        Returns a description of a result math operator, and a brief explanation regarding the arguments and default values (if any).
        
        poIResultMathCtrl GetOperatorList
        Gets a list of operators for a particular library.
        
        poIResultMathCtrl GetOperatorSyntax
        Returns the syntax of the operator as used in the Expression Builder.
        
        poIResultMathCtrl GetResourceFilePath
        Gets the file path of an external result math resource.
        
        poIResultMathCtrl GetResourceLabel
        Gets the resource file name corresponding to a particular subcase ID.
        
        poIResultMathCtrl GetResourceList
        Gets a list of result math resources.
        
        poIResultMathCtrl GetResultMathResourceFileName
        Gets the file name corresponding to the index of the additional result file.
        
        poIResultMathCtrl GetSimulationLabel
        Gets the label of a particular simulation.
        
        poIResultMathCtrl GetSimulationList
        Gets the list of simulations for a subcase.
        
        poIResultMathCtrl GetSubcaseLabel
        Gets the label of a subcase.
        
        poIResultMathCtrl GetSubcaseList
        Gets a list of resources which contain the specified table name.
        
        poIResultMathCtrl GetTableComponentList
        Gets the components associated with a table.
        
        poIResultMathCtrl GetTableInfoList
        Gets the format and binding information of a table.
        
        poIResultMathCtrl GetTableLayerList
        Gets the layer list associated with a table.
        
        poIResultMathCtrl GetTableList
        Gets the list of tables from all resources.
        
        poIResultMathCtrl GetTableResourceList
        Gets a list of resources which contain the specified table name.
        
        poIResultMathCtrl RemoveExpression
        Removes an existing result math expression.
        
        poIResultMathCtrl SetEquation
        Sets the result math equation string.
        
        poIResultMathCtrl SetLabel
        Sets the label of the result math expression.
        
        poIResultMathCtrl SetSubcase
        Sets the subcase ID in which the user-defined data type will be created.
        
        poIScalarDefine Class
        
        poIScaleCtrl Class
        
        poISCL Class
        
        poISection Class
        
        poISelectionSet Class
        
        poIStressLinearizationCtrl Class
        
        poISubcase Class
        
        poISweepCtrl Class
        
        poISymmetry Class
        
        poISystem Class
        
        poISystemCtrl Class
        
        poITensorCtrl Class
        
        poITensorDefine Class
        
        poITextAttribute Class
        
        poITracingCtrl Class
        
        poITrackingSystem Class
        
        poIVectorCtrl Class
        
        poIVectorDefine Class
      - HyperGraph 2D
      - HyperGraph 3D
      - MediaView
      - TextView
      - HgTrans
      - TableView
  - 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.
  - HyperWorks Record and Playback
    Record playback workflows in HyperView.
- HyperWorks Report
- 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.

View All Altair Simulation Help

HyperWorks Desktop

2021.2

Home
HyperWorks Desktop Reference Guides
Overview of external readers and the Altair Binary Format, the generic ASCII reader, running HyperWorks in batch mode, using Tcl/Tk commands, translators, and result math.
HyperWorks Desktop
Tcl/Tk Commands
The HyperWorks Desktop 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 HyperWorks Desktop applications.
HyperView
poIResultMathCtrl Class

What's New
Get Started
Tutorials
Startup Procedures and Customizations
Manage Files and Data
Display Controls
Session Navigation
Publish Sessions
Parameterize Report Templates
Workflow Automation
HyperWorks Collaboration Tools
HyperWorks Desktop Reference Guides

poIResultMathCtrl Class

Note: See the HyperWorks Result Math topic in the HyperView User's Guide for additional information.

poIResultMathCtrl AddExpression
Adds a new result math expression.
poIResultMathCtrl AddResource
Adds an external resource file to the current model.
poIResultMathCtrl Commit
Commits the result math expression to the data base to create a new user-defined data type.
poIResultMathCtrl GetAlias
Gets the alias string for the passed string.
poIResultMathCtrl GetEquation
Gets the result math equation string.
poIResultMathCtrl GetEquationModeList
Gets a list of possible modes which can be used with the GetEquation command.
poIResultMathCtrl GetExpressionHandle
Gets a handle to the result math expression.
poIResultMathCtrl GetExpressionList
Gets a list of result math expression IDs.
poIResultMathCtrl GetID
Gets the ID of the result math expression.
poIResultMathCtrl GetLabel
Gets the label of the result math expression.
poIResultMathCtrl GetLibraryList
Gets a list of result math libraries.
poIResultMathCtrl GetNumResultMathResources
Gets the number of additional result files that were loaded while using the Result Module to load models into HyperView.
poIResultMathCtrl GetOperatorArgumentCount
Gets the number of arguments for a particular result math operator.
poIResultMathCtrl GetOperatorArgumentList
Gets the argument names for a particular result math operator.
poIResultMathCtrl GetOperatorDefaultArgumentSyntax
Gets the syntax of the operator used in the expression builder when the default arguments are ignored.
poIResultMathCtrl GetOperatorDescription
Returns a brief description regarding the functionality of a result math operator.
poIResultMathCtrl GetOperatorHelp
Returns a description of a result math operator, and a brief explanation regarding the arguments and default values (if any).
poIResultMathCtrl GetOperatorList
Gets a list of operators for a particular library.
poIResultMathCtrl GetOperatorSyntax
Returns the syntax of the operator as used in the Expression Builder.
poIResultMathCtrl GetResourceFilePath
Gets the file path of an external result math resource.
poIResultMathCtrl GetResourceLabel
Gets the resource file name corresponding to a particular subcase ID.
poIResultMathCtrl GetResourceList
Gets a list of result math resources.
poIResultMathCtrl GetResultMathResourceFileName
Gets the file name corresponding to the index of the additional result file.
poIResultMathCtrl GetSimulationLabel
Gets the label of a particular simulation.
poIResultMathCtrl GetSimulationList
Gets the list of simulations for a subcase.
poIResultMathCtrl GetSubcaseLabel
Gets the label of a subcase.
poIResultMathCtrl GetSubcaseList
Gets a list of resources which contain the specified table name.
poIResultMathCtrl GetTableComponentList
Gets the components associated with a table.
poIResultMathCtrl GetTableInfoList
Gets the format and binding information of a table.
poIResultMathCtrl GetTableLayerList
Gets the layer list associated with a table.
poIResultMathCtrl GetTableList
Gets the list of tables from all resources.
poIResultMathCtrl GetTableResourceList
Gets a list of resources which contain the specified table name.
poIResultMathCtrl RemoveExpression
Removes an existing result math expression.
poIResultMathCtrl SetEquation
Sets the result math equation string.
poIResultMathCtrl SetLabel
Sets the label of the result math expression.
poIResultMathCtrl SetSubcase
Sets the subcase ID in which the user-defined data type will be created.

(c) 2021. Altair Engineering Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support