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
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.
Commands and Functions
Ext API Functions
HM_ExtAPI::GeomEdgeGetCoedges()
Returns face "wings" connected to the edge.

Welcome
What's New
View new features for version 2024.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.
- 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
  - 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.
    - Header Files
    - Library Files
    - Running
    - Examples
    - Commands and Functions
      - Ext API Functions
        Close_HM_ExtAPI()
        Closes HyperMesh session.
        HM_ExtAPI::CADDocumentGetAssmIsPart()
        Returns the type of the model assembly hierarchy document.
        HM_ExtAPI::CADDocumentGetComponent()
        Returns the component created for the model assembly hierarchy document.
        HM_ExtAPI::CADDocumentGetComponentsCount()
        Returns the number of components created for the model assembly hierarchy document.
        HM_ExtAPI::CADDocumentGetFileName()
        Returns the complete path to the CAD model file, from which the model assembly hierarchy document was imported.
        HM_ExtAPI::CADDocumentGetFirstChild()
        Returns the first child of the document in the model assembly hierarchy of the CAD model loaded into the database.
        HM_ExtAPI::CADDocumentGetInstanceName()
        Returns the full instance name of the model assembly hierarchy document in the assembly hierarchy tree.
        HM_ExtAPI::CADDocumentGetLinkName()
        Returns the name of the link used as a reference to the model assembly hierarchy document in the assembly hierarchy tree.
        HM_ExtAPI::CADDocumentGetLocalSystem()
        Returns the transformation matrix between the global model coordinate system and the original local system of the model part represented by the model assembly hierarchy document.
        HM_ExtAPI::CADDocumentGetMaterial()
        Returns the material name of a part.
        HM_ExtAPI::CADDocumentGetName()
        Returns the name of the model assembly hierarchy document.
        HM_ExtAPI::CADDocumentGetNext()
        Returns next document from the same level of the model assembly hierarchy of the CAD model loaded into the database.
        HM_ExtAPI::CADDocumentGetPartNumber()
        Returns the part number of a part.
        HM_ExtAPI::CADDocumentGetProtoId()
        Returns the prototype ID of a given part.
        HM_ExtAPI::CADDocumentGetThickness()
        Returns the thickness of a part.
        HM_ExtAPI::CADDocumentGetType()
        Returns the type of the model assembly hierarchy document.
        HM_ExtAPI::ComponentFindByImportedName()
        Finds a component by its original name.
        HM_ExtAPI::ComponentFindByName()
        Finds a component by its name.
        HM_ExtAPI::ComponentGetColor()
        Returns the color of the component.
        HM_ExtAPI::ComponentGetElementCount()
        Returns the total number of elements in a mesh component object.
        HM_ExtAPI::ComponentGetFirstElement()
        Returns the first element in a mesh component.
        HM_ExtAPI::ComponentGetFirstFreeGeomFace()
        Returns the first free face of the component.
        HM_ExtAPI::ComponentGetFirstFreeGeomLine()
        Returns the first free line of the component.
        HM_ExtAPI::ComponentGetFirstFreeGeomPoint()
        Returns the first free point of the component.
        HM_ExtAPI::ComponentGetFirstGeomFace()
        Returns the first face of the component.
        HM_ExtAPI::ComponentGetFirstGeomSolid()
        Returns the first solid of the component.
        HM_ExtAPI::ComponentGetID()
        Returns the ID of a component.
        HM_ExtAPI::ComponentGetNextElement()
        Returns the next element in a mesh component.
        HM_ExtAPI::ComponentGetImportedName()
        Returns original name of the component in the model structure of imported CAD model.
        HM_ExtAPI::ComponentGetName()
        Returns component name.
        HM_ExtAPI::ComponentGetNextFreeGeomFace()
        Returns the next free face of the component.
        HM_ExtAPI::ComponentGetNextFreeGeomLine()
        Returns the next free line of the component.
        HM_ExtAPI::ComponentGetNextFreeGeomPoint()
        Returns the next free point of the component.
        HM_ExtAPI::ComponentGetNextGeomFace()
        Returns the next face of the component.
        HM_ExtAPI::ComponentGetNextGeomSolid()
        Returns the next solid of the component.
        HM_ExtAPI::ComponentSetCurrent()
        Sets current component in HyperMesh.
        HM_ExtAPI::CreateComponent()
        Creates new component in HyperMesh database.
        HM_ExtAPI::CreateCurveApproximation()
        Creates approximation curve object.
        HM_ExtAPI::CreateCurveCircle()
        Creates circle curve object.
        HM_ExtAPI::CreateCurveComposed()
        Creates composed curve object.
        HM_ExtAPI::CreateCurveEllipse()
        Creates ellipse curve object.
        HM_ExtAPI::CreateCurveNURBS()
        Creates NURBS curve object.
        HM_ExtAPI::CreateCurveSegment()
        Straight line geometry object.
        HM_ExtAPI::CreateFreeGeomLine()
        Creates new free line in HyperMesh database.
        HM_ExtAPI::CreateFreeGeomPoint()
        Creates new free point in the HyperMesh database.
        HM_ExtAPI::CreateGeomFaceDirect()
        Creates face in HyperMesh database.
        HM_ExtAPI::CreateGeomFaceTrimmed()
        Creates trimmed face in the HyperMesh database.
        HM_ExtAPI::CreateGeomFaceUntrimmed()
        Creates face with rectangular parameterization in HyperMesh database.
        HM_ExtAPI::CreateGeomSolid()
        Creates solid within existing shell of boundary faces.
        HM_ExtAPI::CreateSurfaceComposed()
        Creates composed surface object.
        HM_ExtAPI::CreateSurfaceCone()
        Creates cone surface object.
        HM_ExtAPI::CreateSurfaceCylinder()
        Creates cylindrical surface object.
        HM_ExtAPI::CreateSurfaceExtruded()
        Creates extruded surface object.
        HM_ExtAPI::CreateSurfaceNURBS()
        Creates NURBS surface object.
        HM_ExtAPI::CreateSurfacePlane()
        Creates plane surface object.
        HM_ExtAPI::CreateSurfaceRevolution()
        Creates revolution surface object.
        HM_ExtAPI::CreateSurfaceSphere()
        Creates sphere surface object.
        HM_ExtAPI::CreateSurfaceTorus()
        Creates torus surface object.
        HM_ExtAPI::CurveApproximationGetData()
        Returns parameters that define curve represented by approximation points.
        HM_ExtAPI::CurveCircleGetData()
        Returns parameters that define circle.
        HM_ExtAPI::CurveComposedGetSegment()
        Returns individual segments of composed curve.
        HM_ExtAPI::CurveComposedGetSize()
        Returns number of curve segments that define composed curve.
        HM_ExtAPI::CurveEllipseGetData()
        Returns parameters that define ellipse.
        HM_ExtAPI::CurveNURBSGetData()
        Returns parameters that define NURBS curves.
        HM_ExtAPI::CurveSegmentGetData()
        Returns parameters that define straight segment curve.
        HM_ExtAPI::DeleteModel()
        Deletes model from HyperMesh database.
        HM_ExtAPI::ElementGetComponent()
        Returns a handle to the component for an element.
        HM_ExtAPI::ElementGetGrid()
        Returns grid points that define an element.
        HM_ExtAPI::ElementGetGridCount()
        Returns number of grid points that define an element.
        HM_ExtAPI::ElementGetID()
        Returns numeric ID of the element.
        HM_ExtAPI::ElementGetType()
        Returns element type.
        HM_ExtAPI::GenerateMesh()
        Generates a mesh on surfaces of the model loaded into the HyperMesh database, using mesh areas and constraint edges and points.
        HM_ExtAPI::GeomCoedgeGetEdge()
        Returns edge that is represented by the co-edge on corresponding face.
        HM_ExtAPI::GeomCoedgeGetFace()
        Returns face connected to the coedge.
        HM_ExtAPI::GeomCoedgeGetGeometry()
        Returns 2d curve that defines co-edge geometry.
        HM_ExtAPI::GeomCoedgeGetNextInLoop()
        Returns next co-edge in the face loop.
        HM_ExtAPI::GeomCoedgeGetNextOnEdge()
        Returns next co-edge on the edge represented by the coedge.
        HM_ExtAPI::GeomCoedgesConnect()
        Connects co-edges of existing faces into a single edge.
        HM_ExtAPI::GeomCurveConvertToNURBS()
        Converts parametric segment of a curve of any type to NURBS curve.
        HM_ExtAPI::GeomCurveConvertToSmooth()
        Converts curve to piecewise smooth curve.
        HM_ExtAPI::GeomCurveGetParameterBounds()
        Returns information about parameter range of the curve.
        HM_ExtAPI::GeomCurveGetPoint()
        Returns curve point.
        HM_ExtAPI::GeomCurveGetType()
        Returns curve type.
        HM_ExtAPI::GeomEdgeGetCoedges()
        Returns face "wings" connected to the edge.
        HM_ExtAPI::GeomEdgeGetCoedgesCount()
        Returns number of face "wings" connected to the edge.
        HM_ExtAPI::GeomEdgeGetFirstCoedge()
        Returns first co-edge connected to the edge.
        HM_ExtAPI::GeomEdgeGetGeometry()
        Returns curve that defines edge geometry.
        HM_ExtAPI::GeomEdgeGetVertex()
        Returns vertex of the edge.
        HM_ExtAPI::GeomFaceAddFixedPoint()
        Adds fixed point to existing face.
        HM_ExtAPI::GeomFaceGetComponent()
        Returns component that contains the face.
        HM_ExtAPI::GeomFaceGetGeometry()
        Returns surface that defines face geometry.
        HM_ExtAPI::GeomFaceGetInternalPoints()
        Returns internal face points.
        HM_ExtAPI::GeomFaceGetLoop()
        Returns coedges that define face loop.
        HM_ExtAPI::GeomFaceGetLoopsCount()
        Returns number of loops in the face.
        HM_ExtAPI::GeomFaceGetSolid()
        Returns solid connected to the face.
        HM_ExtAPI::GeomFacesConnectByEdgeEquivalencing()
        Connects faces by equivalencing their edges.
        HM_ExtAPI::GeomSolidGetBoundariesCount()
        Returns number of boundaries in the solid.
        HM_ExtAPI::GeomSolidGetBoundary()
        Returns faces that define solid boundary.
        HM_ExtAPI::GeomSolidGetComponent()
        Returns component the contains the solid.
        HM_ExtAPI::GeomSolidInsertCavity()
        Inserts cavity into existing solid.
        HM_ExtAPI::GeomSurfaceConvertToNURBS()
        Converts parametric region of a surface of any type to NURBS surface.
        HM_ExtAPI::GeomSurfaceExpandParameterBounds()
        Expands parametric bounds of the surface by given values.
        HM_ExtAPI::GeomSurfaceGetParameterBounds()
        Returns information about parameter range of the surface.
        HM_ExtAPI::GeomSurfaceGetPoint()
        Returns surface point.
        HM_ExtAPI::GeomSurfaceGetType()
        Returns surface type.
        HM_ExtAPI::GeomVertexGetEdges()
        Returns edges connected to the vertex.
        HM_ExtAPI::GeomVertexGetEdgesCount()
        Returns number of edges connected to the vertex.
        HM_ExtAPI::GeomVertexGetFaces()
        Returns faces connected to the vertex.
        HM_ExtAPI::GeomVertexGetGeometry()
        Returns vertex geometry.
        HM_ExtAPI::GetCurrentComponent()
        Returns current component.
        HM_ExtAPI::GetFirstComponent()
        Returns the first component of the model currently loaded in HyperMesh database model.
        HM_ExtAPI::GetInternalModelTolerance()
        Returns equivalence tolerance value for the model.
        HM_ExtAPI::GetLastErrorCode()
        Returns the code of the last error occurred during the call to any of the functions of HM_ExtAPI interface.
        HM_ExtAPI::GetNextComponent()
        Returns the next component of the model currently loaded in HyperMesh database model.
        HM_ExtAPI::GetRootCADDocument()
        Returns the root document in the model assembly hierarchy of the CAD model loaded into HyperMesh database.
        HM_ExtAPI::GetRootCADDocumentsCount()
        Returns the number of root documents in the model assembly hierarchy for each CAD model loaded into HyperMesh database.
        HM_ExtAPI::GridGetID()
        Returns numeric ID of the grid point of a mesh.
        HM_ExtAPI::GridGetPosition()
        Returns position of the grid point of a mesh.
        HM_ExtAPI::GridGetTopology()
        Returns position of the grid point of a mesh.
        HM_ExtAPI::GridGetTopologyPosition()
        Returns expected position of the grid point on associated topological entity.
        HM_ExtAPI::GridTopologyGetTypeAndID()
        Returns the type and ID of topological entity associated with a grid point of a mesh.
        HM_ExtAPI::ImportModel()
        Loads model from CAD file into HyperMesh database.
        HM_ExtAPI::LoadModel()
        Loads model from HyperMesh file into HyperMesh database.
        HM_ExtAPI::MemoryAlloc()
        Allocates memory block of specified size.
        HM_ExtAPI::MemoryFree()
        Releases the memory allocated within other API functions.
        HM_ExtAPI::MeshGetComponentCount()
        Returns the total number of mesh components in a mesh object.
        HM_ExtAPI::MeshGetDeviatingGridCount()
        Returns total number of mesh grid points that deviate from original model geometry.
        HM_ExtAPI::MeshGetElementCount()
        Returns total number of elements in a mesh object.
        HM_ExtAPI::MeshGetFirstComponent()
        Returns the first mesh component in a mesh object.
        HM_ExtAPI::MeshGetFirstDeviatingGrid()
        Returns the first deviating grid point in a mesh referenced by a mesh object.
        HM_ExtAPI::MeshGetFirstElement()
        Returns the first element in a mesh referenced by a mesh object.
        HM_ExtAPI::MeshGetFirstGrid()
        Returns the first grid point in a mesh referenced by a mesh object.
        HM_ExtAPI::MeshGetGridCount()
        Returns total number of mesh grid points in a mesh object.
        HM_ExtAPI::MeshGetNextComponent()
        Returns the next mesh component in a mesh object.
        HM_ExtAPI::MeshGetNextDeviatingGrid()
        Returns the next deviating grid point in a mesh referenced by a mesh object.
        HM_ExtAPI::MeshGetNextElement()
        Returns the next element in a mesh referenced by a mesh object.
        HM_ExtAPI::MeshGetNextGrid()
        Returns the next grid point in a mesh referenced by a mesh object.
        HM_ExtAPI::OffsetFaces()
        Offsets faces in the model in the direction of their normal.
        HM_ExtAPI::OffsetShellsByFaces()
        Offsets faces connected into manifold shell in the direction of the shell normal.
        HM_ExtAPI::PointLocateFace()
        Finds closest to given point face or finds the closest point on the face.
        HM_ExtAPI::ReleaseGeomCurve()
        Releases the handle to temporary curve.
        HM_ExtAPI::ReleaseGeomSurface()
        Releases the handle to temporary surface.
        HM_ExtAPI::ReleaseMesh()
        Frees memory allocated for temporary mesh structures.
        HM_ExtAPI::RunHMTclString()
        Executes command using internal HyperMesh Tcl interpreter and returns the result of execution.
        HM_ExtAPI::SetInternalModelTolerance()
        Sets equivalence tolerance value for the model.
        HM_ExtAPI::SetScratchFolder()
        Turns on or off generation of log files by different components used within HyperMesh, and sets the folder to redirect output of these files.
        HM_ExtAPI::SurfaceComposedGetPatch()
        Returns individual surfaces of composed surface.
        HM_ExtAPI::SurfaceComposedGetSizes()
        Returns sizes of rectangular grid of composition surfaces.
        HM_ExtAPI::SurfaceConeGetData()
        Returns parameters that define cone surface.
        HM_ExtAPI::SurfaceCylinderGetData()
        Returns parameters that define cylindrical surface.
        HM_ExtAPI::SurfaceExtrudedGetData()
        Returns parameters that define extruded surface.
        HM_ExtAPI::SurfaceNURBSGetData()
        Returns parameters that define NURBS surface.
        HM_ExtAPI::SurfacePlaneGetData()
        Returns parameters that define plane surface.
        HM_ExtAPI::SurfaceRevolutionGetData()
        Returns parameters that define revolution surface.
        HM_ExtAPI::SurfaceSphereGetData()
        Returns parameters that define spherical surface.
        HM_ExtAPI::SurfaceTorusGetData()
        Returns parameters that define torus surface.
        HM_ExtAPI::TopologyTypeAndIDGetGrid()
        Returns a mesh grid associated with a specified topology edge or vertex.
        HM_ExtAPI::TopologyTypeAndIDGetGridCount()
        Returns a mesh grid associated with a specified topology edge or vertex.
        Open_HM_ExtAPI()
        Opens HyperMesh session and returns pointer to API object.
      - Ext API Structures
      - Ext API Types
  - 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.
