`SimulationConfigurationBatch`#

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

Bases: object

Contains all Cutout and Batch analysis settings. The class is part of SimulationConfiguration class as a property.

Overview#

Methods

add_source

Add a new source to configuration.

Properties

`coplanar_instances`	Retrieve the list of component to be replaced by circuit ports (obsolete).
`signal_layer_etching_instances`	Retrieve the list of layers which has layer etching activated.
`etching_factor_instances`	Retrieve the list of etching factor with associated layers.
`dielectric_extent`	Retrieve the value of dielectric extent.
`use_dielectric_extent_multiple`	Whether the multiple value of the dielectric extent is used.
`airbox_horizontal_extent`	Horizontal extent of the airbox for HFSS. When absolute dimensions are used,
`use_airbox_horizontal_extent_multiple`	Whether the multiple value is used for the horizontal extent of the air box.
`airbox_negative_vertical_extent`	Negative vertical extent of the airbox for HFSS. When absolute dimensions
`use_airbox_negative_vertical_extent_multiple`	Multiple value for the negative extent of the airbox.
`airbox_positive_vertical_extent`	Positive vertical extent of the airbox for HFSS. When absolute dimensions are
`use_airbox_positive_vertical_extent_multiple`	Whether the multiple value for the positive extent of the airbox is used.
`use_pyaedt_cutout`	Whether the default EDB cutout or a new PyAEDT cutout is used.
`use_default_cutout`	Whether to use the default EDB cutout. The default is `False`, in which case
`do_pingroup`	Do pingroup on multi-pin component. `True` all pins from the same net are grouped, `False` one port
`generate_solder_balls`	Retrieve the boolean for applying solder balls.
`signal_nets`	Retrieve the list of signal net names.
`power_nets`	Retrieve the list of power and reference net names.
`components`	Retrieve the list component name to be included in the simulation.
`coax_solder_ball_diameter`	Retrieve the list of solder balls diameter values when the auto evaluated one is overwritten.
`use_default_coax_port_radial_extension`	Retrieve the boolean for using the default coaxial port extension value.
`trim_reference_size`	Retrieve the trim reference size when used.
`do_cutout_subdesign`	Retrieve boolean to perform the cutout during the project build.
`cutout_subdesign_type`	Retrieve the CutoutSubdesignType selection for clipping the design.
`cutout_subdesign_expansion`	Retrieve expansion factor used for clipping the design.
`cutout_subdesign_round_corner`	Retrieve boolean to perform the design clipping using round corner for the extent generation.
`output_aedb`	Retrieve the path for the output aedb folder. When provided will copy the initial aedb to the specified
`sources`	Retrieve the source list.
`honor_user_dielectric`	Retrieve the boolean to activate the feature “‘Honor user dielectric’”.
`truncate_airbox_at_ground`	Retrieve the boolean to truncate hfss air box at ground.
`use_radiation_boundary`	Retrieve the boolean to use radiation boundary with HFSS.
`signal_layers_properties`	Retrieve the list of layers to have properties changes.
`generate_excitations`	Activate ports and sources for DC generation when build project with the class.
`add_frequency_sweep`	Activate the frequency sweep creation when build project with the class.
`include_only_selected_nets`	Include only net selection in the project. It is only used when `do_cutout` is set to `False`.

Import detail#

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

Property detail#

property SimulationConfigurationBatch.coplanar_instances#

Retrieve the list of component to be replaced by circuit ports (obsolete).

Returns:

list[str]
List of component name.

property SimulationConfigurationBatch.signal_layer_etching_instances#

Retrieve the list of layers which has layer etching activated.

Returns:

list[str]
List of layer name.

property SimulationConfigurationBatch.etching_factor_instances#

Retrieve the list of etching factor with associated layers.

Returns:

list[str]
list etching parameters with layer name.

property SimulationConfigurationBatch.dielectric_extent#

Retrieve the value of dielectric extent.

Returns:

float: Value of the dielectric extent. When absolute dimensions are used, the values are in meters.

property SimulationConfigurationBatch.use_dielectric_extent_multiple#

Whether the multiple value of the dielectric extent is used.

Returns:

bool: True when the multiple value (extent factor) is used. False when absolute dimensions are used.

property SimulationConfigurationBatch.airbox_horizontal_extent#

Horizontal extent of the airbox for HFSS. When absolute dimensions are used, the values are in meters.

Returns:

float
Value of the air box horizontal extent.

property SimulationConfigurationBatch.use_airbox_horizontal_extent_multiple#

Whether the multiple value is used for the horizontal extent of the air box.

Returns:

bool: True when the multiple value (extent factor) is used. False when absolute dimensions are used.

property SimulationConfigurationBatch.airbox_negative_vertical_extent#

Negative vertical extent of the airbox for HFSS. When absolute dimensions are used, the values are in meters.

Returns:

float
Value of the air box negative vertical extent.

