Jump to main content
Altair® HyperWorks® API, Reference Guides 2025.1
Altair® HyperWorks® API, Reference Guides 2025.1

2025.1
Index
  1. Home
  2. 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.

  3. Tcl/Tk Commands

    The application's scripting interface is a set of Tcl/Tk commands that follow a simple and consistent syntax.

  4. Tcl/Tk Commands

    Tcl/Tk classes for the following Altair HyperWorks applications.

  5. HyperView

  6. poICFD Class

  • Welcome
  • What's New

    View new features for version 2025.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 AddRake

              Adds a new rake to the CFD Plot/Streamlines panel.

            • poICFD CreateStreamLines

              Creates streamlines for the specified rakes based on the current settings in the CFD Plot/Streamlines panel.

            • poICFD DeleteRake

              Deletes the specified rake from the CFD Plot/Streamlines panel.

            • poICFD DeleteStreamLines

              Deletes the streamlines for the rakes specified in the CFD Plot/Streamlines panel.

            • poICFD GetDataType

              Returns the data type that was used for the streamline creation in the CFD Plot/Streamlines panel.

            • poICFD GetIntegrationMethod

              Returns the integration method that was used for the streamline creation in the CFD Plot/Streamlines panel.

            • poICFD GetMaxBreakAngle

              Returns the threshold value for the break angle between two neighboring streamline segments, which is used to decide if the two line segments should be merged into one, or kept untouched.

            • poICFD GetMaxStepLength

              Returns the maximum integration step length in the CFD Plot/Streamlines panel.

            • poICFD GetNumOfStreamLineColors

              Returns the number of colors in the color map that were used to color the individual streamlines in the CFD Plot/Streamlines panel (when the 'color-by mode' is set to "seed").

            • poICFD GetRakeHandle

              Returns the handle of the rake specified by the rake_id.

            • poICFD GetRakeList

              Returns a list of rake IDs from the CFD Plot/Streamlines panel.

            • poICFD GetStreamLineColoredByMode

              Returns the 'colored-by mode' of the streamlines in the CFD Plot/Streamlines panel.

            • poICFD GetStreamLineDecimation

              Returns whether decimation is being applied to streamlines in the CFD Plot/Streamlines panel, in order to reduce the memory footprint.

            • poICFD GetStreamLineSize

              Returns the size of the streamlines in the CFD Plot/Streamlines panel.

            • poICFD GetStreamLineStyle

              Returns the style of the streamlines in the CFD Plot/Streamlines panel.

            • poICFD SetDataType

              Sets the data type used for the streamline creation in the CFD Plot/Streamlines panel.

            • poICFD SetIntegrationMethod

              Specifies the integration algorithm used for the streamline creation in the CFD Plot/Streamlines panel.

            • poICFD SetMaxBreakAngle

              Specifies the threshold value for the break angle between two neighboring streamline segments, which is used to decide if the two line segments should be merged into one, or kept untouched.

            • poICFD SetMaxStepLength

              Specifies the maximum integration step length in the CFD Plot/Streamlines panel.

            • poICFD SetNumOfStreamLineColors

              Specifies the number of colors in the color map used to color the individual streamlines in the CFD Plot/Streamlines panel (when the 'color-by mode' is set to "seed").

            • poICFD SetStreamLineColoredByMode

              Specifies the 'colored-by mode' of the streamlines in the CFD Plot/Streamlines panel.

            • poICFD SetStreamLineDecimation

              Specifies whether decimation should be applied to the streamlines in the CFD Plot/Streamlines panel, in order to reduce the memory footprint.

            • poICFD SetStreamLineSize

              Specifies the size of the streamlines in the CFD Plot/Streamlines panel.

            • poICFD SetStreamLineStyle

              Specifies the style of the streamlines in the CFD Plot/Streamlines panel.

            • poICFD SetTerminationCriterion

              Specifies the criterion for integration termination in the streamline creation in the CFD Plot/Streamlines panel.

          • 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

          • 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.

View All Altair HyperWorks Help

poICFD Class

Note: See the CFD Post-Processing and Streamlines topics in the HyperView User's Guide for additional information.
  • poICFD AddRake
    Adds a new rake to the CFD Plot/Streamlines panel.
  • poICFD CreateStreamLines
    Creates streamlines for the specified rakes based on the current settings in the CFD Plot/Streamlines panel.
  • poICFD DeleteRake
    Deletes the specified rake from the CFD Plot/Streamlines panel.
  • poICFD DeleteStreamLines
    Deletes the streamlines for the rakes specified in the CFD Plot/Streamlines panel.
  • poICFD GetDataType
    Returns the data type that was used for the streamline creation in the CFD Plot/Streamlines panel.
  • poICFD GetIntegrationMethod
    Returns the integration method that was used for the streamline creation in the CFD Plot/Streamlines panel.
  • poICFD GetMaxBreakAngle
    Returns the threshold value for the break angle between two neighboring streamline segments, which is used to decide if the two line segments should be merged into one, or kept untouched.
  • poICFD GetMaxStepLength
    Returns the maximum integration step length in the CFD Plot/Streamlines panel.
  • poICFD GetNumOfStreamLineColors
    Returns the number of colors in the color map that were used to color the individual streamlines in the CFD Plot/Streamlines panel (when the 'color-by mode' is set to "seed").
  • poICFD GetRakeHandle
    Returns the handle of the rake specified by the rake_id.
  • poICFD GetRakeList
    Returns a list of rake IDs from the CFD Plot/Streamlines panel.
  • poICFD GetStreamLineColoredByMode
    Returns the 'colored-by mode' of the streamlines in the CFD Plot/Streamlines panel.
  • poICFD GetStreamLineDecimation
    Returns whether decimation is being applied to streamlines in the CFD Plot/Streamlines panel, in order to reduce the memory footprint.
  • poICFD GetStreamLineSize
    Returns the size of the streamlines in the CFD Plot/Streamlines panel.
  • poICFD GetStreamLineStyle
    Returns the style of the streamlines in the CFD Plot/Streamlines panel.
  • poICFD SetDataType
    Sets the data type used for the streamline creation in the CFD Plot/Streamlines panel.
  • poICFD SetIntegrationMethod
    Specifies the integration algorithm used for the streamline creation in the CFD Plot/Streamlines panel.
  • poICFD SetMaxBreakAngle
    Specifies the threshold value for the break angle between two neighboring streamline segments, which is used to decide if the two line segments should be merged into one, or kept untouched.
  • poICFD SetMaxStepLength
    Specifies the maximum integration step length in the CFD Plot/Streamlines panel.
  • poICFD SetNumOfStreamLineColors
    Specifies the number of colors in the color map used to color the individual streamlines in the CFD Plot/Streamlines panel (when the 'color-by mode' is set to "seed").
  • poICFD SetStreamLineColoredByMode
    Specifies the 'colored-by mode' of the streamlines in the CFD Plot/Streamlines panel.
  • poICFD SetStreamLineDecimation
    Specifies whether decimation should be applied to the streamlines in the CFD Plot/Streamlines panel, in order to reduce the memory footprint.
  • poICFD SetStreamLineSize
    Specifies the size of the streamlines in the CFD Plot/Streamlines panel.
  • poICFD SetStreamLineStyle
    Specifies the style of the streamlines in the CFD Plot/Streamlines panel.
  • poICFD SetTerminationCriterion
    Specifies the criterion for integration termination in the streamline creation in the CFD Plot/Streamlines panel.

© 2025 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent