`MeshUnmeshedCylinderRegionCollection`

A collection of unmeshed cylinders that are part of a mesh model.

Example

app = cf.GetApplication()
project = app:NewProject()
    -- Set the frequency
	
project.SolutionConfigurations[1].Frequency.Start = "1e08"

    -- Create geometry, set the solution method to UTD
    
cylinder = project.Geometry:AddCylinder(cf.Point(-0.25,-0.25,0), 0.5, 1.0)
cylinder.Regions["Region1"].SolutionMethod = cf.Enums.RegionSolutionMethodEnum.UTD

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

    -- Obtain the 'MeshedUnmeshedCylinderRegionCollection'

meshUnmeshedCylinderRegions = project.Meshes["Cylinder1_1"].UnmeshedCylinderRegions

    -- Obtain a specific cylinder from the collection

meshUnmeshedCylinderRegion = meshUnmeshedCylinderRegions["Face3"]

Usage locations (collections)

The following objects contain the MeshUnmeshedCylinderRegionCollection collection:

Mesh(.UnmeshedCylinderRegions)

Property List

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

Property Details

Count

The number of MeshUnmeshedCylinderRegion 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 MeshUnmeshedCylinderRegion.

Return

boolean: The success of the check.

Item (index number)

Returns the MeshUnmeshedCylinderRegion at the given index.

Input Parameters

index(number): The index of the MeshUnmeshedCylinderRegion.

Return

MeshUnmeshedCylinderRegion: The MeshUnmeshedCylinderRegion at the given index.

Item (label string)

Returns the MeshUnmeshedCylinderRegion with the given label.

Input Parameters

label(string): The label of the MeshUnmeshedCylinderRegion.

Return

MeshUnmeshedCylinderRegion: The MeshUnmeshedCylinderRegion with the given label.

Items ()

Returns a table of MeshUnmeshedCylinderRegion.

Return

List of MeshUnmeshedCylinderRegion: A table of MeshUnmeshedCylinderRegion.

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 MeshUnmeshedCylinderRegion.