property SimulationConfigurationBatch.use_airbox_negative_vertical_extent_multiple#

Multiple value for the negative extent of the airbox.

Returns:

bool: True when the multiple value (extent factor) is used. False when absolute dimensions are used.

property SimulationConfigurationBatch.airbox_positive_vertical_extent#

Positive vertical extent of the airbox for HFSS. When absolute dimensions are used, the values are in meters.

Returns:

float
Value of the air box positive vertical extent.

property SimulationConfigurationBatch.use_airbox_positive_vertical_extent_multiple#

Whether the multiple value for the positive extent of the airbox is used.

Returns:

bool: True when the multiple value (extent factor) is used. False when absolute dimensions are used.

property SimulationConfigurationBatch.use_pyaedt_cutout#

Whether the default EDB cutout or a new PyAEDT cutout is used.

Returns:

bool

property SimulationConfigurationBatch.use_default_cutout#

Whether to use the default EDB cutout. The default is False, in which case a new PyAEDT cutout is used.

Returns:

bool

property SimulationConfigurationBatch.do_pingroup#

Do pingroup on multi-pin component. True all pins from the same net are grouped, False one port is created for each pin.

Returns:

bool

property SimulationConfigurationBatch.generate_solder_balls#

Retrieve the boolean for applying solder balls.

Returns:

bool: True when applied False if not.

property SimulationConfigurationBatch.signal_nets#

Retrieve the list of signal net names.

Returns:

List[str]: List of signal net names.

property SimulationConfigurationBatch.power_nets#

Retrieve the list of power and reference net names.

Returns:

list[str]: List of the net name.

property SimulationConfigurationBatch.components#

Retrieve the list component name to be included in the simulation.

Returns:

list[str]: List of the component name.

property SimulationConfigurationBatch.coax_solder_ball_diameter#

Retrieve the list of solder balls diameter values when the auto evaluated one is overwritten.

Returns:

list[float]: List of the solder balls diameter.

property SimulationConfigurationBatch.use_default_coax_port_radial_extension#

Retrieve the boolean for using the default coaxial port extension value.

Returns:

bool: True when the default value is used False if not.

property SimulationConfigurationBatch.trim_reference_size#

Retrieve the trim reference size when used.

Returns:

float: The size value.

property SimulationConfigurationBatch.do_cutout_subdesign#

Retrieve boolean to perform the cutout during the project build.

Returns:

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

property SimulationConfigurationBatch.cutout_subdesign_type#

Retrieve the CutoutSubdesignType selection for clipping the design.

Returns:

CutoutSubdesignType object

property SimulationConfigurationBatch.cutout_subdesign_expansion#

Retrieve expansion factor used for clipping the design.

Returns:

float: The value used as a ratio.

property SimulationConfigurationBatch.cutout_subdesign_round_corner#

Retrieve boolean to perform the design clipping using round corner for the extent generation.

Returns:

bool: True when using round corner, False if not.

property SimulationConfigurationBatch.output_aedb#

Retrieve the path for the output aedb folder. When provided will copy the initial aedb to the specified path. This is used especially to preserve the initial project when several files have to be build based on the last one. When the path is None, the initial project will be overwritten. So when cutout is applied mand you want to preserve the project make sure you provide the full path for the new aedb folder.

Returns:

str: Absolute path for the created aedb folder.

property SimulationConfigurationBatch.sources#

Retrieve the source list.

Returns:

dotnet.database.edb_data.sources.Source

property SimulationConfigurationBatch.honor_user_dielectric#

Retrieve the boolean to activate the feature “‘Honor user dielectric’”.

Returns:

bool: True activated, False deactivated.

property SimulationConfigurationBatch.truncate_airbox_at_ground#

Retrieve the boolean to truncate hfss air box at ground.

Returns:

bool: True activated, False deactivated.

property SimulationConfigurationBatch.use_radiation_boundary#

Retrieve the boolean to use radiation boundary with HFSS.

Returns:

bool: True activated, False deactivated.

property SimulationConfigurationBatch.signal_layers_properties#

Retrieve the list of layers to have properties changes.

Returns:

list[str]: List of layer name.

property SimulationConfigurationBatch.generate_excitations#

Activate ports and sources for DC generation when build project with the class.

Returns:

bool: True ports are created, False skip port generation. Default value is True.

property SimulationConfigurationBatch.add_frequency_sweep#

Activate the frequency sweep creation when build project with the class.

Returns:

bool: True frequency sweep is created, False skip sweep adding. Default value is True.

property SimulationConfigurationBatch.include_only_selected_nets#

Include only net selection in the project. It is only used when do_cutout is set to False. Will also be ignored if signal_nets and power_nets are None, resulting project will have all nets included.

Returns:

bool: True or False. Default value is False.

Method detail#

SimulationConfigurationBatch.add_source(source=None)#

Add a new source to configuration.

Parameters:

sourcepyedb.dotnet.database.edb_data.sources.Source