API, Reference Guides

2023.1

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.
HWC Console
Record playback workflows in the application.
HWC Commands
result
Result loading.
result vector
Create and manage vector plots.

What's New
Get Started
Tutorials
API, Reference Guides

2023.1

API, Reference Guides

What's New
View new features for version 2023.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 HyperView and HyperGraph.
- 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.
  - Introduction
  - Work with the HWC Console
  - Interactive Help/Intellisense
  - HWC Console Command Syntax
  - Record Views
  - Command Files
  - Execute HWC Files
  - HWC and Tcl
  - Error Messages
  - HWC Commands
    - animate
      Animation controls.
    - annotation
      Annotation controls.
    - attribute
      Set entity attributes.
    - color
      Set the entity's color.
    - config
      Configuration options.
    - delete
      Delete content from the application.
    - explode
      Explode a model or selected components for improved visualization.
    - hide
      Hides all or a subset of entity types in the model.
    - hwd
      HyperWorks Desktop commands.
    - kpi hotspot
      Hotspot finder commands.
    - mark
      Marks entities on the active model.
    - open
      Open files.
    - report
      Report commands.
    - result - HyperView - MultiCore
      Result loading.
    - result
      Result loading.
      - result applycurrent
        Resets the legend for contour, vector, tensor, and iso based on the currently displayed parts.
      - result fileset
        Create and manage file sets for derived loadcases.
      - result iso
        Create and manage iso plots.
      - result loadcase
        Create and manage loadcases for derived loadcases.
      - result scalar
        Create and manage the contour plot.
      - result simulation
        Set the current simulation.
      - result subcase
        Makes a subcase current.
      - result tensor
        Create and manage tensor plots.
      - result vector
        Create and manage vector plots.
        
        clear
        Clears the vector plot.
        
        color
        Changes the vector color for the components or resultant by direction or value.
        
        display
        Changes the value display.
        
        hide
        Clears the vector plot from the modeling window.
        
        legend
        Edits the vector plot legend properties.
        
        legendmax
        Defines the legend's maximum value.
        
        legendmaxenabled
        Enables the legend's maximum value.
        
        legendmin
        Defines the legend's minimum value.
        
        legendminenabled
        Enables the legend's minimum value.
        
        load
        Loads and plots the vector data type.
        
        multiplier
        The multiplier for scaling all the result values.
        
        section
        Vector plot section options.
        
        show
        Displays the current vector plot in the modeling window.
    - save
      Save session content.
    - scale
      Specify parameters for deformation display.
    - section
      Section cut.
    - show
      Shows all or a subset of entity types in the model.
    - sset
      Modify entities in a selection set.
    - system
      Define a coordinate system.
    - tracking system
      Tracking system commands.
    - tracing
      Use tracing commands to trace system, component, and node entities during animation.
    - view
      View manipulation.
    - xy
      Perform actions on XY plot files.
- HyperMesh 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 HyperWorks Help

API, Reference Guides

2023.1

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.
HWC Console
Record playback workflows in the application.
HWC Commands
result
Result loading.
result vector
Create and manage vector plots.

What's New
Get Started
Tutorials
API, Reference Guides

result vector

Create and manage vector plots.

Syntax

result vector argument ?argument? ?argument? <name1>=<value1>

result vector clear
Clears the vector plot.
result vector color
Changes the vector color for the components or resultant by direction or value.
result vector display
Changes the value display.
result vector hide
Clears the vector plot from the modeling window.
result vector legend
Edits the vector plot legend properties.
result vector legendmax
Defines the legend's maximum value.
result vector legendmaxenabled
Enables the legend's maximum value.
result vector legendmin
Defines the legend's minimum value.
result vector legendminenabled
Enables the legend's minimum value.
result vector load
Loads and plots the vector data type.
result vector multiplier
The multiplier for scaling all the result values.
result vector section
Vector plot section options.
result vector show
Displays the current vector plot in the modeling window.

© 2023 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent