`SimulationConfigurationAc`#

class pyedb.dotnet.database.edb_data.simulation_configuration.SimulationConfigurationAc#

Bases: object

Contains all AC analysis settings. The class is part of SimulationConfiguration class as a property.

Overview#

Properties

`sweep_interpolating`	Retrieve boolean to add a sweep interpolating sweep.
`use_q3d_for_dc`	Retrieve boolean to Q3D solver for DC point value computation.
`relative_error`	Retrieve relative error used for the interpolating sweep convergence.
`use_error_z0`	Retrieve value for the error on Z0 for the port.
`percentage_error_z0`	Retrieve boolean to perform the cutout during the project build.
`enforce_causality`	Retrieve boolean to enforce causality for the frequency sweep.
`enforce_passivity`	Retrieve boolean to enforce passivity for the frequency sweep.
`passivity_tolerance`	Retrieve the value for the passivity tolerance when used.
`sweep_name`	Retrieve frequency sweep name.
`radiation_box`	Retrieve RadiationBoxType object selection defined for the radiation box type.
`start_freq`	Starting frequency for the frequency sweep.
`stop_freq`	Retrieve stop frequency for the frequency sweep.
`sweep_type`	Retrieve SweepType object for the frequency sweep.
`step_freq`	Retrieve step frequency for the frequency sweep.
`decade_count`	Retrieve decade count number for the frequency sweep in case of a log sweep selected.
`mesh_freq`	Retrieve the meshing frequency for the HFSS adaptive convergence.
`max_num_passes`	Retrieve maximum of points for the HFSS adaptive meshing.
`max_mag_delta_s`	Retrieve the magnitude of the delta S convergence criteria for the interpolating sweep.
`min_num_passes`	Retrieve the minimum number of adaptive passes for HFSS convergence.
`basis_order`	Retrieve the BasisOrder object.
`do_lambda_refinement`	Retrieve boolean to activate the lambda refinement.
`arc_angle`	Retrieve the value for the HFSS meshing arc angle.
`start_azimuth`	Retrieve the value of the starting azimuth for the HFSS meshing.
`max_arc_points`	Retrieve the value of the maximum arc points number for the HFSS meshing.
`use_arc_to_chord_error`	Retrieve the boolean for activating the arc to chord for HFSS meshing.
`arc_to_chord_error`	Retrieve the value of arc to chord error for HFSS meshing.
`defeature_abs_length`	Retrieve the value of arc to chord for HFSS meshing.
`defeature_layout`	Retrieve the boolean to activate the layout defeaturing.This method has been developed to simplify polygons
`minimum_void_surface`	Retrieve the minimum void surface to be considered for the layout defeaturing.
`max_suf_dev`	Retrieve the value for the maximum surface deviation for the layout defeaturing.
`process_padstack_definitions`	Retrieve the boolean for activating the padstack definition processing.
`return_current_distribution`	Boolean to activate the current distribution return with Siwave.
`ignore_non_functional_pads`	Boolean to ignore nonfunctional pads with Siwave.
`include_inter_plane_coupling`	Boolean to activate the inter-plane coupling with Siwave.
`xtalk_threshold`	Return the value for Siwave cross talk threshold. THis value specifies the distance for the solver to
`min_void_area`	Retrieve the value of minimum void area to be considered by Siwave.
`min_pad_area_to_mesh`	Retrieve the value of minimum pad area to be meshed by Siwave.
`snap_length_threshold`	Retrieve the boolean to activate the snapping threshold feature.
`min_plane_area_to_mesh`	Retrieve the minimum plane area to be meshed by Siwave.
`mesh_sizefactor`	Retrieve the Mesh Size factor value.
`adaptive_type`	HFSS adaptive type.
`adaptive_low_freq`	HFSS broadband low frequency adaptive meshing.
`adaptive_high_freq`	HFSS broadband high frequency adaptive meshing.

Import detail#

from pyedb.dotnet.database.edb_data.simulation_configuration import SimulationConfigurationAc

Property detail#

property SimulationConfigurationAc.sweep_interpolating#

Retrieve boolean to add a sweep interpolating sweep.

Returns:

bool
True when a sweep interpolating is defined, False when a discrete one is defined instead.

property SimulationConfigurationAc.use_q3d_for_dc#

Retrieve boolean to Q3D solver for DC point value computation.

Returns:

bool
True when Q3D solver is used False when interpolating value is used instead.

property SimulationConfigurationAc.relative_error#

Retrieve relative error used for the interpolating sweep convergence.

Returns:

float
The value of the error interpolating sweep to reach the convergence criteria.

property SimulationConfigurationAc.use_error_z0#

Retrieve value for the error on Z0 for the port.

Returns:

float
The Z0 value.

property SimulationConfigurationAc.percentage_error_z0#

Retrieve boolean to perform the cutout during the project build.

Returns:

bool
True when clipping the design is applied False if not.

property SimulationConfigurationAc.enforce_causality#

Retrieve boolean to enforce causality for the frequency sweep.

Returns:

bool
True when causality is enforced False if not.

property SimulationConfigurationAc.enforce_passivity#

Retrieve boolean to enforce passivity for the frequency sweep.

Returns:

bool
True when passivity is enforced False if not.

property SimulationConfigurationAc.passivity_tolerance#

Retrieve the value for the passivity tolerance when used.

Returns:

float
The passivity tolerance criteria for the frequency sweep.

property SimulationConfigurationAc.sweep_name#

Retrieve frequency sweep name.

Returns:

str
The name of the frequency sweep defined in the project.

property SimulationConfigurationAc.radiation_box#

Retrieve RadiationBoxType object selection defined for the radiation box type.

Returns:

RadiationBoxType object
3 values can be chosen, Conformal, BoundingBox or ConvexHull.

