assign_symmetry#

Hfss.assign_symmetry(assignment, name=None, is_perfect_e=True)[source]#

Assign symmetry to planar entities.

Parameters:
assignmentlist

List of IDs or pyaedt.modeler.Object3d.FacePrimitive.

namestr, optional

Name of the boundary. If a name is not provided, one is automatically generated.

is_perfect_ebool, optional

Type of symmetry plane the boundary represents: Perfect E or Perfect H. The default value is True (Perfect E).

Returns:
pyaedt.modules.Boundary.BoundaryObject

Boundary object.

References

>>> oModule.AssignSymmetry

Examples

Create a box. Select the faces of this box and assign a symmetry.

>>> symmetry_box = hfss.modeler.create_box([0 , -100, 0],[200, 200, 200],name="SymmetryForFaces")
>>> ids = [i.id for i in hfss.modeler["SymmetryForFaces"].faces]
>>> symmetry = hfss.assign_symmetry(ids)
>>> type(symmetry)
<class 'pyaedt.modules.Boundary.BoundaryObject'>