MeshTetrahedronRegionCollection
A collection of regions meshed with tetrahedra.
Example
application = cf.Application.getInstance() project = application:NewProject() -- Set the frequency project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e08" -- Create geometry, set the solution method and mesh. cuboid = project.Contents.Geometry:AddCuboidAtCentre(cf.Point(0,0,0), 1.0, 1.0, 1.0) dielectric = project.Definitions.Media.Dielectric: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.Contents.Geometry["Cuboid1"]:UnlinkMesh() -- Obtain the 'TetrahedronRegionCollection' tetrahedronRegions = project.Contents.Meshes["Cuboid1_1"].Regions -- Store the number of tetragon regions in the collection tetrahedronRegionsCount = tetrahedronRegions.Count
Inheritance
The MeshTetrahedronRegionCollection object is derived from the Object object.
Usage locations
The MeshTetrahedronRegionCollection object can be accessed from the following locations:
- Collection lists
Property List
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 MeshRegion for the given index in the collection. (Returns a MeshRegion object.)
- Item (label string)
- Returns the MeshRegion for the given label in the collection. (Returns a MeshRegion object.)
- Items ()
- Returns a table of MeshRegion items. (Returns a UnsupportedType(List of MeshRegion) 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
Method Details
- Delete ()
- Deletes the entity.
- DeleteEntities ( List of Object)
- Delete the given list of entities from the collection.
- 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 MeshRegion for the given index in the collection.
- Input Parameters
- index(number)
- The index of the MeshRegion.
- Return
- MeshRegion
- The item in the collection
- Item (label string)
- Returns the MeshRegion for the given label in the collection.
- Input Parameters
- label(string)
- The label of the MeshRegion.
- Return
- MeshRegion
- The item in the collection
- Items ()
- Returns a table of MeshRegion items.
- Return
- UnsupportedType(List of MeshRegion)
- 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.