MeshSegmentWire
A mesh entity representing a wire meshed using segments.
Example
application = cf.Application.GetInstance() project = application:NewProject() -- Settings for normal meshing advancedMeshSettings = project.Mesher.Settings.Advanced advancedMeshSettings.CurvilinearSegments = cf.Enums.MeshCurvilinearOptionsEnum.Disabled project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08" -- Create geometry and mesh project.Contents.Geometry:AddHelix(cf.Point(0,0,0), 0.1, 0.1, 1.0, 5.0, false) project.Mesher.Settings.WireRadius = "0.01" project.Mesher:Mesh() project.Contents.Geometry["Helix1"]:UnlinkMesh() meshSegmentWires = project.Contents.Meshes["Helix1_1"].Wires -- 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 MeshWire object.
Property List
- AllowDifferentSegmentRadii
- Allow modification of radii per segment. (Read/Write boolean)
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
- Coating
- The wire (free edge) coating specified by a predefined Layered dielectric medium. Changing this property will set CoatingEnabled to true. Only applicable for wires (free edges). (Read/Write Medium)
- CoatingEnabled
- Specifies if a coating should be applied to the wire.Only applicable for wires (free edges). (Read/Write boolean)
- CoreMedium
- The wire core medium.Only applicable for wires (free edges). (Read/Write Medium)
- EdgeType
- The type of edge. (Read only GeometryEdgeEnum)
- Label
- The object label. (Read/Write string)
- Length
- The accumulative length of all the segments of the wire. (Read only number)
- LocalIntrinsicWireRadiusEnabled
- Specifies if the local intrinsic wire radius should be used for the wire. Only applicable for wires (free edges). (Read/Write boolean)
- LocalMeshSize
- The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to true. (Read/Write ParametricExpression)
- LocalMeshSizeEnabled
- Specifies if the local mesh size should be used for the wire/edge. (Read/Write boolean)
- LocalWireRadius
- The local radius for the wire. Changing this property will set LocalWireRadiusEnabled to true. Only applicable for wires (free edges). (Read/Write ParametricExpression)
- LocalWireRadiusEnabled
- Specifies if the local wire radius should be used for the wire. Only applicable for wires (free edges). (Read/Write boolean)
- Part
- The mesh part that this entity belongs to. (Read only Mesh)
- PreserveEntityEnabled
- Preserve the entity during meshing. (Read/Write boolean)
- 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/Write WindscreenSolutionMethod)
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.
- SetRadiusOnAllSegments (radius Expression)
- Set the segment radius. This is a helper method to update the Radius property on all the segments simultaneously.
Static Function List
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object. (Returns a table object.)
Property Details
- AllowDifferentSegmentRadii
- Allow modification of radii per segment.
- Type
- boolean
- Access
- Read/Write
- BoundingBox
- A box indicating the bounding box of this entity. (Read only Box).
- Type
- Box
- Access
- Read only
- Coating
- The wire (free edge) coating specified by a predefined Layered dielectric medium. Changing this property will set CoatingEnabled to true. Only applicable for wires (free edges).
- Type
- Medium
- Access
- Read/Write
- CoatingEnabled
- Specifies if a coating should be applied to the wire.Only applicable for wires (free edges).
- Type
- boolean
- Access
- Read/Write
- CoreMedium
- The wire core medium.Only applicable for wires (free edges).
- Type
- Medium
- Access
- Read/Write
- EdgeType
- The type of edge.
- Type
- GeometryEdgeEnum
- Access
- Read only
- 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
- LocalIntrinsicWireRadiusEnabled
- Specifies if the local intrinsic wire radius should be used for the wire. Only applicable for wires (free edges).
- Type
- boolean
- Access
- Read/Write
- LocalMeshSize
- The local mesh size for the wire/edge. Changing this property will set LocalMeshSizeEnabled to true.
- Type
- ParametricExpression
- Access
- Read/Write
- LocalMeshSizeEnabled
- Specifies if the local mesh size should be used for the wire/edge.
- Type
- boolean
- Access
- Read/Write
- LocalWireRadius
- The local radius for the wire. Changing this property will set LocalWireRadiusEnabled to true. Only applicable for wires (free edges).
- Type
- ParametricExpression
- Access
- Read/Write
- LocalWireRadiusEnabled
- Specifies if the local wire radius should be used for the wire. Only applicable for wires (free edges).
- Type
- boolean
- Access
- Read/Write
- Part
- The mesh part that this entity belongs to.
- Type
- Mesh
- Access
- Read only
- PreserveEntityEnabled
- Preserve the entity during meshing.
- Type
- boolean
- Access
- Read/Write
- 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/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.
- 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.
- 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.
Static Function Details
- GetDefaultProperties ()
- Creates a table containing the default settings to create an object.
- Return
- table
- A table containing the default properties.