SimulationSetup

class pyedb.dotnet.database.utilities.simulation_setup.SimulationSetup(pedb, edb_object=None)

Bases: object

Provide base simulation setup.

Parameters:

pedbpyedb.dotnet.edb.Edb

Inherited object.

edb_objectAnsys.Ansoft.Edb.Utility.SIWaveSimulationSetup,

:class:`Ansys.Ansoft.Edb.Utility.SIWDCIRSimulationSettings`,

:class:`Ansys.Ansoft.Edb.Utility.HFSSSimulationSettings`

EDB object.

Overview

Methods

set_sim_setup_info
get_simulation_settings
set_simulation_settings
add_sweep	Add frequency sweep.
delete	Delete current simulation setup.
delete_frequency_sweep	Delete a frequency sweep.
add_frequency_sweep	Add frequency sweep.

Properties

sim_setup_info
get_sim_setup_info	Get simulation setup information.
is_null	Adding this property for compatibility with grpc.
setup_type
type
mesh_operations
enabled	Flag indicating if the setup is enabled.
name	Name of the setup.
position	Position in the setup list.
frequency_sweeps
sweeps	List of frequency sweeps.
sweep_data	Adding property for compatibility with grpc.

Import detail

from pyedb.dotnet.database.utilities.simulation_setup import SimulationSetup

Property detail

property SimulationSetup.sim_setup_info

property SimulationSetup.get_sim_setup_info

Get simulation setup information.

property SimulationSetup.is_null

Adding this property for compatibility with grpc.

property SimulationSetup.setup_type

property SimulationSetup.type

property SimulationSetup.mesh_operations

property SimulationSetup.enabled

Flag indicating if the setup is enabled.

property SimulationSetup.name

Name of the setup.

property SimulationSetup.position

Position in the setup list.

property SimulationSetup.frequency_sweeps

property SimulationSetup.sweeps

List of frequency sweeps.

property SimulationSetup.sweep_data

Adding property for compatibility with grpc.

Method detail

SimulationSetup.set_sim_setup_info(sim_setup_info)

SimulationSetup.get_simulation_settings()

SimulationSetup.set_simulation_settings(sim_settings: dict)

SimulationSetup.add_sweep(name: str = None, distribution: str = None, start_freq: str = None, stop_freq: str = None, step=None, frequency_set: list = None, sweep_type: str = 'interpolation', **kwargs)

Add frequency sweep.

Parameters:

namestr, optional

Name of the frequency sweep. The default is None.

distributionstr, optional

Added for grpc compatibility.

start_freqstr, optional

Added for rpc compatibility.

stop_freqstr, optional

Added for grpc compatibility.

stepoptional

Added for grpc compatibility.

frequency_setlist, optional

List of frequency points. The default is None.

sweep_typestr, optional

Sweep type. The default is "interpolation". Options are "discrete",”discrete”``.

Returns

——-

Examples

>>> setup1 = edbapp.create_siwave_syz_setup("setup1")
>>> setup1.add_sweep(name="sw1", frequency_set=["linear count", "1MHz", "100MHz", 10])

SimulationSetup.delete()

Delete current simulation setup.

SimulationSetup.delete_frequency_sweep(sweep_data)

Delete a frequency sweep.

Parameters:

sweep_dataEdbFrequencySweep.

SimulationSetup.add_frequency_sweep(name=None, frequency_sweep=None)

Add frequency sweep.

Parameters:

namestr, optional

Name of the frequency sweep. The default is None.

frequency_sweeplist, optional

List of frequency points. The default is None.

Returns:

pyedb.dotnet.database.edb_data.simulation_setup_data.EdbFrequencySweep

Examples

>>> setup1 = edbapp.create_siwave_syz_setup("setup1")
>>> setup1.add_frequency_sweep(
...     frequency_sweep=[
...         ["linear count", "0", "1kHz", 1],
...         ["log scale", "1kHz", "0.1GHz", 10],
...         ["linear scale", "0.1GHz", "10GHz", "0.1GHz"],
...     ]
... )