ModelSymmetry

The model symmetry planes.

Example

app = cf.GetApplication()
project = app:OpenFile(FEKO_HOME..[[/shared/Resources/Automation/Dipole_Example.cfx]])

    -- Access the 'ModelSymmetry' object and set the X plane symmetry to geometric

project.SolutionSettings.ModelSymmetry.PlaneX = cf.Enums.ModelSymmetryTypeEnum.Geometric

Usage locations (object properties)

The following objects have properties using the ModelSymmetry object:

Property List

PlaneX
X-plane symmetry type. (Read/Write ModelSymmetryTypeEnum)
PlaneY
Y-plane symmetry type. (Read/Write ModelSymmetryTypeEnum)
PlaneZ
Z-plane symmetry type. (Read/Write ModelSymmetryTypeEnum)
Type
The object type string. (Read only string)

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

PlaneX
X-plane symmetry type.
Type
ModelSymmetryTypeEnum
Access
Read/Write
PlaneY
Y-plane symmetry type.
Type
ModelSymmetryTypeEnum
Access
Read/Write
PlaneZ
Z-plane symmetry type.
Type
ModelSymmetryTypeEnum
Access
Read/Write
Type
The object type string.
Type
string
Access
Read only

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.