MeshTetrahedronRegionCollection

A collection of regions meshed with tetrahedra.

Example

app = cf.GetApplication()
project = app:NewProject()

    -- Set the frequency

project.SolutionConfigurations[1].Frequency.Start = "1e08"

    -- Create geometry, set the solution method and mesh.
    
cuboid = project.Geometry:AddCuboidAtCentre(cf.Point(0,0,0), 1.0, 1.0, 1.0)
dielectric = project.Media:AddDielectric(0.01,0.01,0.01)
cuboid.Regions["Region1"].Medium = dielectric
cuboid.Regions["Region1"].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.FEM

	-- Mesh
	
project.Mesher:Mesh()
project.Geometry["Cuboid1"]:UnlinkMesh()

    -- Obtain the 'TetrahedronRegionCollection'

tetrahedronRegions = project.Meshes["Cuboid1_1"].TetrahedronRegions
    
    -- Store the number of tetragon regions in the collection
    
tetrahedronRegionsCount = tetrahedronRegions.Count

Usage locations (collections)

The following objects contain the MeshTetrahedronRegionCollection collection:

Property List

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

Property Details

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