LocalMeshSettings
Mesh settings that can be applied to root-level geometry or mesh parts.
Example
application = cf.Application.getInstance() project = application:NewProject() -- Add new mesh setting definion localMeshSettings = project.Definitions.MeshSettings:Add(cf.Enums.MeshSizeOptionEnum.Standard) -- Modify mesh settings definition properties = localMeshSettings:GetProperties() properties.MeshSizeOption = cf.Enums.MeshSizeOptionEnum.Coarse properties.WireRadius = "5e-3" localMeshSettings:SetProperties(properties)
Inheritance
The LocalMeshSettings object is derived from the MeshSettings object.
Usage locations
The LocalMeshSettings object can be accessed from the following locations:
- Methods
- MeshSettingsCollection collection has method Add(table).
- MeshSettingsCollection collection has method Add(MeshSizeOptionEnum).
- MeshSettingsCollection collection has method Item(number).
- MeshSettingsCollection collection has method Item(string).
Property List
- Advanced
- Advanced meshing settings. (Read/Write MeshAdvancedSettings)
- Label
- The object label. (Read/Write string)
- MeshSizeOption
- Mesh size option. (Read/Write MeshSizeOptionEnum)
- TetrahedronEdgeLength
- Mesh tetrahedron edge length. Only applied if MeshSizeOption is Custom and there is at least one volume in the model. (Read/Write ParametricExpression)
- TriangleEdgeLength
- Mesh triangle edge length. Only applied if MeshSizeOption is Custom and there is at least one surface in the model. (Read/Write ParametricExpression)
- Type
- The object type string. (Read only string)
- WireRadius
- Mesh wire segment radius. Only applied if there is at least one wire in the model. (Read/Write ParametricExpression)
- WireSegmentLength
- Mesh wire segment length. Only applied if MeshSizeOption is Custom and there is at least one wire in the model. (Read/Write ParametricExpression)
Method List
- Delete ()
- Deletes the entity.
- 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.)
- 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
- Advanced
- Advanced meshing settings.
- Type
- MeshAdvancedSettings
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- MeshSizeOption
- Mesh size option.
- Type
- MeshSizeOptionEnum
- Access
- Read/Write
- TetrahedronEdgeLength
- Mesh tetrahedron edge length. Only applied if MeshSizeOption is Custom and there is at least one volume in the model.
- Type
- ParametricExpression
- Access
- Read/Write
- TriangleEdgeLength
- Mesh triangle edge length. Only applied if MeshSizeOption is Custom and there is at least one surface in the model.
- Type
- ParametricExpression
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
- WireRadius
- Mesh wire segment radius. Only applied if there is at least one wire in the model.
- Type
- ParametricExpression
- Access
- Read/Write
- WireSegmentLength
- Mesh wire segment length. Only applied if MeshSizeOption is Custom and there is at least one wire in the model.
- Type
- ParametricExpression
- Access
- Read/Write
Method Details
- Delete ()
- Deletes the entity.
- 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.
- 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.