property SimulationConfigurationAc.start_freq#

Starting frequency for the frequency sweep.

Returns:

float: Value of the frequency point.

property SimulationConfigurationAc.stop_freq#

Retrieve stop frequency for the frequency sweep.

Returns:

float
The value of the frequency point.

property SimulationConfigurationAc.sweep_type#

Retrieve SweepType object for the frequency sweep.

Returns:

SweepType
The SweepType object,2 selections are supported Linear and LogCount.

property SimulationConfigurationAc.step_freq#

Retrieve step frequency for the frequency sweep.

Returns:

float
The value of the frequency point.

property SimulationConfigurationAc.decade_count#

Retrieve decade count number for the frequency sweep in case of a log sweep selected.

Returns:

int
The value of the decade count number.

property SimulationConfigurationAc.mesh_freq#

Retrieve the meshing frequency for the HFSS adaptive convergence.

Returns:

float
The value of the frequency point.

property SimulationConfigurationAc.max_num_passes#

Retrieve maximum of points for the HFSS adaptive meshing.

Returns:

int
The maximum number of adaptive passes value.

property SimulationConfigurationAc.max_mag_delta_s#

Retrieve the magnitude of the delta S convergence criteria for the interpolating sweep.

Returns:

float
The value of convergence criteria.

property SimulationConfigurationAc.min_num_passes#

Retrieve the minimum number of adaptive passes for HFSS convergence.

Returns:

int
The value of minimum number of adaptive passes.

property SimulationConfigurationAc.basis_order#

Retrieve the BasisOrder object.

Returns:

BasisOrder class
This class supports 4 selections Mixed, Zero, single and Double for the HFSS order matrix.

property SimulationConfigurationAc.do_lambda_refinement#

Retrieve boolean to activate the lambda refinement.

Returns:

bool
True Enable the lambda meshing refinement with HFSS, False deactivate.

property SimulationConfigurationAc.arc_angle#

Retrieve the value for the HFSS meshing arc angle.

Returns:

float
Value of the arc angle.

property SimulationConfigurationAc.start_azimuth#

Retrieve the value of the starting azimuth for the HFSS meshing.

Returns:

float
Value of the starting azimuth.

property SimulationConfigurationAc.max_arc_points#

Retrieve the value of the maximum arc points number for the HFSS meshing.

Returns:

int
Value of the maximum arc point number.

property SimulationConfigurationAc.use_arc_to_chord_error#

Retrieve the boolean for activating the arc to chord for HFSS meshing.

Returns:

bool
Activate when True, deactivated when False.

property SimulationConfigurationAc.arc_to_chord_error#

Retrieve the value of arc to chord error for HFSS meshing.

Returns:

flot
Value of the arc to chord error.

property SimulationConfigurationAc.defeature_abs_length#

Retrieve the value of arc to chord for HFSS meshing.

Returns:

flot
Value of the arc to chord error.

property SimulationConfigurationAc.defeature_layout#

Retrieve the boolean to activate the layout defeaturing.This method has been developed to simplify polygons with reducing the number of points to simplify the meshing with controlling its surface deviation. This method should be used at last resort when other methods failed.

Returns:

bool
True when activated ‘False when deactivated.

property SimulationConfigurationAc.minimum_void_surface#

Retrieve the minimum void surface to be considered for the layout defeaturing. Voids below this value will be ignored.

Returns:

flot
Value of the minimum surface.

property SimulationConfigurationAc.max_suf_dev#

Retrieve the value for the maximum surface deviation for the layout defeaturing.

Returns:

flot
Value of maximum surface deviation.

property SimulationConfigurationAc.process_padstack_definitions#

Retrieve the boolean for activating the padstack definition processing.

Returns:

flot
Value of the arc to chord error.

property SimulationConfigurationAc.return_current_distribution#

Boolean to activate the current distribution return with Siwave.

Returns:

flot
Value of the arc to chord error.

property SimulationConfigurationAc.ignore_non_functional_pads#

Boolean to ignore nonfunctional pads with Siwave.

Returns:

flot
Value of the arc to chord error.

property SimulationConfigurationAc.include_inter_plane_coupling#

Boolean to activate the inter-plane coupling with Siwave.

Returns:

bool
True activated False deactivated.

property SimulationConfigurationAc.xtalk_threshold#

Return the value for Siwave cross talk threshold. THis value specifies the distance for the solver to consider lines coupled during the cross-section computation. Decreasing the value below -60dB can potentially cause solver failure.

Returns:

flot
Value of cross-talk threshold.

property SimulationConfigurationAc.min_void_area#

Retrieve the value of minimum void area to be considered by Siwave.

Returns:

flot
Value of the arc to chord error.

property SimulationConfigurationAc.min_pad_area_to_mesh#

Retrieve the value of minimum pad area to be meshed by Siwave.

Returns:

flot
Value of minimum pad surface.

property SimulationConfigurationAc.snap_length_threshold#

Retrieve the boolean to activate the snapping threshold feature.

Returns:

bool
True activate False deactivated.

property SimulationConfigurationAc.min_plane_area_to_mesh#

Retrieve the minimum plane area to be meshed by Siwave.

Returns:

flot
Value of the minimum plane area.

property SimulationConfigurationAc.mesh_sizefactor#

Retrieve the Mesh Size factor value.

Returns:

float

property SimulationConfigurationAc.adaptive_type#

HFSS adaptive type.

Returns:

class: pyedb.dotnet.database.edb_data.simulation_setup.AdaptiveType

property SimulationConfigurationAc.adaptive_low_freq#

HFSS broadband low frequency adaptive meshing.

Returns:

str

property SimulationConfigurationAc.adaptive_high_freq#

HFSS broadband high frequency adaptive meshing.

Returns:

str