VoxelSettings
Settings applicable only to the creation of the voxel mesh.
Example
app = cf.GetApplication() project = app:Load({ FEKO_HOME..[[/shared/Resources/Automation/Feeding_a_Horn_Antenna_Aperture_Feed.cfx]]}) -- Enable FDTD and mesh the model project.SolutionSettings.SolverSettings.FDTDSettings.FDTDEnabled = true project.Mesher:Mesh() -- Change the voxel mesh size to 'Fine' and remesh project.Mesher.VoxelSettings.MeshSizeOption = cf.Enums.MeshSizeOptionEnum.Fine project.Mesher:Mesh()
Inheritance
The VoxelSettings object is derived from the Object object.
Usage locations
The VoxelSettings object can be accessed from the following locations:
- Properties
- Mesher object has property VoxelSettings.
Property List
- Advanced
- Advanced voxel meshing settings. (Read/Write VoxelAdvancedSettings)
- GridInfo
- Information about the voxel grid setup. (Read/Write VoxelGridSummary)
- IntrinsicWireRadiusEnabled
- Specifies if the intrinsic wire radius should be used. Only applies if there is at least one wire in the model. (Read/Write boolean)
- Label
- The object label. (Read/Write string)
- MeshSizeOption
- Voxel mesh size option. (Read/Write MeshSizeOptionEnum)
- Type
- The object type string. (Read only string)
- VoxelSize
- The length of each voxel edge. Only valid if MeshSize is Custom. (Read/Write ParametricExpression)
- WireRadius
- Voxel wire segment radius. Only applies if 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 voxel meshing settings.
- Type
- VoxelAdvancedSettings
- Access
- Read/Write
- GridInfo
- Information about the voxel grid setup.
- Type
- VoxelGridSummary
- Access
- Read/Write
- IntrinsicWireRadiusEnabled
- Specifies if the intrinsic wire radius should be used. Only applies if there is at least one wire in the model.
- Type
- boolean
- Access
- Read/Write
- Label
- The object label.
- Type
- string
- Access
- Read/Write
- MeshSizeOption
- Voxel mesh size option.
- Type
- MeshSizeOptionEnum
- Access
- Read/Write
- Type
- The object type string.
- Type
- string
- Access
- Read only
- VoxelSize
- The length of each voxel edge. Only valid if MeshSize is Custom.
- Type
- ParametricExpression
- Access
- Read/Write
- WireRadius
- Voxel wire segment radius. Only applies if 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.