VoxelSettings

Settings applicable only to the creation of the voxel mesh.

Example

app = cf.GetApplication()
project = app:OpenFile(
        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()

Usage locations (object properties)

The following objects have properties using the VoxelSettings object:

Property List

Advanced
Advanced voxel meshing settings. (Read only VoxelAdvancedSettings)
GridInfo
Information about the voxel grid setup. (Read only 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)
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 Expression)
WireRadius
Voxel wire segment radius. Only applies if there is at least one wire in the model. (Read/Write Expression)

Method List

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 table)
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.

Property Details

Advanced
Advanced voxel meshing settings.
Type
VoxelAdvancedSettings
Access
Read only
GridInfo
Information about the voxel grid setup.
Type
VoxelGridSummary
Access
Read only
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
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
Expression
Access
Read/Write
WireRadius
Voxel wire segment radius. Only applies if there is at least one wire in the model.
Type
Expression
Access
Read/Write

Method Details

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 properties table.
SetProperties (properties table)
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(table)
A table of properties defining the new state of the object.