Mesh

An editable mesh object.

Example

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

sphere = project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1)
project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e06"
project.Mesher:Mesh()
sphere:UnlinkMesh()

    -- Delete the created mesh

mesh = project.Contents.Meshes[1]
mesh:Delete()

Inheritance

The Mesh object is derived from the Object object.

Usage locations

The Mesh object can be accessed from the following locations:

Property List

BoundingBox
A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Included
A boolean value defining if an entity is excluded or included. (Read/Write boolean)
Label
The object label. (Read/Write string)
LocalMeshSettingsEnabled
Control if the locally defined mesh settings should be used for the entity. (Read/Write boolean)
LocalWorkplane
The source workplane. (Read/Write LocalWorkplane)
Locked
A boolean that indicates whether the entity or it's ancestor is locked or not. (Read/Write boolean)
MeshSettings
The locally defined mesh setting to use. This property is only available if LocalMeshSettingsEnabled is true. (Read/Write MeshSettings)
SimulationMeshStatus
The status of the simulation mesh. (Read only SimulationMeshStatusEnum)
Type
The object type string. (Read only string)

Collection List

CurvilinearFaces
The collection of faces meshed with curvilinear triangles. The faces form part of the mesh model. (MeshCurvilinearTriangleFaceCollection of MeshCurvilinearTriangleFace.)
CurvilinearWires
The collection of wires meshed with curvilinear segments. The wires form part of the mesh model. (MeshSegmentCurvilinearWireCollection of MeshCurvilinearWire.)
Cylinders
The collection of unmeshed cylinders that form part of the mesh model. (MeshCylinderCollection of MeshCylinder.)
Faces
The collection of faces meshed with flat triangles. The faces form part of the mesh model. (MeshTriangleFaceCollection of MeshTriangleFace.)
Plates
The collection of unmeshed plates that form part of the mesh model. (MeshPlateCollection of MeshPlate.)
Transforms
The collection of transforms on the operator. (TransformCollection of Transform.)
Wires
The collection of wires meshed with segments. The wires form part of the mesh model. (MeshSegmentWireCollection of MeshWire.)

Method List

AddTriangle (face MeshTriangleFace, vertex1 Point, vertex2 Point, vertex3 Point)
Adds a mesh triangle to an existing mesh face.
CopyAndMirror (properties table)
Apply a copy and mirror using a table defining the properties. (Returns a Object object.)
CopyAndRotate (properties table, count number)
Apply a copy and rotate using a table defining the properties. (Returns a List of Object object.)
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
Copy and rotate the geometry. (Returns a List of Object object.)
CopyAndTranslate (properties table, count number)
Apply a copy and translate using a table defining the properties. (Returns a List of Object object.)
CopyAndTranslate (from Point, to Point, count number)
Copy and translate the geometry. (Returns a List of Object object.)
CreateTriangle (vertex1 Point, vertex2 Point, vertex3 Point)
Creates a mesh triangle in a new mesh face. (Returns a MeshTriangleFace object.)
Delete ()
Deletes the entity.
DeleteMeshEntities (entities List of MeshTopology)
Deletes the given list of mesh entities.
DeleteSegments (segments List of MeshSegmentReference)
Delete segments from a mesh.
DeleteTriangles (triangles List of MeshTriangleReference)
Delete triangles from a mesh.
DeleteVertices (vertices List of MeshVertexReference, vertex MeshVertexReference)
Delete mesh vertices and merge to a common vertex.
Duplicate ()
Duplicates the entity. (Returns a Object object.)
GetAllMeshEntities ()
Returns all mesh entities that form part of the mesh model. (Returns a List of MeshTopology object.)
GetIndexForClosestVertexTo (point Point)
Gets the closest vertex, of the mesh element to the given point. (Returns a number 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.)
HasDistortedElements (mininternalangle number)
Checks if there are mesh elements that are distorted. This is calculated using the specified minimum internal angle. (Returns a boolean object.)
HasOversizedElements (maxlength number)
Checks if there are mesh elements that are oversized. This is calculated using a specified maximum length. (Returns a boolean object.)
HasOversizedTriangles (edgelength number)
Checks if there are mesh triangles that are oversized. This is calculated using a specified maximum edge length. (Returns a boolean object.)
MergeTopology (entities List of MeshTopology)
Merge mesh entities. (Returns a MeshTopology object.)
ModifySegmentRadius (segment MeshSegmentReference, radius number)
Modify the radius of a mesh segment.
ModifyVertex (vertex MeshVertexReference, position Point)
Modify the position of a mesh vertex.
Regroup (triangles List of MeshTriangleReference)
Group the given triangle mesh elements into a new mesh label removing from the original labels.
Regroup ()
Split the selected mesh part labels based on boundary edges.
Replace (replacementMesh Mesh)
Replace the the mesh with another mesh transferring the properties and ports to the new mesh. (Returns a Mesh object.)
ReverseElementNormals (triangles List of MeshTriangleReference)
Reverse the normals of the given triangle elements.
ReverseElementNormals ()
Reverses the element (e.g. MeshTriangle or MeshCurvilinearTriangle) normals of the 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.
UnlinkMesh (unlinkoption UnlinkMeshOptionEnum)
Unlinks the geometry's associated simulation mesh. (Returns a Mesh object.)

