MeshCurvilinearSegmentWireCollection

A collection of wires meshed with curvilinear segments.

Example

app = pf.GetApplication()
app:NewProject()
app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Helix_dipole.fek]])
sConf = app.Models["Helix_dipole"].Configurations[1]
mesh = sConf.Mesh

    -- Get the collection of 'MeshCurvilinearWire's
    
meshCurvilinearWireSegments = mesh.CurvilinearSegmentWires

    -- Query the number of items in the collection

numberOfWireSegments = #meshCurvilinearWireSegments

Usage locations

The MeshCurvilinearSegmentWireCollection object can be accessed from the following locations:

Property List

Count
The number of MeshCurvilinearSegmentWire items in the collection. (Read only number)
Type
The object type string. (Read only string)

Method List

Contains (label string)
Checks if the collection contains an item with the given label. (Returns a boolean object.)
Item (index number)
Returns the MeshCurvilinearSegmentWire at the given index. (Returns a MeshCurvilinearSegmentWire object.)
Item (label string)
Returns the MeshCurvilinearSegmentWire with the given label. (Returns a MeshCurvilinearSegmentWire object.)
Items ()
Returns a table of MeshCurvilinearSegmentWire. (Returns a List of MeshCurvilinearSegmentWire object.)
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated. (Returns a boolean object.)

Index List

[number]
Returns the MeshCurvilinearSegmentWire at the given index in the collection. (Read MeshCurvilinearSegmentWire)
[string]
Returns the MeshCurvilinearSegmentWire with the given name in the collection. (Read MeshCurvilinearSegmentWire)

Property Details

Count
The number of MeshCurvilinearSegmentWire items in the collection.
Type
number
Access
Read only
Type
The object type string.
Type
string
Access
Read only

Method Details

Contains (label string)
Checks if the collection contains an item with the given label.
Input Parameters
label(string)
The label of the MeshCurvilinearSegmentWire.
Return
boolean
The success of the check.
Item (index number)
Returns the MeshCurvilinearSegmentWire at the given index.
Input Parameters
index(number)
The index of the MeshCurvilinearSegmentWire.
Return
MeshCurvilinearSegmentWire
The MeshCurvilinearSegmentWire at the given index.
Item (label string)
Returns the MeshCurvilinearSegmentWire with the given label.
Input Parameters
label(string)
The label of the MeshCurvilinearSegmentWire.
Return
MeshCurvilinearSegmentWire
The MeshCurvilinearSegmentWire with the given label.
Items ()
Returns a table of MeshCurvilinearSegmentWire.
Return
List of MeshCurvilinearSegmentWire
A table of MeshCurvilinearSegmentWire.
UniqueName (label string)
Generates a unique name base of of the provided base name.If the base name already exists in the collection, a digit will be appended until a valid name is generated.
Input Parameters
label(string)
The base name.
Return
boolean
The generated unique name label for MeshCurvilinearSegmentWire.