MeshCubeRegionCollection

A collection of regions meshed with cubes.

Example

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

    -- Get a 'MeshCubeRegionCollection' of a specified mesh entity

meshCubeRegion = mesh.CubeRegions

    -- Get the 'Cubes' contained in a 'MeshCubeRegion' and the number of 'MeshCubeRegion'  
    -- items contained the 'MeshCubeRegionCollection'.

cubes = meshCubeRegion[1].Cubes
count = meshCubeRegion.Count

Usage locations

The MeshCubeRegionCollection object can be accessed from the following locations:

Property List

Count
The number of MeshCubeRegion 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 MeshCubeRegion at the given index. (Returns a MeshCubeRegion object.)
Item (label string)
Returns the MeshCubeRegion with the given label. (Returns a MeshCubeRegion object.)
Items ()
Returns a table of MeshCubeRegion. (Returns a List of MeshCubeRegion 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 MeshCubeRegion at the given index in the collection. (Read MeshCubeRegion)
[string]
Returns the MeshCubeRegion with the given name in the collection. (Read MeshCubeRegion)

Property Details

Count
The number of MeshCubeRegion 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 MeshCubeRegion.
Return
boolean
The success of the check.
Item (index number)
Returns the MeshCubeRegion at the given index.
Input Parameters
index(number)
The index of the MeshCubeRegion.
Return
MeshCubeRegion
The MeshCubeRegion at the given index.
Item (label string)
Returns the MeshCubeRegion with the given label.
Input Parameters
label(string)
The label of the MeshCubeRegion.
Return
MeshCubeRegion
The MeshCubeRegion with the given label.
Items ()
Returns a table of MeshCubeRegion.
Return
List of MeshCubeRegion
A table of MeshCubeRegion.
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 MeshCubeRegion.