HyperWorks Desktop

2021

Home
Startup Procedures and Customizations
Start HyperWorks Desktop and configure the applications.
Customization
There are various types of startup customizations that are possible for HyperWorks Desktop. These items define how the application looks or behaves at product startup.
Session Files
A session file is an ASCII text file that contains a structured list of session statements.
Session File Statements
*EndSelectionInfo()
Marks the end of a session block that contains the results to be contoured.

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

HyperWorks Desktop

What's New
View new features for HyperWorks Desktop 2021.
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.
- Start HyperWorks Desktop Applications
  Learn how to start HyperWorks Desktop applications on Windows and Linux.
- Start HyperMesh Batch
  HyperMesh Batch is a non-graphical version of HyperMesh that can be used to run command files or Tcl scripts in batch mode.
- Start-in Directory
  The start-in directory is the location from which the HyperWorks Desktop application is launched.
- Settings Files
  HyperWorks Desktop writes several different settings files.
- Customization
  There are various types of startup customizations that are possible for HyperWorks Desktop. These items define how the application looks or behaves at product startup.
  - hmcustom.tcl
    HyperMesh allows you to create a script file named hmcustom.tcl that can be used to automatically execute a series of commands or to define custom settings during startup.
  - Environment Variables
    Environment variables can be defined to configure various aspects of HyperWorks Desktop.
  - hm.cfg
  - Preference Files
    A preference file is an ASCII file that configures the application or its clients. It specifies default user settings, such as the order in which colors are assigned, the default printer and default page layout.
  - Session Files
    A session file is an ASCII text file that contains a structured list of session statements.
    - Session File Structure
      Session files always begins with the *Id() statement which is followed by statements grouped in blocks.
    - Session File Loading
      When a session is saved, filenames are stored as Templex variables. When a session file is loaded, the program checks for Templex statements in the session file.
    - Session File Sample
    - Session File Statements
      - 126 more
      - Session File Syntax
        Every statement in a session begins with an asterisk, *. Lines without asterisks are treated as comments.
      - Shared Session File Statements
      - HyperGraph Session File Statements
      - HyperView Session File Statements
      - MediaView Session File Statements
      - MotionView Session File Statements
      - TextView Session File Statements
      - *ActionType()
        Indicates the type of curve edit.
      - *Active()
        Specifies whether or not Axisymmetry is active.
      - *Add()
        Indicates a selection rule associated with a selection set.
      - *AddGroup()
        Specifies a group to which a list of components can be added.
      - *AddObject()
        Specifies the real component image to attach to a part or marker.
      - *AddPrim()
        Adds a primitive to a collision set's primitive list.
      - *AddSource()
        Specifies the source name and path of the result template used for result math analysis.
      - *Alignment()
        Specifies the paragraph alignment of note text.
      - *AlignmentPoint()
        Specifies the paragraph alignment of note text.
      - *Alpha()
        Specifies the transparency of a material.
      - *Ambient()
        Specifies the red, green, and blue values for the ambient light component of a material.
      - *AnchorToScreen()
        Fixes the position of the note(s) displayed in the graphics window while the model is animating.
      - *AnimationEvent()
        Sets the animation action to be performed on a violation.
      - *AnimationNote()
        Adds a single line of text to the time/frame display in the animation and video windows.
      - *AnimationStopEvent()
        Sets the animation action that needs to be performed on the collision.
      - *AnimMode()
        Indicates whether the system is in interpolation mode or transient mode. If in interpolation mode, the simulation index is denoted.
      - *AnnotationFlags()
        Determines if an attribute is displayed in the measure annotation on the screen.
      - *AppendSimulation()
        Captures the subcase id, simulation index, and the scale factor for the created loadcase.
      - *Attach() - HyperGraph
        Specifies the type of attachment for a note in the plot window.
      - *Attach() - HyperView
        Specifies the entity type of attachment for a note in HyperView.
      - *Attribute() - Add Object Panel
        Specifies the display attributes setting for the added part.
      - *Attribute() - HyperGraph
        Attaches data attributes to a vector or curve.
      - *Attribute() - Measures Panel
        Indicates the display attributes of the created measure.
      - *AutoFit()
        Locks the axis so that it will not change if new curves are added.
      - *AutoHide()
        Hides a feature in the graphics window when the model is rotated over it.
      - *AutoPosition()
        It is a session file (.mvw) session statement and report definition file (.tpl) statement in the *BeginLegend() and *BeginNote()blocks.
      - *Autoscale()
        Automatically determines the minimum and maximum value for the specified axis.
      - *AverageAtNode()
        Specifies the nodal average enabled state.
      - *AverageColor()
        Indicates if the average color mode on the model is enabled.
      - *AveragingMethod()
        Indicates the nodal averaging method used on elemental results.
      - *Axis()
        Specifies the axis of Axisymmetry for the model.
      - *AxisIndex()
        Specifies the axis to which a vector belongs or the axis to which a datum line is attached.
      - *BackgroundColor()
        Specifies the background color for TextView or HyperGraph.
      - *BackGroundColor() - HyperView
        Specifies the color to be used as the legend background.
      - *Bar()
        Defines the state, pattern, and color attributes for a bar curve.
      - *BarChartStyle()
        Specifies the styles of the bar chart curves.
      - *Base()
        Indicates the base node selection on the section cut.
      - *BaseTime()
        Specifies the time frame at which the streamlines are created.
      - *BeginAddedObjects()
        Indicates the beginning of an add objects block.
      - *BeginAxis()
        Indicates the beginning of an axis block.
      - *BeginAxisymmetry()
        Indicates the beginning of an axisymmetry block.
      - *BeginCFD()
        Specifies the start of the CFD block used to capture the settings with the CFD feature.
      - *BeginCollision()
        Indicates the beginning of a collision block.
      - *BeginCollisionSet()
        This command has been replaced by *BeginCollision().
      - *BeginContour()
        Indicates the beginning of a contour block. This block captures your selections from the Contour panel in HyperView.
      - *BeginContourPlotViewSettings()
        Contains a list of contour plot view settings including the legend settings.
      - *BeginCurve()
        Indicates the beginning of a curve block.
      - *BeginCurveEdit()
        Indicates the beginning of a curve edit block.
      - *BeginData()
        Indicates the beginning of a data block for a vector.
      - *BeginDatumLine()
        Indicates the beginning of a datum line block.
      - *BeginDefinitions()
        Indicates the beginning of a definition block.
      - *BeginDeformed()
        Indicates the beginning of a deformed block.
      - *BeginDerivedSubcase()
        Captures the settings applied to the newly created loadcase using the Utilities menu option.
      - *BeginExplosion()
        Indicates the beginning of an explosion block.
      - *BeginExpression()
        Indicates the beginning of a user defined expression block.
      - *BeginExtractData()
        Indicates the beginning of the Extract data and Linearization block.
      - *BeginFLC()
        Indicates the beginning of the forming limit curve settings.
      - *BeginFLD()
        Indicates the beginning of an FLD block.
      - *BeginFooter()
        Indicates the beginning of a footer block in a plot.
      - *BeginGraphic()
        Indicates the beginning of a graphic block.
      - *BeginGroup()
        Indicates the beginning of a group block.
      - *BeginHeader()
        Indicates the beginning of a header block in a plot.
      - *BeginIsoPlotViewSettings()
        Contains a list of iso plot view settings.
      - *BeginIsoValue()
        Indicates the beginning of an iso value block.
      - *BeginLegend() - HyperGraph
        Indicates the beginning of a legend block in a plot block.
      - *BeginLegend() - HyperView
        Indicates the start of the legend block in HyperView.
      - *BeginLine()
        Indicates the beginning of a line tracing block. This block captures your selections for line tracing on the Tracing panel in HyperView.
      - *BeginMask()
        Indicates the beginning of a mask block.
      - *BeginMaterial()
        Indicates the beginning of a material block.
      - *BeginMdl()
        Indicates the beginning of an MDL block.
      - *BeginMeasures()
        Indicates the start of a group of measure statements in an animation window.
      - *BeginMeasures()
        Indicates the start of a measure block created from the Measure panel in HyperView.
      - *BeginModel()
        Indicates the beginning of a model block.
      - *BeginModel() - Add Object Panel
        Indicates the beginning of the added model information.
      - *BeginNote()
        Indicates the beginning of a note block.
      - *BeginNote() - HyperView
        Indicates the beginning of a note block.
      - *BeginPage()
        Indicates the beginning of a page block.
      - *BeginPalette()
        Indicates the beginning of a material palette.
      - *BeginPart()
        Captures your settings for the added part.
      - *BeginPlot()
        Indicates the beginning of a plot block.
      - *BeginRake()
        Specifies the block that captures the rake information used for streamline creation.
      - *BeginResult()
        Captures the path and the reader used to load the result set.
      - *BeginResultMath()
        Indicates the beginning of a result math plot block.
      - *BeginSavedView()
        Indicates the beginning of a saved view block.
      - *BeginScalarDefine()
        Indicates the beginning of a scalar definition block. This block captures your selections from a scalar definition created in HyperView.
      - *BeginSCL()
        Indicates the beginning of a Stress Characterization Line (SCL) block.
      - *BeginSectionCut()
        Denotes the beginning of the list of section cuts for a graphic window when using an MBD file.
      - *BeginSectionCut() - HyperView
        Indicates the beginning of a section cut block.
      - *BeginSelection()
        Indicates a selection set is based on the selection of a group of entities, such as parts, elements, nodes, or a group of systems.
      - *BeginStatsTemplates()
        Indicates the beginning of a statistics template block.
      - *BeginStudy()
        Indicates the beginning of a study case.
      - *BeginSymmetry()
        Indicates the beginning of a Symmetry block.
      - *BeginTemplate()
        Indicates the beginning of a template block.
      - *BeginTensor()
        Indicates the beginning of a tensor block.
      - *BeginTensorDefine()
        Indicates the beginning of a tensor definition block. This block captures your selections from a tensor definition created in HyperView.
      - *BeginTensorPlotViewSettings()
        Contains a list of tensor plot view settings including the legend settings.
      - *BeginTextEditor()
        Indicates the beginning of a text editor block in a window block.
      - *BeginTracing()
        Indicates the beginning of a tracing block.
      - *BeginTracingNode()
        Indicates the beginning of a tracing node definition. This block captures the commands for a single node trace.
      - *BeginTracingPart()
        Indicates the beginning of a tracing node definition. This block captures the commands for a single node trace.
      - *BeginTracingSystem()
        Indicates the beginning of a tracing system definition. This block captures the commands for a single system trace.
      - *BeginTracking()
        Indicates the beginning of a tracking block.
      - *BeginVector() - HyperGraph
        Indicates the beginning of a vector block in a plot curve.
      - *BeginVector() - HyperView
        Indicates the beginning of a vector block.
      - *BeginVectorDefine()
        Indicates the beginning of a vector definition block. This block captures your selections from a vector definition created in HyperView.
      - *BeginVectorPlotViewSettings()
        Contains a list of vector plot view settings including the legend settings.
      - *BeginVideo()
        Indicates the beginning of a video block.
      - *BeginWindow()
        Indicates the beginning of a window block.
      - *BorderColor()
        Specifies the color of the thin border surrounding a plot.
      - *BorderWidth()
        Specifes the border width surrounding a note.
      - *Category()
        Sets the name of a bar column (a.k.a. category) along the Categories axis. Subsequent *Category() statements define the other category names.
      - *ClipElements()
        Specifies whether or not the elements should be clipped on a section cut.
      - *ClippingRegion()
        Specifies the view boundaries of a graphics window.
      - *ClippingRegion() - HyperView
        Specifies the clipping region for a saved view.
      - *Color() - HyperGraph
        Specifes the color of a plot entity or a datum line.
      - *Color() - MediaView
        Determines the color of the measure when drawn.
      - *Color() - Notes
        Specifies the font color of a note.
      - *Color() - Section Cut
        Indicates the section cut color.
      - *ColorMode()
        Indicates if the tensor or vector result should be displayed using a legend or by the direction of Sxx, Syy, and Szz using the colors you select.
      - *ColorRGB()
        Indicates the RGB values of the contour legend colors.
      - *ColorStreamlines()
        Specifies the coloring mode of the streamlines in the CFD/Streamlines panel.
      - *ComplexAnimFilter()
        Sets the complex animation filter.
      - *ComplexFilter()
        Indicates the complex filter used to display the complex results.
      - *Component()
        Specifies a component of a request from a data file for a vector in a plot curve.
      - *Compression()
        Indicates the settings for the compression line used in the FLD analysis.
      - *Connection()
        Used to establish a live link between a measure and a plot curve. A master/slave relationship is created be the two entities. The measure is the master and the slave is the child. Update events are passed from the master to the slave as needed; this is what makes it a live link.
      - *CoordsAttachment() - HyperGraph
        Specifies the attachment point for a note.
      - *CoordsAttachment() - HyperView
        Specifies the position of a point in space to which an animation window note is attached.
      - *CornerDataRequested()
        Indicates if the Use corner data option is enabled to calculate the results.
      - *CreateCurve()
        Includes a curve in a macro.
      - *CreateNote()
        Includes a curve in a macro.
      - *CurrentModel()
        Selects a model in the current animation window for all model-specific operations.
      - *CurrentResults()
        Keeps track of live and current plotted result definitions
      - *CurrentSubcase()
        Captures the subcase id only for the transient analysis type and the simulation index for modal or linear static analysis types.
      - *CurrentTimeStep()
        Specifies the timestep displayed in the windows on a page.
      - *CurveAttachment()
        Specifies the data point to which a note is attached.
      - *CurveInTipTail()
        Indicates if the curve is included in the calculation and drawing of a TipToTail curve.
      - *CurvePoint()
        Specifies a single data point for a vector in a *BeginData() block.
      - *CurveSource()
        Indicates the curve source type used to create the FLC.
      - *CustomFeatureAngle()
        Sets a custom feature angle for a part.
      - *DataComponent()
        Indicates the data component selected for a given result type.
      - *DataType()
        Specifies the type of data to use from a data source file for a vector in a plot curve.
      - *DataType() - HyperView
        Indicates the data type used for extract data and linearization.
      - *DefinePlotMacro()
        Begins a plot macro definition block.
      - *DeformedModal()
        Applies a magnification factor to displacement results in the modal animation mode.
      - *DeformedOptions()
        Contains undeformed model graphic settings that apply to all graphic windows.
      - *DeformedTime()
        Indicates the time step value for a deformed section cut.
      - *DeformedTransient()
        Applies a magnification factor to displacement results in the transient animation mode.
      - *Diffuse()
        Specifies the red, green, and blue values for the diffuse light component of a material.
      - *DiscreteColor()
        Indicates if the discrete color mode on the model is enabled.
      - *Displacement()
        Used to contour displaced components.
      - *DisplayMode()
        Indicates the display mode criteria for selecting how model elements are displayed.
      - *DisplayOptions()
        Enables or disables the display of various graphics features.
      - *Dof()
        Indicates the degrees of freedom associated with a tracking system.
      - *DrawComponents()
        Indicates the display options for the components selected for the vector plot.
      - *DrawFromValues()
        Specifies the drawing state of the vector values.
      - *DrawPosition()
        Specifies the drawing position of the vectors on the rake lines.
      - *DrawPrefix() - Tensor Panel
        Specifies the drawing state of the tensor prefixes for the Normal and Shear tensors.
      - *DrawPrefix() - Vector Panel
        Specifies the drawing state of the vector prefixes.
      - *DrawValues()
        Specifies the drawing state of the tensor values for the Normal and Shear tensors.
      - *Edges()
        Turns edge lines on or off for models with section cuts.
      - *ElemAttachment()
        Specifies the element, element dimension, and model containing the element to which an animation window note is attached.
      - *ElementalResult()
        Indicates the ply and element results to be contoured.
      - *ElementContour()
        Indicates whether the contour should be generated per node or per element.
      - *ElementLocator() - Components
        This command is used to locate an element in the model.
      - *ElementSelection()
        Indicates the components of the element result to be contoured.
      - *Emission()
        Specifies the red, green, and blue values for the emitted light component of a material.
      - *EndAddedObjects()
        Specifies the end of the add objects block.
      - *EndAxis()
        Indicates the end of an axis block.
      - *EndAxisymmetry()
        Indicates the end of an axisymmetry block.
      - *EndCFD()
        Specifies the end of the CFD definition block.
      - *EndCollision()
        Specifies the end of the collision block.
      - *EndCollisionSet()
        This command has been replaced by *EndCollision().
      - *EndContour()
        Specifies the end of the contour block.
      - *EndContourPlotViewSettings()
        Specifies the end of the contour plot view settings.
      - *EndCurve()
        Indicates the end of a curve block.
      - *EndCurveEdit()
        Indicates the end of a curve edit block.
      - *EndData()
        Indicates the end of a data block.
      - *EndDatumLine()
        Indicates the end of a datum line block.
      - *EndDefinitions()
        Indicates the end of a definition block.
      - *EndDeformed()
        Specifies the end of the deformed block.
      - *EndDerivedSubcase()
        Specifies the end of the derived subcase block.
      - *EndExplosion()
        Specifies the end of the explosion block.
      - *EndExtractData()
        Indicates the end of the Extract Data and Linearization block.
      - *EndExpression()
        Indicates the end of a user defined expression block.
      - *EndFLC()
        Specifies the end of the FLC block.
      - *EndFLD()
        Specifies the end of the FLD block.
      - *EndFooter()
        Indicates the end of a footer block.
      - *EndGraphic()
        Indicates the end of a graphic block.
      - *EndGroup()
        Specifies the end of the group block.
      - *EndHeader()
        Indicates the end of a header block in a plot.
      - *EndIndex()
        The index of the last data point to be read from the specified file.
      - *EndIsoPlotViewSettings()
        Specifies the end of the iso plot view settings.
      - *EndIsoValue()
        Specifies the end of an iso value block.
      - *EndLegend() - HyperGraph
        Indicates the end of a legend block in a plot block.
      - *EndLegend() - HyperView
        Specifies the end of a legend block.
      - *EndLine()
        Specifies the end of the line block.
      - *EndMask()
        Specifies the end of the mask block.
      - *EndMaterial()
        Indicates the end of a material block.
      - *EndMdl()
        Indicates the end of an MDL block.
      - *EndMeasures()
        Indicates the end of a group of measure statements in the animation window.
      - *EndMeasures()
        Specifies the end of the measure block.
      - *EndModel()
        Indicates the end of a model block.
      - *EndModel() - Add Objects Panel
        Specifies the end of the model block.
      - *EndNote()
        Indicates the end of a note block.
      - *EndNote() - HyperView
        Specifies the end of a note block.
      - *EndPage()
        Indicates the end of a page block.
      - *EndPalette()
        Indicates the end of a material palette.
      - *EndPlot()
        Indicates the end of a plot block.
      - *Endpoints()
        Specifies the pixel locations relative to the bottom left corner of the video or image.
      - *EndRake()
        Specifies the end of the rake definition block.
      - *EndResult()
        Specifies the end of the begin result block.
      - *EndResultMath()
        Indicates the end of a result math plot block.
      - *EndSavedView()
        Indicates the end of a saved view block.
      - *EndSCL()
        Indicates the end of a Stress Characterization Line (SCL) block.
      - *EndScalarDefine()
        Specifies the end of the scalar definition block.
      - *EndSectionCut()
        Denotes the end of the list of section cuts for the animation window.
      - *EndSectionCut() - HyperView
        Specifies the end of the section cut block.
      - *EndSelection()
        Specifies the end of the selection set block.
      - *EndSelectionInfo()
        Marks the end of a session block that contains the results to be contoured.
      - *EndStatsTemplates()
        Indicates the end of a statistics template block.
      - *EndStudy()
        Specifies the end of the study block.
      - *EndSymmetry()
        Indicates the beginning of a Symmetry block.
      - *EndTemplate()
        Indicates the end of a template block.
      - *EndTensor()
        Indicates the end of a tensor block.
      - *EndTensorDefine()
        Specifies the end of the tensor definition block.
      - *EndTensorPlotViewSettings()
        Specifies the end of the tensor plot view settings.
      - *EndText()
        Indicates the end of a text block for reports and notes.
      - *EndTextEditor()
        Indicates the end of a text editor block.
      - *EndTime()
        Specifies the time at which animation ends.
      - *EndTracing()
        Specifies the end of the tracing block.
      - *EndTracingNode()
        Specifies the end of a tracing node block.
      - *EndTracingPart()
        Specifies the end of a tracing part block.
      - *EndTracingSystem()
        Specifies the end of a tracing part block.
      - *EndTracking()
        Specifies the end of the tracking block.
      - *EndVector() - HyperGraph
        Indicates the end of a vector block.
      - *EndVector() - HyperView
        Indicates the end of a vector block in HyperView.
      - *EndVectorDefine()
        Specifies the end of the vector definition block.
      - *EndVectorPlotViewSettings()
        Specifies the end of the vector plot view settings.
      - *EndVideo()
        Indicates the end of a video block.
      - *EndVideoMeasure()
        Denotes the end of a *Measure() or *MasterMeasure() block.
      - *EndWindow()
        Indicates the end of a window block.
      - *Engineering()
        Indicates if the engineering or true stress/strain is enabled.
      - *EntityColor()
        Sets the rendering color of the tracing entity described by the block.
      - *EnvelopeTracingEntity()
        Specifies the entity type used to trace the contour along the envelope in the derived loadstep.
      - *Equation()
        Specifies the fully expanded equation used in defining an expression using the GUI for a given result math analysis.
      - *EvenlyDistributed()
        Specifies whether or not the vector plot is evenly distributed on the rake lines defined on a section cut.
      - *Expression()
        Defines the mathematical expression for a vector.
      - *ExtractionOption()
        Indicates the run method used for extract data and linearization.
      - *Features()
        Turns feature lines on or off for models with section cuts.
      - *Filename()
        Specifies the relative path and filename of the source file for a vector in a plot curve or a text editor file.
      - *FillColor()
        Fills color in the area surrounding the note(s) displayed in the graphics window.
      - *FilledSolids()
        Turns solid filling on or off for models with section cuts.
      - *Filter()
        Specifies the label of the legend filter.
      - *FitCurve()
        Indicates the state of the fit curve property for the FLD analysis.
      - *Font() - HyperGraph
        Specifies the font name, weight, style, and size for plot notes, legends, and the text editor.
      - *Font() - HyperView
        Specifies the font name, weight, style, and size of the note text.
      - *Font() - MediaView
        Determines the font to be used for the measure.
      - *FooterAlignment()
        Specifies the alignment of the footer text in the plot window.
      - *FooterFont()
        Specifies the footer font.
      - *FooterText()
        Specifies the footer text in the contour legend.
      - *Force()
        Defines force attributes.
      - *Format() - MediaView
        Determines how the numeric portion of the measure annotation should be displayed.
      - *Format() - HyperGraph
        Specifies whether the values on a plot axis are expressed in scientific notation, as fixed decimal, or automatically formatted.
      - *Format() - HyperView
        Specifies the tensor format.
      - *FrameColor()
        Specifies the color of the window surrounding a plot.
      - *GenerateStreamlines()
        Specifies if the streamlines are successfully created.
      - *GlobalProperty()
        Captures the global options used while loading the model and result files.
      - *GridLineColor()
        Specifies the color of plot grid lines in a plot window.
      - *GridLineSpacing()
        Specifies the spacing of the X-axis and Y-axis between each grid line on a section cut.
      - *GridLineVisibility()
        Specifies whether or not the grid lines on a section cut are displayed.
      - *Grids()
        Specifies the number of grid lines per tic mark on a linear plot axis. Specifies the number of grid lines per decade on a log plot axis.
      - *GridTextPrecision()
        Specifies the precision of the text displayed on the grid lines of a section cut.
      - *GridTextVisibility()
        Specifies whether or not the grid line text on a section cut is displayed.
      - *HeaderAlignment()
        Specifies the alignment of the header text in the plot window.
      - *HeaderFont()
        Specifies the font type and properties for the legend header.
      - *HeaderText()
        Specifies the header text in the contour legend.
      - *HeadType()
        Specifies the drawing style of the vector plot.
      - *HighlightMode()
        Sets the highlight mode when a violation occurs.
      - *Id()
        Indicates the beginning of a session file and the release version of the program.
      - *Increment() - HyperGraph
        Specifies the tic increment for plot axes.
      - *Increment() - HyperView
        Indicates the increment for the iso value.
      - *IntegrationMethod()
        Specifies the integration method used to create streamlines in the CFD/Streamlines panel.
      - *IntegrationMode()
        Specifies if the streamlines are to be displayed downstream, upstream, or both.
      - *IntegrationStepLength()
        Specifies the value of the length used in the integration method to create streamlines in the CFD/Streamlines panel.
      - *InterpolateColor()
        Indicates if the interpolate color mode on the model is enabled.
      - *InterpolateFlag()
        Finds the values for the From and To fields in the Modify Curves panel.
      - *IntersectRGB()
        Sets the color of the intersecting violation units.
      - *IsActive()
        Indicates the active page in the page list and the active window on each page.
      - *IsLoaded()
        Indicates whether the current result definition is loaded or not.
      - *IsoValue()
        Indicates the current iso value of the current model.
      - *Label() - axis and plot macro
        Specifies an axis label or the name of the plot macro to be used in the interface.
      - *Label() - datum line
        Specifies a datum line label.
      - *Label() - HyperView
        Specifies the label on the origin part.
      - *Label() - SCL
        Specifies the label of the stress classification line (SCL).
      - *LabelFont()
        Specifies the font type, weight, style, and size for axis labels or datum line labels.
      - *LabelLocation()
        Specifies the location of the datum line label.
      - *Layer()
        Indicates the data component selected for the given result type.
      - *Layout()
        Specifies the window arrangement on a page.
      - *Leader()
        Specifies the position of the leader in a legend.
      - *LegendMaxThreshold()
        Indicates the minimum threshold value for the legend.
      - *LegendMinThreshold()
        Indicates the minimum threshold value for the legend.
      - *LegendMode()
        Determines if the iso values are displayed in a legend.
      - *LegendPosition()
        Specifies the position of the contour legend on the page area.
      - *LegendTitle()
        Specifies the title of the legend.
      - *LegendType() - Contour Tensor Vector
        Specifies the scale type for the legend.
      - *LegendType() - FLD Panel
        Indicates if the analysis results are displayed as a zone legend or as distance contour.
      - *LightInfo()
        Defines the light source for a graphic.
      - *Line()
        Defines the style, color, and line weight attributes for a curve.
      - *LineColor()
        Indicates the color for the tracing path.
      - *LineSource()
        Indicates the source used to create a line.
      - *LineWidth()
        Indicates the thickness for the tracing path.
      - *LoadedSimulations()
        Lists subcase ID and simulations loaded for a given model.
      - *LoadImage()
        Indicates the name of the image file to load.
      - *LoadOverlay()
        Indicates the name of the image or video file to load as an overlay.
      - *LoadVideo()
        Indicates the name of the video file to load.
      - *LooseMetal()
        Indicates the settings for the loose metal line offset used in the FLD analysis.
      - *Margin()
        Indicates the settings for the margin line offset used in the FLD analysis.
      - *Marker()
        Defines marker attributes.
      - *MarkerCenter()
        Indicates the location (in pixels) of a marker.
      - *MarkerEndpoints()
        Specifies the marker endpoints.
      - *MarkerSize()
        Specifies the size of the marker seeds drawn on the streamlines of a CFD plot.
      - *MasterMeasure()
        Specifies the attributes for a special measure which can provide unit conversion from pixels to selected units on a video or image.
      - *Max()
        Specifies the maximum value of an axis on a plot.
      - *MaxBreakAngle()
        Specifies the break angle to be used for the decimation criteria for the streamlines.
      - *MaxLineSegmentLength()
        Specifies the maximum line length to be used for the decimation criteria for the streamlines.
      - *MaxSpeedVariation()
        Specifies the maximum speed variation to be used for the decimation criteria for the streamlines.
      - *MdlFile()
        Specifies the MDL file to be read into a *BeginModel() block.
      - *Measure()
        Gets the measure name that is displayed.
      - *MeasureAngle()
        Specifies parameters for an angle measurement in the animation window.
      - *MeasureDisplacement()
        Specifies parameters for a displacement measurement in the animation window.
      - *MeasureDistance()
        Specifies parameters for a distance measurement item in the animation window.
      - *MeasurePosition()
        Specifies parameters for a position measurement in a graphic window.
      - *MemoryView()
        Specifies a memorized orientation view for the animation window.
      - *Min()
        Specifies the minimum value of an axis on a plot.
      - *MinMax()
        Saves and restores the current minimum and maximum values of a displayed legend.
      - *Mode()
        Captures the selection mode for an exploded view.
      - *Mode() - Tracking System
        Specifies the tracking mode for a given tracking system.
      - *ModelIndex()
        The index of the model to be contoured.
      - *ModelReference()
        Specifies the filename for a referenced model, which has been pasted into a window as a link to another model.
      - *ModelSource()
        Specifies a model file to load into the application.
      - *MoveType()
        Indicates the move type and method for setting orientation.
      - *MultipleLayers()
        Specifies if multiple layer support is enabled/disabled.
      - *Multiplier()
        Indicates the value with which the contour values are multiplied.
      - *N1()
        Specifies the begin node of the stress classification line (SCL).
      - *N2()
        Specifies the end node of the stress classification line (SCL).
      - *Name()
        Name of a material as it is listed in the interface.
      - *NodalResult()
        The nodal result to be contoured.
      - *NodeAttachment()
        Specifies the node, and the model containing that node, to which an animation window note is attached.
      - *NodeLocator() - Components
        Indicates that a node is being tracked, traced, or measured.
      - *NodeLocator() - Notes
        Indicates that a note is attached to a node.
      - *NonPlanarSection()
        Defines a deformable section cut plane.
      - *NoResultColor()
        Indicates the RGB values that are displayed if no contour results are found.
      - *NoteAlignment() - HyperView
        Specifies the note’s text alignment.
      - *NoteAlignment() - HyperGraph
        Specifies the paragraph alignment of note text.
      - *NoteAnchor()
        Specifies the anchor alignment of the added note.
      - *Number()
        Specifies the number of slices by which the 3D geometry will be divided for Axisymmetry.
      - *NumberOfRowsColumns()
        Specifies the number of rows and columns of rake lines on which to apply the vector plot.
      - *NumberOfSeeds()
        Specifies the number of lines to be displayed as streamlines.
      - *NumberOfStreamLineColors()
        Specifies the number of colors used to color the streamlines in the CFD/Streamlines panel.
      - *Numbers()
        Specifies the format for the numeric values displayed by the legend.
      - *NumbersFont()
        Specifies the font settings for the numeric values displayed on the contour legend.
      - *NumCols()
        Indicates the number of color bands to display in the contour legend.
      - *NumericFormat()
        Specifies the format and precision of the measured values.
      - *NumPoints()
        Specifies the number of points dividing the stress classification line (SCL) into equal segments.
      - *NumOverriddenValues()
        Specifies the number of Legend values which are currently overridden.
      - *Object()
        Specifies object attributes for primitives.
      - *Offset()
        Offsets the values in a data vector.
      - *On()
        Determines if the messure should be drawn on the screen.
      - *Orientation()
        Indicates the plane settings used to define a section cut in HyperView's Section Cut panel.
      - *Origin()
        Specifies the origin settings for the added part.
      - *OverlaySettings()
        Indicates the overlay settings.
      - *OverriddenValues()
        Specifies the index and value that was overridden for the Legend.
      - *OverrideColor()
        Indicates if the override color is enabled.
      - *Parameter() - plot macro
        Specifies the label and variable type for a plot macro parameter.
      - *Part()
        Specifies part attributes such as part name, color, and visibility.
      - *PartLocator() - Components
        Indicates that a component is being tracked, traced, or measured.
      - *PartLocator() - Notes
        Indicates that the note is attached to a component.
      - *PartsAssemblyVisibility()
        Defines the part assembly visibility state.
      - *Perspective()
        Specifies settings for perspective drawing of 3D graphic entities.
      - *PinVideo()
        Indicates if the origin is held at a fixed location on screen.
      - *PlanarSection()
        Defines a section cut plane.
      - *PlotOption()
        Indicates the plot option used for extract data and linearization.
      - *PlotResult()
        Specifies the plotted result.
      - *PolarTipTailFormat()
        Specifies the TipToTail curve format of the polar plot.
      - *Position() - datum lines
        Specifies the location of a datum line.
      - *Position() - HyperView
        Specifies the location of a note in HyperView.
      - *Position() - legends
        Specifies the location of a legend in a plot window.
      - *Position() - notes
        Specifies the location of a note in a plot window.
      - *Precision() - HyperGraph
        Specifies the accuracy of the fixed decimal notation for an axis on a plot.
      - *Precision() - MediaView
        Determines how the numeric portion of the measure annotation should be displayed.
      - *Preferences() - Graphics Files
        Sets foreground, background, and other colors for all animation windows, turns various display features on and off, and sets the default feature angle. Indicates if forces and moments are displayed as fixed or variable, the force and moment sizes (if displayed as fixed), and the marker size.
      - *Preferences() - Video Files
        Indicates the settings of global preferences.
      - *PrimaryFont()
        Defines the font type, weight, style, and size for the first line of a header or footer.
      - *Projected()
        Specifies whether or not the vector plot is projected on a section cut.
      - *ProjectionRule()
        Indicates the rule for projecting the contour result using the primary and secondary axes.
      - *ProjectionType()
        Indicates the projection type of view.
      - *Proximity()
        Sets the proximity value.
      - *ProximityChecking()
        Indicates the proximity check setting.
      - *ProximityRGB()
        Sets the color of the proximity violation units.
      - *RakeDefinition()
        Specifies the type of rake to be used to create streamlines.
      - *RakeScale()
        Specifies the scale factor of the rake definition in a CFD plot.
      - *RakeTransformationMatrix()
        Specifies the transformation matrix of the rake definition in a CFD plot.
      - *RangeFrom()
        Indicates the value of the From range field, which is the start point for the range of values in the From and To fields on the Modify Curves panel.
      - *RangeTo()
        Indicates the value of the To range field, which is the end point for the range of values in the From and To fields.
      - *ReaderProperty()
        Captures the reader options used while loading the model and result files.
      - *ReferenceStep()
        Indicates the time step at which the measure was created.
      - *RenderOptions()
        Sets system level display settings for FEA files.
      - *Request()
        Specifies a request from a data file for a vector in a plot curve.
      - *ResolvedInSystem()
        Specifies the system in which to resolve the values.
      - *ResultBinding()
        Indicates if the collision results are to be applied to elements or components.
      - *ResultMathTemplate()
        Specifies the name of the result math template used for result math analysis.
      - *ResultReference()
        Specifies the filename for a referenced set of results that has been pasted into a window as a link to another model’s results.
      - *ResultString()
        Holds a single text parameter that indicates the result, other than displacement, to be contoured.
      - *ResultType()
        Indicates the list of valid result data types based on the solver results.
      - *Review()
        Specifies the review state of the stress classification line (SCL).
      - *Rotation()
        Specifies the rotation setting for the added part.
      - *RotationAngle()
        Specifies the rotation increment for the graphic view controls.
      - *Scale() - Add Object Panel
        Specifies the scale settings for the added part. This statement will be written out only if this value has been changed by the user.
      - *Scale() - Deformed Panel
        Specifies the scale for the X, Y, and Z axis direction.
      - *Scale() - HyperGraph
        Indicates whether a plot axis is linear, logarithmic, dB10 or dB20.
      - *Scale() – Tensor and Vector panels
        Indicates the scale size setting for a vector or tensor plot.
      - *Scale() - Vector Panel
        Specifies the scale type for a vector plot.
      - *ScaleFactor()
        Scales a data vector in a curve.
      - *ScaleMode()
        Specifies the scaling setting used to display the deformation on the mode.
      - *SecondaryFont()
        Defines the font type, weight, style, and size for the second line of a header or footer.
      - *SectionType()
        Indicates the section type settings for the section cut.
      - *SeedColor()
        Specifies the seed color on a rake definition for a CFD plot.
      - *SelectionInfo()
        Marks the start of asession block containing the results to be contoured.
      - *Set()
        Specifies the value of a curve macro object.
      - *ShadeMode()
        Sets the shading mode for a part.
      - *Shape()
        Defines the shape of a note.
      - *ShearScale()
        Sets the scale value used to display tensors.
      - *Shininess()
        Specifies the degree of shininess of the specular light component of a material.
      - *ShowInLegend()
        Specifies whether to include a curve label in the legend.
      - *ShowMax()
        Displays the maximum values for the contoured results in the contour legend.
      - *ShowMaxLocal()
        Displays the maximum local values for the contoured results in the contour legend.
      - *ShowMaxMin()
        Displays the maximum and minimum values for the contoured results in the contour legend.
      - *ShowMidsideNodeResults()
        Indicates whether Mid-side node results will be used for plotting.
      - *ShowMin()
        Displays the minimum values for the contoured results in the contour legend.
      - *ShowMinLocal()
        Displays the minimum local values for the contoured results in the contour legend.
      - *ShowNodeTrace()
        Indicates the display of the nodes that are traced.
      - *ShowOriginalLine()
        Specifies that the original line is enabled or disabled.
      - *ShowProjectedLine()
        Specifies that the projected line is enabled or disabled.
      - *ShowRakeOutline()
        Specifies whether or not the rake outline used to create the streamlines will be displayed.
      - *ShowResult()
        Displays the result text in the contour legend.
      - *ShowSeedOutline()
        Specifies whether or not the seeds for a given rake definition in a CFD plot will be displayed.
      - *ShowSurface()
        Indicates the surface covered between the original line and the projected line.
      - *SnapToAttachment()
        Specifies if the note needs to move along with the model during animation.
      - *Specular()
        Specifies the red, green, and blue values for the specular light component of a material.
      - *StartIndex()
        The index of the first data point to be read from the specified file.
      - *StartTime()
        Specifies the time at which animation begins.
      - *StreamLineRegenerationMode()
        Specifies the regeneration mode used when drawing streamlines in the CFD/Streamlines panel.
      - *StreamLineSize()
        Specifies the thickness used to draw streamlines in the CFD/Streamlines panel.
      - *StreamlineSource()
        Specifies the source used to create streamlines in the CFD/Streamlines panel.
      - *StreamlineStyle()
        Specifies the style used to draw streamlines in the CFD/Streamlines panel.
      - *Stretch()
        Indicates if the image is displayed in the entire display window or as its actual size.
      - *Style()
        Specifies the style for a datum line.
      - *Subcase()
        Specifies the subcase ID used while creating a user-defined expression using the GUI for a given result math analysis.
      - *Symbol()
        Defines the style, color, and spacing for symbols on a curve.
      - *SystemLocator()
        Indicates that a system is being tracked, traced, or measured.
      - *SystemLocator() - Components
        Indicates that a system is being tracked, traced, or measured.
      - *TerminationCriteria()
        Specifies the criteria used to terminate the length of the streamlines in the CFD/Streamlines panel.
      - *TertiaryFont()
        Defines the font type, weight, style, and size for the third line and all lines thereafter in a header or footer.
      - *Text() - HyperGraph
        Specifies the content of headers, footers, and notes in HyperGraph or the contents of a TextView window.
      - *Text() - HyperView
        Starts a block that contains the text for the attached note.
      - *TextColor() - TextView
        Specifies the text color for the text editor.
      - *TextColor() - HyperView
        Specifies the text color.
      - *Thickness()
        Specifies the thickness of a datum line.
      - *TicMethod()
        Specifies the method used to place tics along an axis.
      - *Tics()
        Specifies the number of tics on a plot axis.
      - *TicsFont()
        Specifies the font type, weight, style, and size for axis tics.
      - *TimeDelay()
        Specifies the amount of time to wait before animating a window.
      - *TimeScale()
        Adjusts the animation running time for a single window.
      - *Title()
        Specifies a page title.
      - *Title() - HyperView
        Indicates the title for the contour legend.
      - *TitleFlag()
        Indicates if the title attached to the note should be displayed.
      - *TitleFont() - HyperGraph
        Specifies the font type, weight, style, and size for the axis labels or datum line labels.
      - *TitleFont() - HyperView
        Specifies the font settings used to display the title of the contour legend.
      - *Timestep()
        Determines if the measure should be drawn at the time index specified by this statement.
      - *TotalAngle()
        Specifies the angle of sweep about the axis for Axisymmetry.
      - *TracingMode()
        Sets the node trace mode.
      - *TracingSteps()
        Defines the steps to trace when *TracingMode() is set to "List".
      - *Tracking()
        Specifies the part tracked during animation.
      - *TrackingSystem()
        Defines a user coordinated system capable of moving along with dynamically tracked marker locations.
      - *TrackingSystemColors()
        Sets the colors for the axis arrows and labels.
      - *Transient()
        If Transient is true, the measure will only be drawn at the time step of its creation.
      - *Translate()
        Indicates the entity being translated during the explosion.
      - *Transparency()
        Specifies the transparency setting on the legend.
      - *Transparent()
        Indicates if a graphic note should have a transparent or solid background.
      - *Type()
        Determines the measure type.
      - *UndeformedColor()
        Specifies the deformation with the selected color.
      - *UndeformedMode()
        Specifies the display mode of the deformation that occurs on the model.
      - *UndeformedTracking()
        Specifies if the deformation should follow with the tracking system.
      - *UniformAspectRatio()
        Forces the plot window axes to have the same units. This option is controlled via the Options panel.
      - *UnitLength()
        Determines the conversion factor from pixels to the given length units.
      - *Units()
        Specifies the unit type.
      - *UpdatingPolicy()
        Sets the updating policy of a vector plot.
      - *UseCurrentContour()
        Indicates whether the current contour is used for extract data and linearization.
      - *UseIntersections()
        Specifies whether to use intersections of the path with elements as intermediate points.
      - *UseTrackingSystem()
        Determines which system is used to report marker and measure coordinates.
      - *UseUnits()
        Sets the display of marker and measure annotations.
      - *VideoID()
        Connects the given measure with one of the valid videos or images via the internal ID number of the image or video.
      - *View()
        Specifies the orientation of the model in the window.
      - *View() - HyperView
        Specifies the view orientation matrix for a given window.
      - *Visible()
        Enables or disables the collision set.
      - *ZeroLineColor()
        Specifies the color of the zero line in a plot window.
      - *ZoomRect()
        Indicates the display coordinates (in pixels) for the window.
      - 188 more
  - Report Templates
    Report templates are ASCII text files that contain statements for creating reports.
Manage Files and Data
Learn how to 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.

View All Altair HyperWorks Help

HyperWorks Desktop

2021

Home
Startup Procedures and Customizations
Start HyperWorks Desktop and configure the applications.
Customization
There are various types of startup customizations that are possible for HyperWorks Desktop. These items define how the application looks or behaves at product startup.
Session Files
A session file is an ASCII text file that contains a structured list of session statements.
Session File Statements
*EndSelectionInfo()
Marks the end of a session block that contains the results to be contoured.

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

*EndSelectionInfo()

Marks the end of a session block that contains the results to be contoured.

Syntax

*EndSelectionInfo()

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

Intellectual Property Rights Notice | Technical Support