MeshImporter

The mesh importer.

Example

application = cf.Application.GetInstance()
project = application:NewProject()

    -- Auto determine the mesh file type and import it into the current project

project.Importer.MeshImporter:Import(FEKO_HOME..[[/shared/Resources/Automation/demo_RM.nas]])

Inheritance

The MeshImporter object is derived from the Object object.

Usage locations

The MeshImporter object can be accessed from the following locations:

Property List

ConversionType
Conversion type. Only valid when the file format is Voxel mesh. (Read/Write ImportMeshConversionTypeEnum)
CylinderImportingEnabled
Enables mesh cylinder importing. Only applicable when the file format is ABAQUS, ASCII, AutoCAD, CADFEKO mesh, CDB, CFM, FEMAP, Feko HyperMesh, GID, I-DEAS UNV, NASTRAN, NEC, PATRAN or UNV. (Read/Write boolean)
GroupPartsByLabelEnabled
Group into separate parts (using labels). (Read/Write boolean)
Label
The object label. (Read/Write string)
MeshMergingMediaEnabled
Enables merging identical media while importing mesh. Only applicable when the file format is Voxel mesh. (Read/Write boolean)
MeshRelabelingEnabled
Re-label mesh using the *.map file (when available). Only applicable when the file format is NASTRAN. (Read/Write boolean)
PolygonImportingEnabled
Enables mesh polygon importing. Only applicable when the file format is ASCII, CADFEKO mesh, FEMAP or Feko HyperMesh. (Read/Write boolean)
Prefix
Merge identical media with a prefix. Only applicable when the file format is Voxel mesh. (Read/Write string)
QuadrangleImportingEnabled
Enables mesh quadrangle importing. Only applicable when the file format is ABAQUS, ANSYS, FEMAP, Feko HyperMesh, GID, NASTRAN or PATRAN. For the AutoCAD file format, use the TriangleImportingEnabled property to import quadrangles. (Read/Write boolean)
ScaleFactor
Scale factor if the imported mesh is not in metres. Only applicable when the file format is ABAQUS, ANSYS, ASCII, AutoCAD, CONCEPT, FEMAP, GID, NASTRAN, PATRAN, STL or Voxel mesh. (Read/Write ParametricExpression)
SegmentImportingEnabled
Enables mesh segment importing. Only applicable when the file format is ABAQUS, ANSYS, ASCII, AutoCAD, CADFEKO mesh, FEMAP, Feko HyperMesh, GID, I-DEAS UNV, NASTRAN, NEC or PATRAN. (Read/Write boolean)
SegmentLength
Line elements divided in segments according to this length. Only applicable when the file format is AutoCAD. (Read/Write ParametricExpression)
TetrahedronImportingEnabled
Enables mesh tetrahedron importing. Only applicable when the file format is ABAQUS, ANSYS, ASCII, CADFEKO mesh, FEMAP, Feko HyperMesh, GID, NASTRAN or PATRAN. (Read/Write boolean)
TriangleImportingEnabled
Enables mesh triangle importing. Only applicable when the file format is ABAQUS, ANSYS, ASCII, AutoCAD, CADFEKO mesh, FEMAP, Feko HyperMesh, GID, I-DEAS UNV, NASTRAN or PATRAN. For the AutoCAD file format, quadrangles are imported as well. (Read/Write boolean)
Type
The object type string. (Read only string)
VertexTolerance
The mesh vertex tolerance. Only applicable when the file format is ABAQUS, ANSYS, ASCII, AutoCAD, CONCEPT, FEMAP, GID, NASTRAN, NEC, PATRAN or STL. (Read/Write ParametricExpression)
WireRadius
The default wire radius. Only applicable when the file format is ABAQUS, ANSYS, ASCII, AutoCAD, CONCEPT, FEMAP, GID, NASTRAN, PATRAN, STL or UNV. (Read/Write ParametricExpression)

Method List

Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity. (Returns a Object object.)
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step. (Returns a table object.)
Import (filename string)
Import the specified file. (Returns a List of Mesh object.)
SetProperties (properties Object)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

