HfssExtentInfo

class pyedb.grpc.database.utility.hfss_extent_info.HfssExtentInfo(pedb)

Manages EDB functionalities for HFSS extent information.

Parameters:

pedbpyedb.grpc.edb.Edb

Inherited EDB object.

Overview

Methods

get_air_box_horizontal_extent	Size of horizontal extent for the air box.
set_air_box_horizontal_extent
get_air_box_positive_vertical_extent	Negative vertical extent for the air box.
set_air_box_positive_vertical_extent
get_air_box_negative_vertical_extent	Negative vertical extent for the airbox.
set_air_box_negative_vertical_extent
get_dielectric_extent	Dielectric extent size.
set_dielectric_extent
load_config	Load HFSS extent configuration.
export_config	Export HFSS extent information.

Properties

base_polygon	Base polygon.
dielectric_base_polygon	Dielectric base polygon.
dielectric_extent_type	Dielectric extent type.
extent_type	Extent type.
honor_user_dielectric	Honor user dielectric.
is_pml_visible	Whether visibility of the PML is enabled.
open_region_type	Open region type.
operating_freq	PML Operating frequency.
radiation_level	PML Radiation level to calculate the thickness of boundary.
sync_air_box_vertical_extent	Vertical extent of the sync air box.
truncate_air_box_at_ground	Truncate air box at ground.
use_open_region	Whether using an open region is enabled.
use_xy_data_extent_for_vertical_expansion	Whether using the xy data extent for vertical expansion is enabled.

Attributes

extent_type_mapping
hfss_extent_type

Import detail

from pyedb.grpc.database.utility.hfss_extent_info import HfssExtentInfo

Property detail

property HfssExtentInfo.base_polygon: any

Base polygon.

Returns:

Polygon

property HfssExtentInfo.dielectric_base_polygon: any

Dielectric base polygon.

Returns:

Polygon

property HfssExtentInfo.dielectric_extent_type: str

Dielectric extent type.

Returns:

str

Dielectric extent type.

property HfssExtentInfo.extent_type: str

Extent type.

Returns:

str

Extent type.

property HfssExtentInfo.honor_user_dielectric: bool

Honor user dielectric.

Returns:

bool

property HfssExtentInfo.is_pml_visible: bool

Whether visibility of the PML is enabled.

Returns:

bool

property HfssExtentInfo.open_region_type: str

Open region type.

Returns:

str

Open region type.

property HfssExtentInfo.operating_freq: float

PML Operating frequency.

Returns:

float

Operating frequency value.

property HfssExtentInfo.radiation_level: float

PML Radiation level to calculate the thickness of boundary.

Returns:

float

Boundary thickness value.

property HfssExtentInfo.sync_air_box_vertical_extent: bool

Vertical extent of the sync air box.

Returns:

bool

Synchronise vertical extent.

property HfssExtentInfo.truncate_air_box_at_ground: bool

Truncate air box at ground.

Returns:

bool

Truncate air box at ground.

property HfssExtentInfo.use_open_region: bool

Whether using an open region is enabled.

Returns:

bool

Use open region.

property HfssExtentInfo.use_xy_data_extent_for_vertical_expansion: bool

Whether using the xy data extent for vertical expansion is enabled.

Returns:

bool

USe x y data extent for vertical expansion.

Attribute detail

HfssExtentInfo.extent_type_mapping

HfssExtentInfo.hfss_extent_type

Method detail

HfssExtentInfo.get_air_box_horizontal_extent()

Size of horizontal extent for the air box.

Returns:

float

Air box horizontal extent value.

HfssExtentInfo.set_air_box_horizontal_extent(size: float, is_multiple: bool = True)

HfssExtentInfo.get_air_box_positive_vertical_extent()

Negative vertical extent for the air box.

Returns:

float

Air box positive vertical extent value.

HfssExtentInfo.set_air_box_positive_vertical_extent(size: float, is_multiple: bool)

HfssExtentInfo.get_air_box_negative_vertical_extent()

Negative vertical extent for the airbox.

Returns:

float

Air box negative vertical extent value.

HfssExtentInfo.set_air_box_negative_vertical_extent(size: float, is_multiple: bool = True)

HfssExtentInfo.get_dielectric_extent()

Dielectric extent size.

Returns:

float

Dielectric extent size value.

HfssExtentInfo.set_dielectric_extent(size: float, is_multiple: bool = True)

HfssExtentInfo.load_config(config)

Load HFSS extent configuration.

Parameters:

config: dict

Parameters of the HFSS extent information.

HfssExtentInfo.export_config()

Export HFSS extent information.

Returns:

dict

Parameters of the HFSS extent information.