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_regionbool, default: True

Whether an open region is used.

extent_typeHFSSExtentInfoType, default: BOUNDING_BOX

Extent type.

open_region_typeOpenRegionType, default: RADIATION

Open region type.

base_polygonPrimitive, default: None

Polygon to use if the extent is the Polygon type.

dielectric_extent_typeHFSSExtentInfoType, default: BOUNDING_BOX

Dielectric extent type.

dielectric_base_polygonPrimitive, default: None

Polygon to use if dielectric extent is the Polygon type.

dielectric(float, bool), default: (0, True)

Dielectric extent size. The first parameter is the value. The second parameter is a Boolean indicating if the value is a multiple.

honor_user_dielectricbool, default: True

Whether to honor a user-defined dielectric primitive when calculating the dielectric extent.

airbox_truncate_at_groundbool, default: False

Whether to truncate the airbox at the ground layers.

airbox_horizontal(float, bool), default: (0.15, True)

Airbox horizontal extent size. The first parameter is the value. The second parameter is a Boolean indicating if the value is a multiple.

airbox_vertical_positive(float, bool), default: (0.15, True)

Airbox positive vertical extent size. The first parameter is the value. The second parameter is a Boolean indicating if the value is a multiple.

airbox_vertical_negative(float, bool), default: (0.15, True)

Airbox negative vertical extent size. The first parameter is the value. The second parameter is a Boolean indicating if the value is a multiple.

sync_airbox_vertical_extentbool, default: True

Whether to synchronize the airbox positive and negative vertical extent.

is_pml_visiblebool, default: False

Whether to check to see if PML boxes are to be rendered.

operating_frequencyValueLike, default: "5GHz"

PML operating frequency.

radiation_levelValue, default: 0

PML radiation level for calculating the thickness of the boundary.

user_xy_data_extent_for_vertical_expansionbool, default: True

Whether to retain the old behavior for the vertical expansion of the airbox. The default is True, in which case the vertical extent is calculated from the XY data extent.

Methods