MeshCylinderCollection

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

Example

application = cf.Application.getInstance()
project = application:NewProject()

    -- Set the frequency

project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08"

    -- Create geometry, set the solution method to UTD

cylinder = project.Contents.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.Contents.Geometry["Cylinder1"]:UnlinkMesh()

    -- Obtain the 'MeshCylindersCollection'

meshCylinders = project.Contents.Meshes["Cylinder1_1"].Cylinders

    -- Obtain a specific region from the collection

meshCylinderRegion = meshCylinders["Region1"]

Inheritance

The MeshCylinderCollection object is derived from the Object object.

Usage locations

The MeshCylinderCollection object can be accessed from the following locations:

Property List

Count
The number of MeshCylinder items in the collection. (Read only number)
Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Method List

Delete ()
Deletes the entity.
DeleteEntities ( List of Object)
Delete the given list of entities from the collection.
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.)
Item (index number)
Returns the MeshCylinder for the given index in the collection. (Returns a MeshCylinder object.)
Item (label string)
Returns the MeshCylinder for the given label in the collection. (Returns a MeshCylinder object.)
Items ()
Returns a table of MeshCylinder items. (Returns a UnsupportedType(List of MeshCylinder) 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.

Static Function List

GetDefaultProperties ()
Creates a table containing the default settings to create an object. (Returns a table object.)

Property Details

Count
The number of MeshCylinder items in the collection.
Type
number
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Method Details

Delete ()
Deletes the entity.
DeleteEntities ( List of Object)
Delete the given list of entities from the collection.
Input Parameters
(List of Object)
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.
Item (index number)
Returns the MeshCylinder for the given index in the collection.
Input Parameters
index(number)
The index of the MeshCylinder.
Return
MeshCylinder
The item in the collection
Item (label string)
Returns the MeshCylinder for the given label in the collection.
Input Parameters
label(string)
The label of the MeshCylinder.
Return
MeshCylinder
The item in the collection
Items ()
Returns a table of MeshCylinder items.
Return
UnsupportedType(List of MeshCylinder)
The list of items in the collection
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.

Static Function Details

GetDefaultProperties ()
Creates a table containing the default settings to create an object.
Return
table
A table containing the default properties.