Static Function List

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

Property Details

BoundingBox
A box indicating the bounding box of this entity. (Read only Box).
Type
Box
Access
Read only
Included
A boolean value defining if an entity is excluded or included.
Type
boolean
Access
Read/Write
Label
The object label.
Type
string
Access
Read/Write
LocalMeshSettingsEnabled
Control if the locally defined mesh settings should be used for the entity.
Type
boolean
Access
Read/Write
LocalWorkplane
The source workplane.
Type
LocalWorkplane
Access
Read/Write
Locked
A boolean that indicates whether the entity or it's ancestor is locked or not.
Type
boolean
Access
Read/Write
MeshSettings
The locally defined mesh setting to use. This property is only available if LocalMeshSettingsEnabled is true.
Type
MeshSettings
Access
Read/Write
SimulationMeshStatus
The status of the simulation mesh.
Type
SimulationMeshStatusEnum
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Collection Details

CurvilinearFaces
The collection of faces meshed with curvilinear triangles. The faces form part of the mesh model.
Type
MeshCurvilinearTriangleFaceCollection
CurvilinearWires
The collection of wires meshed with curvilinear segments. The wires form part of the mesh model.
Type
MeshSegmentCurvilinearWireCollection
Cylinders
The collection of unmeshed cylinders that form part of the mesh model.
Type
MeshCylinderCollection
Faces
The collection of faces meshed with flat triangles. The faces form part of the mesh model.
Type
MeshTriangleFaceCollection
Plates
The collection of unmeshed plates that form part of the mesh model.
Type
MeshPlateCollection
Transforms
The collection of transforms on the operator.
Type
TransformCollection
Wires
The collection of wires meshed with segments. The wires form part of the mesh model.
Type
MeshSegmentWireCollection

Method Details

