MeshSegmentWire
A mesh entity representing a wire meshed using segments.
Example
app = cf.GetApplication() project = app:NewProject() -- Settings for normal meshing project.Mesher.Settings.WireRadius = "0.01" advancedMeshSettings = project.Mesher.Settings.Advanced advancedMeshSettings.CurvilinearSegments = cf.Enums.MeshCurvilinearOptionsEnum.Disabled project.SolutionConfigurations[1].Frequency.Start = "1e08" -- Create geometry and mesh project.Geometry:AddHelix(cf.Point(0,0,0), 0.1, 0.1, 1.0, 5.0, false) project.Mesher:Mesh() project.Geometry["Helix1"]:UnlinkMesh() meshSegmentWires = project.Meshes["Helix1_1"].SegmentWires -- Retrieve a specific wire from the collection. meshSegmentWire = meshSegmentWires["Wire1"] -- Set the radius on all the segments meshSegmentWire:SetRadiusOnAllSegments(0.1)
Inheritance
The MeshSegmentWire object is derived from the MeshEntity object.
Property List
- Coating
- The wire coating specified by a predefined layered dielectric medium. Changing this property will set CoatingEnabled to true. (Read/Write Medium)
- CoatingEnabled
- Specifies if a coating should be applied to the wire. (Read/Write boolean)
- CoreMedium
- The wire medium. (Read/Write Medium)
- Label
- The object label. (Read/Write string)
- Length
- The accumulative length of all the segments of the wire. (Read only number)
- Part
- The mesh part that this entity belongs to. (Read only Mesh)
- Segments
- The list of mesh segments that form the mesh wire. (Read only MeshSegments)
- SolutionMethod
- The local solution method used for the wire. (Read/Write EdgeSolutionMethodEnum)
- SurroundingMedium
- The surrounding region medium. (Read/Write Medium)
- Type
- The object type string. (Read only string)
- Windscreen
- The windscreen solution method settings for the wire. Only applies if the SolutionMethod is set to Windscreen. (Read only WindscreenSolutionMethod)
Method List
- Delete ()
- Delete the MeshEntity.
- 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 table)
- 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.
- SetRadiusOnAllSegments (radius Expression)
- Set the segment radius. This is a helper method to update the Radius property on all the segments simultaneously.
Property Details
- Coating
- The wire coating specified by a predefined layered dielectric medium. Changing this property will set CoatingEnabled to true.
- Type
- Medium
- Access
- Read/Write
- CoatingEnabled
- Specifies if a coating should be applied to the wire.
- Type
- boolean
- Access
- Read/Write
- CoreMedium
- The wire medium.
- Type
- Medium
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- Length
- The accumulative length of all the segments of the wire.
- Type
- number
- Access
- Read only
- Part
- The mesh part that this entity belongs to.
- Type
- Mesh
- Access
- Read only
- Segments
- The list of mesh segments that form the mesh wire.
- Type
- MeshSegments
- Access
- Read only
- SolutionMethod
- The local solution method used for the wire.
- Type
- EdgeSolutionMethodEnum
- Access
- Read/Write
- SurroundingMedium
- The surrounding region medium.
- Type
- Medium
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
- Windscreen
- The windscreen solution method settings for the wire. Only applies if the SolutionMethod is set to Windscreen.
- Type
- WindscreenSolutionMethod
- Access
- Read only
Method Details
- Delete ()
- Delete the MeshEntity.
- 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 properties table.
- SetProperties (properties table)
- 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(table)
- A table of properties defining the new state of the object.
- SetRadiusOnAllSegments (radius Expression)
- Set the segment radius. This is a helper method to update the Radius property on all the segments simultaneously.
- Input Parameters
- radius(Expression)
- The new radius.