ConversionType
Conversion type. Only valid when the file format is Voxel mesh.
Type
ImportMeshConversionTypeEnum
Access
Read/Write
CylinderImportingEnabled
Enables mesh cylinder importing. Only applicable when the file format is ABAQUS, ASCII, AutoCAD, CADFEKO mesh, CDB, CFM, FEMAP, Feko HyperMesh, GID, I-DEAS UNV, NASTRAN, NEC, PATRAN or UNV.
Type
boolean
Access
Read/Write
GroupPartsByLabelEnabled
Group into separate parts (using labels).
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
MeshMergingMediaEnabled
Enables merging identical media while importing mesh. Only applicable when the file format is Voxel mesh.
Type
boolean
Access
Read/Write
MeshRelabelingEnabled
Re-label mesh using the *.map file (when available). Only applicable when the file format is NASTRAN.
Type
boolean
Access
Read/Write
PolygonImportingEnabled
Enables mesh polygon importing. Only applicable when the file format is ASCII, CADFEKO mesh, FEMAP or Feko HyperMesh.
Type
boolean
Access
Read/Write
Prefix
Merge identical media with a prefix. Only applicable when the file format is Voxel mesh.
Type
string
Access
Read/Write
QuadrangleImportingEnabled
Enables mesh quadrangle importing. Only applicable when the file format is ABAQUS, ANSYS, FEMAP, Feko HyperMesh, GID, NASTRAN or PATRAN. For the AutoCAD file format, use the TriangleImportingEnabled property to import quadrangles.
Type
boolean
Access
Read/Write
ScaleFactor
Scale factor if the imported mesh is not in metres. Only applicable when the file format is ABAQUS, ANSYS, ASCII, AutoCAD, CONCEPT, FEMAP, GID, NASTRAN, PATRAN, STL or Voxel mesh.
Type
ParametricExpression
Access
Read/Write
SegmentImportingEnabled
Enables mesh segment importing. Only applicable when the file format is ABAQUS, ANSYS, ASCII, AutoCAD, CADFEKO mesh, FEMAP, Feko HyperMesh, GID, I-DEAS UNV, NASTRAN, NEC or PATRAN.
Type
boolean
Access
Read/Write
SegmentLength
Line elements divided in segments according to this length. Only applicable when the file format is AutoCAD.
Type
ParametricExpression
Access
Read/Write
TetrahedronImportingEnabled
Enables mesh tetrahedron importing. Only applicable when the file format is ABAQUS, ANSYS, ASCII, CADFEKO mesh, FEMAP, Feko HyperMesh, GID, NASTRAN or PATRAN.
Type
boolean
Access
Read/Write
TriangleImportingEnabled
Enables mesh triangle importing. Only applicable when the file format is ABAQUS, ANSYS, ASCII, AutoCAD, CADFEKO mesh, FEMAP, Feko HyperMesh, GID, I-DEAS UNV, NASTRAN or PATRAN. For the AutoCAD file format, quadrangles are imported as well.
Type
boolean
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only
VertexTolerance
The mesh vertex tolerance. Only applicable when the file format is ABAQUS, ANSYS, ASCII, AutoCAD, CONCEPT, FEMAP, GID, NASTRAN, NEC, PATRAN or STL.
Type
ParametricExpression
Access
Read/Write
WireRadius
The default wire radius. Only applicable when the file format is ABAQUS, ANSYS, ASCII, AutoCAD, CONCEPT, FEMAP, GID, NASTRAN, PATRAN, STL or UNV.
Type
ParametricExpression
Access
Read/Write

Method Details

Delete ()
Deletes the entity.
Duplicate ()
Duplicates the entity.
Return
Object
The new (duplicated) entity.
GetProperties ()
Returns a table of properties representing the state of the object. The properties table can be used with the SetProperties method to change multiple properties of the object in one step.
Return
table
A table defining the properties.
Import (filename string)
Import the specified file.
Input Parameters
filename(string)
The name of the file to be imported.
Return
List of Mesh
The imported mesh.
SetProperties (properties Object)
Modifies the state of the object using the provided table of properties. This method is used to modify multiple properties of the object in a single step.
Input Parameters
properties(Object)
A table of properties defining the new state of the object.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.