HfssExtentInfo#
- class ansys.edb.core.utility.hfss_extent_info.HfssExtentInfo(use_open_region=True, extent_type=HFSSExtentInfoType.BOUNDING_BOX, open_region_type=OpenRegionType.RADIATION, base_polygon=None, dielectric_extent_type=HFSSExtentInfoType.BOUNDING_BOX, dielectric_base_polygon=None, dielectric=(0, True), honor_user_dielectric=True, airbox_truncate_at_ground=False, airbox_horizontal=(0.15, True), airbox_vertical_positive=(0.15, True), airbox_vertical_negative=(0.15, True), sync_airbox_vertical_extent=True, is_pml_visible=False, operating_frequency='5GHz', radiation_level=<ansys.edb.core.utility.value.Value object>, user_xy_data_extent_for_vertical_expansion=True)#
Provides HFSS extent information.
- Attributes:
- use_open_region: bool
Whether an open region is used.
- extent_type: HfssExtentInfo.HFSSExtentInfoType
Extent type.
- open_region_type: HfssExtentInfo.OpenRegionType
Open region type.
- base_polygon: Primitive
Polygon to use if the extent is the
Polygon
type.- dielectric_extent_type: HfssExtentInfo.HFSSExtentInfoType
Dielectric extent type.
- dielectric_base_polygon
Primitive
Polygon to use if dielectric extent is is the
Polygon
type.- dielectric: (float, bool)
Dielectric extent size. The first parameter is the value, and the second parameter indicates if the value is a multiple.
- honor_user_dielectric: bool
Whether to honor a user-defined dielectric primitive when calculating a dielectric extent.
- airbox_truncate_at_ground: bool
Whether to truncate the airbox at the ground layers.
- airbox_horizontal: (float, bool)
Airbox horizontal extent size. The first parameter is the value, and the second parameter indicates if the value is a multiple.
- airbox_vertical_positive: (float, bool)
Airbox positive vertical extent size. The first parameter is the value, and the second parameter indicates if the value is a multiple.
- airbox_vertical_negative: (float, bool)
Airbox negative vertical extent size. The first parameter is the value, and the second parameter indicates if the value is a multiple.
- sync_airbox_vertical_extent: bool
Whether to synchronize the airbox positive and negative vertical extent.
- is_pml_visible: bool
Whether to check to see if the PML boxes are to rendered.
- operating_frequency
Value
PML operating frequency.
- radiation_level
Value
PML radiation level for calculating the thickness of the boundary.
- user_xy_data_extent_for_vertical_expansion: bool
Whether to retain the old behavior for the vertical expansion of the airbox. If
True
, the vertical extent is calculated from the XY data extent.
Methods