ModelMeshInfo

The quality of the mesh can be examined through these properties.

Example

application = cf.Application.getInstance()
project = application:Load({FEKO_HOME..[[/shared/Resources/Automation/Waveguide_Divider.cfx]]})
geometry = project.Contents.Geometry["Union2"]

    -- Get the triangle count of the simulation mesh

triangleCount = geometry.TriangleCount

    -- Ensure the average edge length of the model mesh is smaller than 2.0

mesh = geometry:UnlinkMesh()
assert(mesh.ModelMeshInfo.AverageEdgeLength < 2.0)

Inheritance

The ModelMeshInfo object is derived from the Object object.

Usage locations

The ModelMeshInfo object can be accessed from the following locations:

  • Properties

Property List

AverageCurvilinearEdgeLength
The average mesh curvilinear edge length. (Read only number)
AverageCurvilinearSegmentLength
The average mesh curvilinear segment length. (Read only number)
AverageEdgeLength
The average mesh edge length. (Read only number)
AverageSegmentLength
The average mesh segment length. (Read only number)
AverageVoxelLength
The average mesh voxel length. (Read only number)
CableSegmentCount
Get the total number of cable segment elements. (Read only number)
CurvilinearEdgeStandardDeviation
The standard deviation of curvilinear mesh edge length. (Read only number)
CurvilinearSegmentCount
The number of curvilinear line segments in the mesh. (Read only number)
CurvilinearSegmentStandardDeviation
The standard deviation of mesh curvilinear segment length. (Read only number)
CurvilinearTriangleCount
The number of curvilinear triangles in the mesh. (Read only number)
EdgeStandardDeviation
The standard deviation of mesh edge length. (Read only number)
Label
The object label. (Read/Write string)
MaximumCurvilinearEdgeLength
The maximum mesh curvilinear edge length. (Read only number)
MaximumCurvilinearSegmentLength
The maximum mesh curvilinear segment length. (Read only number)
MaximumEdgeLength
The maximum mesh edge length. (Read only number)
MaximumElementAngle
The maximum mesh element angle. (Read only number)
MaximumSegmentLength
The maximum mesh segment length. (Read only number)
MaximumVoxelLength
The maximum mesh voxel length. (Read only number)
MeshElementCount
Get the total number of mesh elements. (Read only number)
MinimumCurvilinearEdgeLength
The minimum mesh curvilinear edge length. (Read only number)
MinimumCurvilinearSegmentLength
The minimum mesh curvilinear segment length. (Read only number)
MinimumEdgeLength
The minimum mesh edge length. (Read only number)
MinimumElementAngle
The minimum mesh element angle. (Read only number)
MinimumSegmentLength
The minimum mesh segment length. (Read only number)
MinimumVoxelLength
The minimum mesh voxel length. (Read only number)
PolygonCount
The total number of polygons in the mesh. (Read only number)
SegmentCount
The total number of segments in the mesh. (Read only number)
SegmentStandardDeviation
The standard deviation of mesh segment length. (Read only number)
TetrahedronCount
The total number of tetrahedra in the mesh. (Read only number)
TriangleCount
The number of triangles in the mesh. This is including both flat and curvilinear triangles. (Read only number)
Type
The object type string. (Read only string)
VoxelCount
The number of FDTD voxels in the mesh. (Read only number)
VoxelStandardDeviation
The standard deviation of mesh voxel length. (Read only number)

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.)
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

AverageCurvilinearEdgeLength
The average mesh curvilinear edge length.
Type
number
Access
Read only
AverageCurvilinearSegmentLength
The average mesh curvilinear segment length.
Type
number
Access
Read only
AverageEdgeLength
The average mesh edge length.
Type
number
Access
Read only
AverageSegmentLength
The average mesh segment length.
Type
number
Access
Read only
AverageVoxelLength
The average mesh voxel length.
Type
number
Access
Read only
CableSegmentCount
Get the total number of cable segment elements.
Type
number
Access
Read only
CurvilinearEdgeStandardDeviation
The standard deviation of curvilinear mesh edge length.
Type
number
Access
Read only
CurvilinearSegmentCount
The number of curvilinear line segments in the mesh.
Type
number
Access
Read only
CurvilinearSegmentStandardDeviation
The standard deviation of mesh curvilinear segment length.
Type
number
Access
Read only
CurvilinearTriangleCount
The number of curvilinear triangles in the mesh.
Type
number
Access
Read only
EdgeStandardDeviation
The standard deviation of mesh edge length.
Type
number
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
MaximumCurvilinearEdgeLength
The maximum mesh curvilinear edge length.
Type
number
Access
Read only
MaximumCurvilinearSegmentLength
The maximum mesh curvilinear segment length.
Type
number
Access
Read only
MaximumEdgeLength
The maximum mesh edge length.
Type
number
Access
Read only
MaximumElementAngle
The maximum mesh element angle.
Type
number
Access
Read only
MaximumSegmentLength
The maximum mesh segment length.
Type
number
Access
Read only
MaximumVoxelLength
The maximum mesh voxel length.
Type
number
Access
Read only
MeshElementCount
Get the total number of mesh elements.
Type
number
Access
Read only
MinimumCurvilinearEdgeLength
The minimum mesh curvilinear edge length.
Type
number
Access
Read only
MinimumCurvilinearSegmentLength
The minimum mesh curvilinear segment length.
Type
number
Access
Read only
MinimumEdgeLength
The minimum mesh edge length.
Type
number
Access
Read only
MinimumElementAngle
The minimum mesh element angle.
Type
number
Access
Read only
MinimumSegmentLength
The minimum mesh segment length.
Type
number
Access
Read only
MinimumVoxelLength
The minimum mesh voxel length.
Type
number
Access
Read only
PolygonCount
The total number of polygons in the mesh.
Type
number
Access
Read only
SegmentCount
The total number of segments in the mesh.
Type
number
Access
Read only
SegmentStandardDeviation
The standard deviation of mesh segment length.
Type
number
Access
Read only
TetrahedronCount
The total number of tetrahedra in the mesh.
Type
number
Access
Read only
TriangleCount
The number of triangles in the mesh. This is including both flat and curvilinear triangles.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only
VoxelCount
The number of FDTD voxels in the mesh.
Type
number
Access
Read only
VoxelStandardDeviation
The standard deviation of mesh voxel length.
Type
number
Access
Read only

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.
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.