`Mesher`

The model mesher.

Example

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

sphere = project.Contents.Geometry:AddSphere(cf.Point(0,0,0),1)
project.Contents.SolutionConfigurations.GlobalFrequency.Start = "1e06"

    -- Mesh all geometry in the model

project.Mesher:Mesh()

Inheritance

The Mesher object is derived from the Object object.

Usage locations

The Mesher object can be accessed from the following locations:

Properties
- Model object has property Mesher.

Property List

Label: The object label. (Read/Write string)
Settings: Settings applicable to the creation of the mesh. (Read only GlobalMeshSettings)
Type: The object type string. (Read only string)
VoxelSettings: Settings applicable only to the creation of the voxel mesh. (Read only VoxelSettings)

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.)
Mesh (): Mesh the model. The type of mesh created will depend on the solver settings.
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.
UnlinkMeshes (items List of Object): Unlinks the simulation mesh from the given items. (Returns a List of Mesh object.)
UnlinkMeshes (items List of Object, option UnlinkMeshOptionEnum): Unlinks the simulation mesh from the given items. (Returns a List of Mesh object.)

Static Function List

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

Property Details

Label

The object label.

Type: string
Access: Read/Write

Settings

Settings applicable to the creation of the mesh.

Type: GlobalMeshSettings
Access: Read only

Type

The object type string.

Type: string
Access: Read only

VoxelSettings

Settings applicable only to the creation of the voxel mesh.

Type: VoxelSettings
Access: Read only

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.

Mesh ()

Mesh the model. The type of mesh created will depend on the solver settings.

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.

UnlinkMeshes (items List of Object)

Unlinks the simulation mesh from the given items.

Input Parameters

items(List of Object): The items to unlink the simulation mesh from.

Return

List of Mesh: A list of mesh items created.

UnlinkMeshes (items List of Object, option UnlinkMeshOptionEnum)

Unlinks the simulation mesh from the given items.

Input Parameters

items(List of Object): The items to unlink the simulation mesh from.
option(UnlinkMeshOptionEnum): Controls how ports a handled during the unlink process.

Return

List of Mesh: A list of mesh items created.

Static Function Details

GetDefaultProperties ()

Creates a table containing the default settings to create an object.

Return

table: A table containing the default properties.