CfgBoundaries

class pyedb.configuration.cfg_boundaries.CfgBoundaries(/, **data: Any)

Bases: pyedb.configuration.cfg_common.CfgBaseModel

Represent open-region and extent settings.

Overview

Constructors

create

Create a CfgBoundaries instance.

Methods

set_radiation_boundary	Configure a radiation open region.
set_pml_boundary	Configure a perfectly matched layer boundary.
set_air_box_extents	Set horizontal and vertical air-box padding.
set_extent	Set the layout extent used for region construction.
set_dielectric_extent	Configure the dielectric extent envelope.

Attributes

use_open_region
open_region_type
is_pml_visible
operating_freq
radiation_level
dielectric_extent_type
dielectric_base_polygon
dielectric_extent_size
honor_user_dielectric
extent_type
base_polygon
truncate_air_box_at_ground
air_box_horizontal_extent
air_box_positive_vertical_extent
air_box_negative_vertical_extent
sync_air_box_vertical_extent

Import detail

from pyedb.configuration.cfg_boundaries import CfgBoundaries

Attribute detail

CfgBoundaries.use_open_region: bool | None = None

CfgBoundaries.open_region_type: str | None = None

CfgBoundaries.is_pml_visible: bool | None = None

CfgBoundaries.operating_freq: Any | None = None

CfgBoundaries.radiation_level: float | None = None

CfgBoundaries.dielectric_extent_type: str | None = None

CfgBoundaries.dielectric_base_polygon: str | None = None

CfgBoundaries.dielectric_extent_size: CfgBoundaries.PaddingData | None = None

CfgBoundaries.honor_user_dielectric: bool = None

CfgBoundaries.extent_type: str | None = None

CfgBoundaries.base_polygon: str | None = None

CfgBoundaries.truncate_air_box_at_ground: bool | None = None

CfgBoundaries.air_box_horizontal_extent: CfgBoundaries.PaddingData | None = None

CfgBoundaries.air_box_positive_vertical_extent: CfgBoundaries.PaddingData | None = None

CfgBoundaries.air_box_negative_vertical_extent: CfgBoundaries.PaddingData | None = None

CfgBoundaries.sync_air_box_vertical_extent: bool | None = None

Method detail

classmethod CfgBoundaries.create(**kwargs) → CfgBoundaries

Create a CfgBoundaries instance.

CfgBoundaries.set_radiation_boundary(use_open_region: bool = True)

Configure a radiation open region.

CfgBoundaries.set_pml_boundary(operating_freq, radiation_level: float = 20, is_pml_visible: bool = False)

Configure a perfectly matched layer boundary.

CfgBoundaries.set_air_box_extents(horizontal_size: float = 0.15, horizontal_is_multiple: bool = False, positive_vertical_size: float = 0.15, positive_vertical_is_multiple: bool = False, negative_vertical_size: float = 0.15, negative_vertical_is_multiple: bool = False, sync: bool = False, truncate_at_ground: bool = False)

Set horizontal and vertical air-box padding.

CfgBoundaries.set_extent(extent_type: str = 'BoundingBox', base_polygon: str | None = None, truncate_air_box_at_ground: bool = False)

Set the layout extent used for region construction.

CfgBoundaries.set_dielectric_extent(extent_type: str = 'BoundingBox', expansion_size: int = 0, is_multiple: bool = False, base_polygon: str | None = None, honor_user_dielectric: bool = False)

Configure the dielectric extent envelope.

Classes

PaddingData

Represent padding data for extent regions.