- 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

HM_ExtAPI::GeomEdgeGetCoedges()

Returns face "wings" connected to the edge.

Syntax

bool GeomEdgeGetCoedges(
const HM_EntityGeomEdge & edge,
int& coedge_count,
HM_EntityGeomCoedge * & coedges,
bool*& dir_senses,
bool*& face_senses
);

Type

HyperMesh Ext API Function

Description

When one or more faces are connected at common edge then connection of the edge to each of the faces is represented by co-edge entity associated with this face. Each of co-edges has corresponding face on one of its sides. It is also possible for a co-edge to have faces on both sides. In some cases a co-edge can have the same face on both sides. In these cases the same co-edge corresponds to topologically distinct face "wings" that are connected to the common edge. The combination of the co-edge and its side is necessary to identify uniquely corresponding "wing".

To free arrays allocated for co-edges, dir_senses and face_senses during the function call use the function HM_ExtAPI::MemoryFree().

If the function succeeds, the return value is true. If the function fails, the return value is false. To get extended value information, call HM_ExtAPI::GetLastErrorCode().

Requires including hm_extapi.h.

Inputs

edge: [in] - Handle to edge object that was returned by previous calls to API functions.
coedge_count: [out] - Number of co-edges.
coedges: [out] - Returns pointer to array of handles to co-edges. The number of values in the array is coedge_count. The pointer is NULL if edge is not connected to any faces.
dir_senses: [out] - Returns pointer to array of flags that indicate co-edge direction with respect to edge direction. The number of values in the array is coedge_count. The pointer is NULL if edge is not connected to any faces. The value of true indicates that corresponding co-edge direction coincides with the direction of the edge. The value of false indicates that corresponding co-edge direction is opposite to the direction of the edge.
face_senses: [out] - Returns pointer to array of flags that indicate at which side the co-edge is connected to associated face "wing". The number of values in the array is coedge_count. The pointer is NULL if edge is not connected to any faces. The value of true indicates that corresponding co-edge has associated face on its left. The value of false indicates that corresponding co-edge has associated face on its right.

Errors

None.