assign_lattice_pair#

Hfss.assign_lattice_pair(assignment: list, reverse_v: bool | None = False, phase_delay: str | None = 'UseScanAngle', phase_delay_param1: str | None = '0deg', phase_delay_param2: str | None = '0deg', name: str | None = None) → BoundaryObject#

Assign a lattice pair to a couple of faces.

Parameters:
assignmentlist

List of two faces to assign the lattice pair to.

reverse_vbool, optional

Whether to reverse the V vector. The default is False.

phase_delaystr, optional

Phase delay approach. Options are "UseScanAngle", "UseScanUV", and "InputPhaseDelay". The default is "UseScanAngle".

phase_delay_param1str, optional

Value for the first phase delay parameter, which depends on the approach:

  • Phi angle if the approach is "UseScanAngle".

  • U value if the approach is "UseScanUV".

  • Phase if the approach is "InputPhaseDelay".

The default is 0deg.

phase_delay_param2str, optional

Value for the second phase delay parameter, which depends on the approach:

  • Theta angle if the approach is “UseScanAngle".

  • V value if the approach is "UseScanUV".

The default is 0deg.

namestr, optional

Boundary name.

Returns:
ansys.aedt.core.modules.boundary.common.BoundaryObject

Boundary object.

References

>>> oModule.AssignLatticePair

Examples

>>> from ansys.aedt.core import Hfss
>>> hfss = Hfss()
>>> box1 = hfss.modeler.create_box([-100, -100, -100], [200, 200, 200])
>>> hfss.assign_lattice_pair([box1.faces[2], box1.faces[5]])