HyperMesh Reference Guide
Table of Contents
API Programmer's Guides
2017 API Programmer's Guide
14.0 API Programmer's Guide
13.0 API Programmer's Guide
12.0 API Programmer's Guide
11.0 API Programmer's Guide
10.0 API Programmer's Guide
9.0 API Programmer's Guide
Data Names
accelerometers
assemblies
bags
beamsectcols
beamsects
blocks
bodies
boxes
cards
collections
components
configurations
connectors
constrainedextranodes
constrainedrigidbodies
constraints
contactsurfs
controlvols
crosssections
curves
ddvals
dequations
designvars
desvarlinks
directmatrixinputs
dobjrefs
domains
dvprels
elements
ellipsoids
encryptions
equations
features
fields
global
groups
handles
includefiles
joints
laminates
lines
loadcols
loads
loadsteps
materials
mbjoints
mbplanes
mechanisms
meshcontrols
metadata
modules
morphconstraints
morphvolumes
multibodies
nodes
objectives
opticonstraints
opticontrols
optidscreens
optiresponses
outputblocks
parameters
plies
plots
points
positions
properties
regions
rigidwalls
sensors
sets
shapes
solids
surfaces
symmetries
systemcols
systems
tables
tags
titles
transformations
vectorcols
vectors
Ext API
Header Files
Library Files
Running
Examples
Commands and Functions
FE Input Readers
Result Readers
hmlib
hminlib
hmmodlib
hmreslib
Creating FE Input Readers
Commands and Functions
HMASCII
Input Format
Output Format
Commands and Functions
Model Checker
Config File
Checks and Corrections
Scripts
Introduction
Creating Scripts
Running Scripts
Commands and Functions
Solver Templates
Card Previewer
Creating Solver Templates
Commands and Functions
Index
Search
Home
Table of Contents
Ext API
Commands and Functions
Ext API Functions
Table of Contents
API Programmer's Guides
Data Names
Ext API
Header Files
Library Files
Running
Examples
Commands and Functions
Ext API Functions
Close_HM_ExtAPI()
HM_ExtAPI::CADDocumentGetAssmIsPart()
HM_ExtAPI::CADDocumentGetComponent()
HM_ExtAPI::CADDocumentGetComponentsCount()
HM_ExtAPI::CADDocumentGetFileName()
HM_ExtAPI::CADDocumentGetFirstChild()
HM_ExtAPI::CADDocumentGetInstanceName()
HM_ExtAPI::CADDocumentGetLinkName()
HM_ExtAPI::CADDocumentGetLocalSystem()
HM_ExtAPI::CADDocumentGetMaterial()
HM_ExtAPI::CADDocumentGetName()
HM_ExtAPI::CADDocumentGetNext()
HM_ExtAPI::CADDocumentGetPartNumber()
HM_ExtAPI::CADDocumentGetProtoId()
HM_ExtAPI::CADDocumentGetThickness()
HM_ExtAPI::CADDocumentGetType()
HM_ExtAPI::ComponentFindByImportedName()
HM_ExtAPI::ComponentFindByName()
HM_ExtAPI::ComponentGetColor()
HM_ExtAPI::ComponentGetFirstFreeGeomFace()
HM_ExtAPI::ComponentGetFirstFreeGeomLine()
HM_ExtAPI::ComponentGetFirstFreeGeomPoint()
HM_ExtAPI::ComponentGetFirstGeomFace()
HM_ExtAPI::ComponentGetFirstGeomSolid()
HM_ExtAPI::ComponentGetImportedName()
HM_ExtAPI::ComponentGetName()
HM_ExtAPI::ComponentGetNextFreeGeomFace()
HM_ExtAPI::ComponentGetNextFreeGeomLine()
HM_ExtAPI::ComponentGetNextFreeGeomPoint()
HM_ExtAPI::ComponentGetNextGeomFace()
HM_ExtAPI::ComponentGetNextGeomSolid()
HM_ExtAPI::ComponentSetCurrent()
HM_ExtAPI::CreateComponent()
HM_ExtAPI::CreateCurveApproximation()
HM_ExtAPI::CreateCurveCircle()
HM_ExtAPI::CreateCurveComposed()
HM_ExtAPI::CreateCurveEllipse()
HM_ExtAPI::CreateCurveNURBS()
HM_ExtAPI::CreateCurveSegment()
HM_ExtAPI::CreateFreeGeomLine()
HM_ExtAPI::CreateFreeGeomPoint()
HM_ExtAPI::CreateGeomFaceDirect()
HM_ExtAPI::CreateGeomFaceUntrimmed()
HM_ExtAPI::CreateSurfaceComposed()
HM_ExtAPI::CreateSurfaceCone()
HM_ExtAPI::CreateSurfaceCylinder()
HM_ExtAPI::CreateSurfaceExtruded()
HM_ExtAPI::CreateSurfaceNURBS()
HM_ExtAPI::CreateSurfacePlane()
HM_ExtAPI::CreateSurfaceRevolution()
HM_ExtAPI::CreateSurfaceSphere()
HM_ExtAPI::CreateSurfaceTorus()
HM_ExtAPI::CurveApproximationGetData()
HM_ExtAPI::CurveCircleGetData()
HM_ExtAPI::CurveComposedGetSegment()
HM_ExtAPI::CurveComposedGetSize()
HM_ExtAPI::CurveEllipseGetData()
HM_ExtAPI::CurveNURBSGetData()
HM_ExtAPI::CurveSegmentGetData()
HM_ExtAPI::DeleteModel()
HM_ExtAPI::ElementGetGrid()
HM_ExtAPI::ElementGetGridCount()
HM_ExtAPI::ElementGetID()
HM_ExtAPI::ElementGetType()
HM_ExtAPI::GenerateMesh()
HM_ExtAPI::GeomCoedgeGetEdge()
HM_ExtAPI::GeomCoedgeGetFace()
HM_ExtAPI::GeomCoedgeGetGeometry()
HM_ExtAPI::GeomCoedgeGetNextInLoop()
HM_ExtAPI::GeomCoedgeGetNextOnEdge()
HM_ExtAPI::GeomCoedgesConnect()
HM_ExtAPI::GeomCurveConvertToNURBS()
HM_ExtAPI::GeomCurveConvertToSmooth()
HM_ExtAPI::GeomCurveGetParameterBounds()
HM_ExtAPI::GeomCurveGetPoint()
HM_ExtAPI::GeomCurveGetType()
HM_ExtAPI::GeomEdgeGetCoedges()
HM_ExtAPI::GeomEdgeGetCoedgesCount()
HM_ExtAPI::GeomEdgeGetFirstCoedge()
HM_ExtAPI::GeomEdgeGetGeometry()
HM_ExtAPI::GeomEdgeGetVertex()
HM_ExtAPI::GeomFaceAddFixedPoint()
HM_ExtAPI::GeomFaceGetComponent()
HM_ExtAPI::GeomFaceGetGeometry()
HM_ExtAPI::GeomFaceGetInternalPoints()
HM_ExtAPI::GeomFaceGetLoop()
HM_ExtAPI::GeomFaceGetLoopsCount()
HM_ExtAPI::GeomFaceGetSolid()
HM_ExtAPI::GeomFacesConnectByEdgeEquivalencing()
HM_ExtAPI::GeomSolidGetBoundariesCount()
HM_ExtAPI::GeomSolidGetBoundary()
HM_ExtAPI::GeomSolidGetComponent()
HM_ExtAPI::GeomSolidInsertCavity()
HM_ExtAPI::GeomSurfaceConvertToNURBS()
HM_ExtAPI::GeomSurfaceExpandParameterBounds()
HM_ExtAPI::GeomSurfaceGetParameterBounds()
HM_ExtAPI::GeomSurfaceGetPoint()
HM_ExtAPI::GeomSurfaceGetType()
HM_ExtAPI::GeomVertexGetEdges()
HM_ExtAPI::GeomVertexGetEdgesCount()
HM_ExtAPI::GeomVertexGetFaces()
HM_ExtAPI::GeomVertexGetGeometry()
HM_ExtAPI::GetCurrentComponent()
HM_ExtAPI::GetFirstComponent()
HM_ExtAPI::GetInternalModelTolerance()
HM_ExtAPI::GetLastErrorCode()
HM_ExtAPI::GetNextComponent()
HM_ExtAPI::GetRootCADDocument()
HM_ExtAPI::GetRootCADDocumentsCount()
HM_ExtAPI::GridGetID()
HM_ExtAPI::GridGetPosition()
HM_ExtAPI::GridGetTopology()
HM_ExtAPI::GridGetTopologyPosition()
HM_ExtAPI::GridTopologyGetTypeAndID()
HM_ExtAPI::ImportModel()
HM_ExtAPI::LoadModel()
HM_ExtAPI::MemoryAlloc()
HM_ExtAPI::MemoryFree()
HM_ExtAPI::MeshGetDeviatingGridCount()
HM_ExtAPI::MeshGetElementCount()
HM_ExtAPI::MeshGetFirstDeviatingGrid()
HM_ExtAPI::MeshGetFirstElement()
HM_ExtAPI::MeshGetFirstGrid()
HM_ExtAPI::MeshGetGridCount()
HM_ExtAPI::MeshGetNextDeviatingGrid()
HM_ExtAPI::MeshGetNextElement()
HM_ExtAPI::MeshGetNextGrid()
HM_ExtAPI::OffsetFaces()
HM_ExtAPI::OffsetShellsByFaces()
HM_ExtAPI::PointLocateFace()
HM_ExtAPI::ReleaseGeomCurve()
HM_ExtAPI::ReleaseGeomSurface()
HM_ExtAPI::ReleaseMesh()
HM_ExtAPI::RunHMTclString()
HM_ExtAPI::SetInternalModelTolerance()
HM_ExtAPI::SetScratchFolder()
HM_ExtAPI::SurfaceComposedGetPatch()
HM_ExtAPI::SurfaceComposedGetSizes()
HM_ExtAPI::SurfaceConeGetData()
HM_ExtAPI::SurfaceCylinderGetData()
HM_ExtAPI::SurfaceExtrudedGetData()
HM_ExtAPI::SurfaceNURBSGetData()
HM_ExtAPI::SurfacePlaneGetData()
HM_ExtAPI::SurfaceRevolutionGetData()
HM_ExtAPI::SurfaceSphereGetData()
HM_ExtAPI::SurfaceTorusGetData()
Open_HM_ExtAPI()
Ext API Structures
Ext API Types
FE Input Readers
HMASCII
Model Checker
Scripts
Solver Templates
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::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::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(
HM_ExtAPI::CreateGeomFaceUntrimmed()
Creates face with rectangular parameterization in
HyperMesh
database.
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::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 coedge on corresponding face.
HM_ExtAPI::GeomCoedgeGetFace()
Returns face connected to the
coedge
.
HM_ExtAPI::GeomCoedgeGetGeometry()
Returns 2d curve that defines coedge geometry.
HM_ExtAPI::GeomCoedgeGetNextInLoop()
Returns next coedge in the face loop.
HM_ExtAPI::GeomCoedgeGetNextOnEdge()
Returns next coedge on the edge represented by the coedge.
HM_ExtAPI::GeomCoedgesConnect()
Connects coedges 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 coedge 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::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::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::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.
Open_HM_ExtAPI()
Opens
HyperMesh
session and returns pointer to API object.