AddTriangle (face MeshTriangleFace, vertex1 Point, vertex2 Point, vertex3 Point)
Adds a mesh triangle to an existing mesh face.
Input Parameters
face(MeshTriangleFace)
The mesh face that the triangle should be added to.
vertex1(Point)
The first vertex of the triangle.
vertex2(Point)
The second vertex of the triangle.
vertex3(Point)
The third vertex of the triangle.
CopyAndMirror (properties table)
Apply a copy and mirror using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the mirror transform.
Return
Object
The mirrored geometry.
CopyAndRotate (properties table, count number)
Apply a copy and rotate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the rotate transform.
count(number)
The number of transform copies.
Return
List of Object
The list of rotated geometry.
CopyAndRotate (origin Point, rotationaxis Vector, angle number, count number)
Copy and rotate the geometry.
Input Parameters
origin(Point)
The coordinates of the origin of the rotation.
rotationaxis(Vector)
The axis of rotation.
angle(number)
The angle of rotation (degrees).
count(number)
The number of copies.
Return
List of Object
The list of rotated geometry.
CopyAndTranslate (properties table, count number)
Apply a copy and translate using a table defining the properties.
Input Parameters
properties(table)
A table of properties defining the translate transform.
count(number)
The number of transform copies.
Return
List of Object
The list of translated geometry.
CopyAndTranslate (from Point, to Point, count number)
Copy and translate the geometry.
Input Parameters
from(Point)
Translate from coordinate.
to(Point)
Translate to coordinate.
count(number)
The number of copies.
Return
List of Object
The list of translated geometry.
CreateTriangle (vertex1 Point, vertex2 Point, vertex3 Point)
Creates a mesh triangle in a new mesh face.
Input Parameters
vertex1(Point)
The first vertex of the triangle.
vertex2(Point)
The first vertex of the triangle.
vertex3(Point)
The first vertex of the triangle.
Return
MeshTriangleFace
Returns a mesh triangle.
Delete ()
Deletes the entity.
DeleteMeshEntities (entities List of MeshTopology)
Deletes the given list of mesh entities.
Input Parameters
entities(List of MeshTopology)
The list of entities to delete.
DeleteSegments (segments List of MeshSegmentReference)
Delete segments from a mesh.
Input Parameters
segments(List of MeshSegmentReference)
The list of segments to be deleted.
DeleteTriangles (triangles List of MeshTriangleReference)
Delete triangles from a mesh.
Input Parameters
triangles(List of MeshTriangleReference)
The list of triangles to be deleted.
DeleteVertices (vertices List of MeshVertexReference, vertex MeshVertexReference)
Delete mesh vertices and merge to a common vertex.
Input Parameters
vertices(List of MeshVertexReference)
Vertices that will be deleted.
vertex(MeshVertexReference)
Vertex that will be merged to.
Duplicate ()
Duplicates the entity.
Return
Object
The new (duplicated) entity.
GetAllMeshEntities ()
Returns all mesh entities that form part of the mesh model.
Return
List of MeshTopology
All mesh entities that form part of the mesh model.
GetIndexForClosestVertexTo (point Point)
Gets the closest vertex, of the mesh element to the given point.
Input Parameters
point(Point)
The point to query against.
Return
number
The closest vertex of the element to the point.
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.
HasDistortedElements (mininternalangle number)
Checks if there are mesh elements that are distorted. This is calculated using the specified minimum internal angle.
Input Parameters
mininternalangle(number)
The minimum internal angle given in degrees.
Return
boolean
Returns true if there are distorted mesh elements.
HasOversizedElements (maxlength number)
Checks if there are mesh elements that are oversized. This is calculated using a specified maximum length.
Input Parameters
maxlength(number)
The maximum length.
Return
boolean
Returns true if there are oversized mesh elements.
HasOversizedTriangles (edgelength number)
Checks if there are mesh triangles that are oversized. This is calculated using a specified maximum edge length.
Input Parameters
edgelength(number)
The maximum edge length.
Return
boolean
Returns true if there are oversized mesh elements.
MergeTopology (entities List of MeshTopology)
Merge mesh entities.
Input Parameters
entities(List of MeshTopology)
List of merge entities.
Return
MeshTopology
Returns the merged mesh topology.
ModifySegmentRadius (segment MeshSegmentReference, radius number)
Modify the radius of a mesh segment.
Input Parameters
segment(MeshSegmentReference)
The segment to be modified.
radius(number)
The radius to set the segment to.
ModifyVertex (vertex MeshVertexReference, position Point)
Modify the position of a mesh vertex.
Input Parameters
vertex(MeshVertexReference)
The vertex to be modified.
position(Point)
The new position of the vertex.
Regroup (triangles List of MeshTriangleReference)
Group the given triangle mesh elements into a new mesh label removing from the original labels.
Input Parameters
triangles(List of MeshTriangleReference)
The list of triangles to be grouped.
Regroup ()
Split the selected mesh part labels based on boundary edges.
Replace (replacementMesh Mesh)
Replace the the mesh with another mesh transferring the properties and ports to the new mesh.
Input Parameters
replacementMesh(Mesh)
The target replacement mesh.
Return
Mesh
The resulting mesh.
ReverseElementNormals (triangles List of MeshTriangleReference)
Reverse the normals of the given triangle elements.
Input Parameters
triangles(List of MeshTriangleReference)
The list of triangles to be reversed.
ReverseElementNormals ()
Reverses the element (e.g. MeshTriangle or MeshCurvilinearTriangle) normals of the 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.
UnlinkMesh (unlinkoption UnlinkMeshOptionEnum)
Unlinks the geometry's associated simulation mesh.
Input Parameters
unlinkoption(UnlinkMeshOptionEnum)
Mesh ports are created. Solution entities are either keep with their original assignment or reassigned to the new port.
Return
Mesh
The unlinked mesh.

Static Function Details

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