API, Reference Guides

2023

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.
HyperMesh
Solver Templates
Solver templates are ASCII data files containing HyperMesh Template Language Commands and HyperMesh Template Language Functions.
Commands and Functions
Solver Template Functions
@log()
Natural logarithm.

What's New
Get Started
Tutorials
API, Reference Guides

2023

API, Reference Guides

What's New
View new features for version 2023.
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.
- 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.
- HyperMesh Report
- HyperMesh
  - API Programmer's Guides
    These provide an overview of all additions, updates, and changes to the HyperMesh APIs for each release.
  - Data Names
    Details on the core data that can be queried and manipulated.
  - Ext API
    This API allows external applications to link HyperMesh as a library and provides a limited set of functions and structures to access specific functionality.
  - FE Input Readers
    FE input readers are C programs that read information from ASCII or binary finite element models files into the HyperMesh database.
  - HMASCII
    Details on the HMASCII format and associated commands.
  - Scripts
    This section contains details on general HyperWorks scripting concepts, along with documentation on the Tcl commands that can be used to query and modify the database and GUI.
  - Solver Templates
    Solver templates are ASCII data files containing HyperMesh Template Language Commands and HyperMesh Template Language Functions.
    - Card Previewer
      The HyperMesh Card Image panel is used to define solver specific data and review card information. The format of the cards and the menus in the panel are defined in the export template, using HyperMesh Card Preview Commands.
    - Create Solver Templates
    - Commands and Functions
      - Card Previewer Commands
      - Solver Template Commands
      - Solver Template Functions
        
        @acos()
        Trigonometric arc cosine of x, the result is expressed in radians between 0 and pp.
        
        @activateNlgeomImpdyn()
        Returns 1 if the environment variable HM_ACTIVATE_NLGEOM_IMPDYN is set to YES.
        
        @allowduplicateids()
        Returns 1 if the allow duplicate IDs option is enabled via *allowduplicateids, 0 otherwise.
        
        @asin()
        Trigonometric arc sine of x, the result is expressed in radians between -pp/2 and pp/2.
        
        @atan()
        Trigonometric arc tangent of x, the result is expressed in radians between -pp/2 and pp/2.
        
        @atan2()
        Trigonometric arc tangent of x/y, with the result is expressed in radians between -pp and pp.
        
        @attributearray2dcols()
        Returns the number of columns in a 2D array attribute.
        
        @attributearray2drows()
        Returns the number of rows in a 2D array attribute.
        
        @attributearray2dvalue()
        Returns the value of a 2D array attribute.
        
        @attributearraylength()
        Returns the length of a 1D array attribute.
        
        @attributearrayvalue()
        Returns the value of 1D array attribute.
        
        @attributearrayvalueinternalid()
        Returns the internal ID of a 1D array attribute.
        
        @attributeindexarray2dcols()
        Returns the number of rows for a 2D array attribute on an entity.
        
        @attributeindexarray2drows()
        Returns the number of rows for a 2D array attribute on an entity.
        
        @attributeindexarray2dvalue()
        Returns the value of a 2D array attribute on an entity.
        
        @attributeindexarraylength()
        Returns the length of a 1D array attribute on an entity.
        
        @attributeindexarrayvalue()
        Returns the value of a 1D array attribute on an entity.
        
        @attributeindexbehavior()
        Returns the behavior of an attribute on an entity.
        
        @attributeindexentityid()
        Returns the entity ID of an entity attribute on an entity.
        
        @attributeindexentitytype()
        Returns the entity type (number) of an entity attribute on an entity.
        
        @attributeindexentitytypename()
        Returns the entity type (string) of an entity attribute on an entity.
        
        @attributeindexidentifier()
        Returns the identifier of an attribute on an entity.
        
        @attributeindexsolver()
        Returns the solver of an attribute on an entity.
        
        @attributeindexstatus()
        Returns the status of an attribute on an entity.
        
        @attributeindextype()
        Returns the type of attribute on an entity.
        
        @attributeindexvalue()
        Returns the value of an attribute on an entity.
        
        @attributereferencecount()
        Returns the number of times an entity is referenced by an attribute.
        
        @attributesmaxforsolver()
        Returns the number of attributes on the current entity that belong to a solver.
        
        @autocreateproperty()
        Returns the status of the "auto create property" export option.
        
        @checkentitynameexists()
        Returns 1 if the entity name exists in the model or else 0.
        
        @checkfile()
        Checks for a file.
        
        @checkiffreeformat()
        Returns 1 if "Free format export" option is ON or solver deck is exported using the Tcl command *feoutputwithdata with option HM_FREE_FORMAT_EXPORT_OPTION.
        
        @checkmergeinclude()
        Returns the state of the "merge include" export option.
        
        @compressNodeElems()
        Returns 0 if HM_NODEELEMS_SET_COMPRESS_SKIP is passed via *feoutputwithdata.
        
        @controlcardattributedefined()
        Returns 1 if an attribute exists, 0 otherwise.
        
        @cos()
        Trigonometric cosine of x, where x is expressed in radians.
        
        @count()
        Counts the entities in the database.
        
        @defaultstatus()
        Returns the default status of an attribute.
        
        @defined()
        Tests to see if a dictionary item or an attribute is defined.
        
        @dofs()
        Extracts individual degrees of freedom from an integer and returns the status.
        
        @elemcountperinclude()
        Returns the number of elements of a specific configuration and type for a specific component being exported to an include file.
        
        @entitygettype()
        Returns the user-assigned entity type. The user-assigned entity type is set in the template.
        
        @entityincollector()
        Returns the number of entities in a collector.
        
        @entitymaxid()
        Returns the maximum ID in use from a type of entity.
        
        @enum()
        Returns the value of an enumeration.
        
        @exists()
        Indicates if a pointer is pointing to an entity or if it is set to NULL.
        
        @exp()
        Exponential of x.
        
        @exportdmiginlongformat()
        Returns 1 if EXPORT_DMIG_LONGFORMAT is passed via *feoutputwithdata.
        
        @exportmpcinlongformat()
        Returns 1 if EXPORT_MPC_LONGFORMAT is passed via *feoutputwithdata.
        
        @exportsysteminlongformat()
        Returns the value of the "Export CORD2 and CORD4 in long format" export option.
        
        @fabs()
        Absolute value of x.
        
        @getattributearraylength()
        Retrieves the length of a 1D array attribute attached to a specific entity.
        
        @getattributearrayvalue()
        Retrieves the value of a 1D array attribute attached to a specific entity.
        
        @getattributearrayvaluebyinternalid1()
        Returns the internal ID of a 1D array attribute attached to an entity.
        
        @getattributearrayvaluebyinternalid2()
        Returns the value (active ID) of a 1D array attribute attached to an entity.
        
        @getattributevalueinternalid()
        Returns the internal ID value of an attribute attached to a specific entity.
        
        @getcelltriplevalue()
        Returns the values of a triple cell in a table.
        
        @getcelltype()
        Returns the type of a cell in a table.
        
        @getcellvalue()
        Returns the values of a bool, double, float, int, string, unsigned int, or entity ID cell in a table.
        
        @getcollectorcardimage()
        Retrieves the card image of a collector (such as PSHELL, Part, and so on).
        
        @getcollectorname()
        Retrieves the name of a collector.
        
        @getcollectornamebyinternalid()
        Returns the name of a collector by internal ID.
        
        @getcolumnentitytype()
        Returns the entity type ID of a column in a table.
        
        @getcolumnlabel()
        Returns the label of a column in a table.
        
        @getcolumntype()
        Returns the type ID of a column in a table.
        
        @getcontrolcardattribute()
        Returns the value of an attribute on a Control Card.
        
        @getcurrentincludeexportformat()
        Returns the export format type set using *setformattype().
        
        @getdatabaseentitytypename()
        Gets the type name of an entity from its index.
        
        @getentityarrayvalue()
        Returns the array value of an entity.
        
        @getentitycount()
        Returns the entity count of an entity array type data name.
        
        @getentitydefaultstatus()
        Retrieves the default status of attribute/dataname of an entity. Returns true if the default status is OFF, or false otherwise.
        
        @getentitytype()
        Returns the entity type of an entity array type data name.
        
        @getentityvalue()
        Retrieves the value of an entity.
        
        @getentityvaluebyinternalid()
        Returns the value of an entity data name.
        
        @getentityvalueinternalid()
        Returns the internal ID of an entity.
        
        @getidoffsetvalue()
        Returns the ID offset value for an input entity with ID pool number in a specified include file ID.
        
        @getincludefullname()
        Returns the include file full name and path for a given include ID.
        
        @getincludeidbyfilename()
        Returns the ID of an include file name.
        
        @getincludereferenceflag()
        Returns the referenced state of an include in the main file.
        
        @getinternalid()
        This command, used in feoutput and summary templates, returns an internal ID based on the pool number and solver ID of an entity.
        
        @getnewid()
        Returns the next valid ID by checking IDs of other entities.
        
        @getsolverid()
        Returns solver ID based on entity type and internal ID of an entity. This needs to be used in feoutput and summary templates.
        
        @gettablecelltriplevalue()
        Returns the values of a triple cell in a table.
        
        @gettablecelltype()
        Returns the type of a cell in a table.
        
        @gettablecelltypebyinternalid()
        Returns the type of a cell in a table.
        
        @gettablecellvalue()
        Returns the values of a bool, double, float, int, string, unsigned int, or entity ID cell in a table.
        
        @gettablecellvaluebyinternalid()
        Returns the values of a bool, double, float, int, string, unsigned int, or entity ID cell in a table.
        
        @gettablecolumnentitytype()
        Returns the entity type ID of a column in a table.
        
        @gettablecolumnlabel()
        Returns the label of a column in a table.
        
        @gettablecolumnsize()
        Returns the size (number of rows) of a column in a table.
        
        @gettablecolumnsizebyinternalid()
        Returns the size (number of rows) of a column in a table.
        
        @gettablecolumntype()
        Returns the type ID of a column in a table.
        
        @gettablecolumntypestring()
        Returns the type string of a column in a table.
        
        @gettotalmass()
        Returns different total mass values of the model.
        
        @icedependentcount()
        Returns the number of ICE dependent nodes for an independent node.
        
        @icedependentdof()
        Returns ICE dependent node DOFs for an independent node.
        
        @icedependentnode()
        Returns ICE dependent nodes for an independent node.
        
        @ignoresetswithsamenameascomps()
        Returns the value of the “Do not export ELSET with same name as component” export option in the Abaqus profile.
        
        @keywordrenumber()
        Returns 1 if RENUMBER is passed with the queried keyword via *feoutputwithdata.
        
        @loadexistinmergedloadloadsteptable()
        Returns 1 if the load exists in the table containing merged loads for a loadstep created by *createmergedloadloadsteptable().
        
        @loadsinloadcollector()
        Returns the number of loads in a collector for a specified configuration, type, and engineering type.
        
        @log()
        Natural logarithm.
        
        @log10()
        Logarithm of x to the base 10.
        
        @lookup()
        Retrieves a value stored in a lookup table.
        
        @magnitude()
        Returns the magnitude of a vector.
        
        @namedentity()
        Returns the value of the "Export as named entity" export option.
        
        @nlookup()
        Retrieves a value stored in the nth lookup table.
        
        @partinstancemode()
        Returns 1 if the model is a part/instance model.
        
        @pow()
        Returns the real value of X raised to the power Y.
        
        @rangecount()
        Returns the number of ranges for the numbers used with *rangeadd().
        
        @rangeend()
        Returns the ending range of a range of numbers.
        
        @rangestart()
        Returns the starting range of a range of numbers.
        
        @remsuppressedincludefrommain()
        Returns the value of the "Remove include file reference based on export status" export option.
        
        @repeatkeywordtitles()
        Returns the status of the "repeat keyword titles" export option.
        
        @sin()
        Trigonometric sine of x, where x is expressed in radians.
        
        @sqrt()
        Returns the square root of a number.
        
        @stringequal()
        Compares two strings, and returns 1 if they are equal; otherwise, 0.
        
        @stringinstring()
        Finds one string within another string.
        
        @stringlookup()
        Retrieves a value stored in a string lookup table.
        
        @stringsplit()
        Splits the given string using the given continuation character.
        
        @stringstartswithnumericcharacter()
        Checks if a string starts with a numeric character.
        
        @tan()
        Trigonometric tangent of x, where x is expressed in radians.
        
        @vectorlookup()
        Retrieves a value stored in a vector lookup table.
        
        @vectorlookupcomponent()
        Retrieves a component of the vector stored in a lookup table.
        
        @vectorlookupnotkey()
        Retrieves a value stored in a vector lookup table.
        
        @writehmcomments()
        Returns 0 if HMCOMMENTS_SKIP is passed via *feoutputwithdata.
        
        @writehmlegacycomments()
        Returns 1 if EXPORT_LEGACY_COMP_COMMENTS is passed via *feoutputwithdata.
        
        @writenastranoldcontact()
        Returns the contact export option value for Nastran (MSC).
        
        @writesolverfieldnames()
        Returns 0 if HMSOLVERFILEDNAMES_SKIP is passed via *feoutputwithdata.
        
        @xpointelementoffsetvectorlocal()
        Transforms a global vector into an elemental system and returns the x value of the transformation.
        
        @xpointlocal()
        Transforms a global coordinate into a local system and returns the x value of the transformation.
        
        @xpointvectorlocal()
        Transforms a vector into a local system and returns the x value of the transformed vector.
        
        @ypointelementoffsetvectorlocal()
        Transforms a global vector into an elemental system and returns the y value of the transformation.
        
        @ypointlocal()
        Transforms a global coordinate into a local system and returns the y value of the transformation.
        
        @ypointvectorlocal()
        Transforms a vector into a local system and returns the y value of the transformed vector.
        
        @zpointelementoffsetvectorlocal()
        Transforms a global vector into an elemental system and returns the z value of the transformation.
        
        @zpointlocal()
        Transforms a global coordinate into a local system and returns the z value of the transformation.
        
        @zpointvectorlocal()
        Transforms a vector into a local system and returns the z value of the transformed vector.
        
        Undocumented Solver Template Functions
        The list of undocumented solver template functions.
- 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

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.
HyperMesh
Solver Templates
Solver templates are ASCII data files containing HyperMesh Template Language Commands and HyperMesh Template Language Functions.
Commands and Functions
Solver Template Functions
@log()
Natural logarithm.

What's New
Get Started
Tutorials
API, Reference Guides

@log()

Natural logarithm.

Syntax

@log (x)

Type

HyperMesh Template Function

Inputs

x: A value of type real.

Example

@log(2) = LN(2) = 0.693147

© 2023 Altair Engineering, Inc. All Rights Reserved.

Intellectual Property Rights Notice | Technical Support | Cookie Consent