SimulationMesh

Inheritance

The SimulationMesh object is derived from the Object object.

Usage locations

The SimulationMesh object can be accessed from the following locations:

Property List

BoundingBox
A box indicating the bounding box of this entity. (Read only Box). (Read only Box)
Label
The object label. (Read/Write string)
Type
The object type string. (Read only string)

Property List (internal only)

AreSufficientResourcesAvailableForMeshing
(Read only boolean)
EstimatedTotalMemory
(Read only number)
EstimatedTotalNumberOfElements
(Read only number)
Path
(Read only string)
SmallestFaceOrEdgeMeshSize
(Read only number)
Tolerance
(Read only number)
UseFullBodyMeshing
(Read/Write boolean)
Voxels
(Read only VoxelSimulationMesh)

Collection List (internal only)

Bodies
(SimulationMeshBodyCollection of SimulationMeshBodyEntity.)
CurvilinearFaces
(SimulationMeshCurvilinearFaceCollection of SimulationMeshCurvilinearFaceEntity.)
CurvilinearWires
(SimulationMeshCurvilinearWireCollection of SimulationMeshCurvilinearWireEntity.)
Cylinders
(SimulationMeshCylinderCollection of SimulationMeshCylinderEntity.)
Edges
(SimulationMeshEdgeCollection of SimulationMeshEdgeEntity.)
Faces
(SimulationMeshFaceCollection of SimulationMeshFaceEntity.)
Plates
(SimulationMeshPlateCollection of SimulationMeshPlateEntity.)
Regions
(SimulationMeshRegionCollection of SimulationMeshRegionEntity.)
Wires
(SimulationMeshWireCollection of SimulationMeshWireEntity.)

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

BoundingBox
A box indicating the bounding box of this entity. (Read only Box).
Type
Box
Access
Read only
Label
The object label.
Type
string
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

Property Details (internal only)

AreSufficientResourcesAvailableForMeshing
Type
boolean
Access
Read only
EstimatedTotalMemory
Type
number
Access
Read only
EstimatedTotalNumberOfElements
Type
number
Access
Read only
Path
Type
string
Access
Read only
SmallestFaceOrEdgeMeshSize
Type
number
Access
Read only
Tolerance
Type
number
Access
Read only
UseFullBodyMeshing
Type
boolean
Access
Read/Write
Voxels
Type
VoxelSimulationMesh
Access
Read only

Collection Details (internal only)

Bodies
Type
SimulationMeshBodyCollection
CurvilinearFaces
Type
SimulationMeshCurvilinearFaceCollection
CurvilinearWires
Type
SimulationMeshCurvilinearWireCollection
Cylinders
Type
SimulationMeshCylinderCollection
Edges
Type
SimulationMeshEdgeCollection
Faces
Type
SimulationMeshFaceCollection
Plates
Type
SimulationMeshPlateCollection
Regions
Type
SimulationMeshRegionCollection
Wires
Type
SimulationMeshWireCollection

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.