HfssExtentInfo

class pyedb.dotnet.database.edb_data.hfss_extent_info.HfssExtentInfo(pedb)

Manages EDB functionalities for HFSS extent information.

Parameters:

pedbpyedb.edb.Edb

Inherited EDB object.

Overview

Methods

set_air_box_horizontal_extent
get_air_box_horizontal_extent
set_air_box_positive_vertical_extent
get_air_box_positive_vertical_extent
set_air_box_negative_vertical_extent
get_air_box_negative_vertical_extent
set_dielectric_extent
get_dielectric_extent
load_config	Load HFSS extent configuration.
export_config	Export HFSS extent information.

Properties

air_box_horizontal_extent_enabled	Whether horizontal extent is enabled for the airbox.
air_box_horizontal_extent	Size of horizontal extent for the air box.
air_box_positive_vertical_extent_enabled	Whether positive vertical extent is enabled for the air box.
air_box_positive_vertical_extent	Negative vertical extent for the air box.
air_box_negative_vertical_extent_enabled	Whether negative vertical extent is enabled for the air box.
air_box_negative_vertical_extent	Negative vertical extent for the airbox.
base_polygon	Base polygon.
dielectric_base_polygon	Dielectric base polygon.
dielectric_extent_size_enabled	Whether dielectric extent size is enabled.
dielectric_extent_size	Dielectric extent size.
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.
pml_radiation_factor	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.

Import detail

from pyedb.dotnet.database.edb_data.hfss_extent_info import HfssExtentInfo

Property detail

property HfssExtentInfo.air_box_horizontal_extent_enabled

Whether horizontal extent is enabled for the airbox.

property HfssExtentInfo.air_box_horizontal_extent

Size of horizontal extent for the air box.

Returns: dotnet.database.edb_data.edbvalue.EdbValue

property HfssExtentInfo.air_box_positive_vertical_extent_enabled

Whether positive vertical extent is enabled for the air box.

property HfssExtentInfo.air_box_positive_vertical_extent

Negative vertical extent for the air box.

property HfssExtentInfo.air_box_negative_vertical_extent_enabled

Whether negative vertical extent is enabled for the air box.

property HfssExtentInfo.air_box_negative_vertical_extent

Negative vertical extent for the airbox.

property HfssExtentInfo.base_polygon

Base polygon.

Returns:

dotnet.database.edb_data.primitives_data.EDBPrimitive

property HfssExtentInfo.dielectric_base_polygon

Dielectric base polygon.

Returns:

dotnet.database.edb_data.primitives_data.EDBPrimitive

property HfssExtentInfo.dielectric_extent_size_enabled

Whether dielectric extent size is enabled.

property HfssExtentInfo.dielectric_extent_size

Dielectric extent size.

property HfssExtentInfo.dielectric_extent_type

Dielectric extent type.

property HfssExtentInfo.extent_type

Extent type.

property HfssExtentInfo.honor_user_dielectric

Honor user dielectric.

property HfssExtentInfo.is_pml_visible

Whether visibility of the PML is enabled.

property HfssExtentInfo.open_region_type

Open region type.

property HfssExtentInfo.operating_freq

PML Operating frequency.

Returns:

pyedb.dotnet.database.edb_data.edbvalue.EdbValue

property HfssExtentInfo.radiation_level

PML Radiation level to calculate the thickness of boundary.

property HfssExtentInfo.pml_radiation_factor

PML Radiation level to calculate the thickness of boundary.

property HfssExtentInfo.sync_air_box_vertical_extent

Vertical extent of the sync air box.

property HfssExtentInfo.truncate_air_box_at_ground

Truncate air box at ground.

property HfssExtentInfo.use_open_region

Whether using an open region is enabled.

property HfssExtentInfo.use_xy_data_extent_for_vertical_expansion

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

Method detail

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

HfssExtentInfo.get_air_box_horizontal_extent()

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

HfssExtentInfo.get_air_box_positive_vertical_extent()

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

HfssExtentInfo.get_air_box_negative_vertical_extent()

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

HfssExtentInfo.get_dielectric_extent()

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.