SweepData

class pyedb.dotnet.database.sim_setup_data.data.sweep_data.SweepData(pedb, edb_object=None, name: str = None, sim_setup=None)

Bases: object

Manages EDB methods for a frequency sweep.

Parameters:

sim_setuppyedb.dotnet.database.edb_data.siwave_simulation_setup_data.SiwaveSYZSimulationSetup

namestr, optional

Name of the frequency sweep.

edb_objectAnsys.Ansoft.Edb.Utility.SIWDCIRSimulationSettings, optional

EDB object. The default is None.

Overview

Methods

set_frequencies_linear_scale	Set a linear scale frequency sweep.
set_frequencies_linear_count	Set a linear count frequency sweep.
set_frequencies_log_scale	Set a log-count frequency sweep.
set_frequencies	Set frequency list to the sweep frequencies.
add
add_frequencies
clear

Properties

name	Name of the sweep.
frequencies	List of frequency points.
adaptive_sampling	Flag indicating if adaptive sampling is turned on.
adv_dc_extrapolation	Flag indicating if advanced DC extrapolation is turned on.
compute_dc_point	Flag indicating if computing the exact DC point is turned on.
auto_s_mat_only_solve	Flag indicating if Auto SMatrix only solve is turned on.
enforce_causality	Flag indicating if causality is enforced.
enforce_dc_and_causality	Flag indicating if DC point and causality are enforced.
enforce_passivity	Flag indicating if passivity is enforced.
freq_sweep_type	Sweep type.
type	Sweep type.
interpolation_use_full_basis	Flag indicating if full-basis elements is used.
interpolation_use_port_impedance	Flag indicating if port impedance interpolation is turned on.
interpolation_use_prop_const	Flag indicating if propagation constants are used.
interpolation_use_s_matrix	Flag indicating if the S matrix is used.
max_solutions	Number of maximum solutions.
min_freq_s_mat_only_solve	Minimum frequency SMatrix only solve.
min_solved_freq	Minimum solved frequency with units.
passivity_tolerance	Tolerance for passivity enforcement.
relative_s_error	S-parameter error tolerance.
save_fields	Flag indicating if the extraction of surface current data is turned on.
save_rad_fields_only	Flag indicating if the saving of only radiated fields is turned on.
use_q3d_for_dc	Flag indicating if the Q3D solver is used for DC point extraction.
frequency_string	A string describing the frequency sweep. Below is an example.

Attributes

sim_setup

Import detail

from pyedb.dotnet.database.sim_setup_data.data.sweep_data import SweepData

Property detail

property SweepData.name

Name of the sweep.

property SweepData.frequencies

List of frequency points.

property SweepData.adaptive_sampling

Flag indicating if adaptive sampling is turned on.

Returns:

bool

True if adaptive sampling is used, False otherwise.

property SweepData.adv_dc_extrapolation

Flag indicating if advanced DC extrapolation is turned on.

Returns:

bool

True if advanced DC Extrapolation is used, False otherwise.

property SweepData.compute_dc_point

Flag indicating if computing the exact DC point is turned on.

property SweepData.auto_s_mat_only_solve

Flag indicating if Auto SMatrix only solve is turned on.

property SweepData.enforce_causality

Flag indicating if causality is enforced.

Returns:

bool

True if enforce causality is used, False otherwise.

property SweepData.enforce_dc_and_causality

Flag indicating if DC point and causality are enforced.

Returns:

bool

True if enforce dc point and causality is used, False otherwise.

property SweepData.enforce_passivity

Flag indicating if passivity is enforced.

Returns:

bool

True if enforce passivity is used, False otherwise.

property SweepData.freq_sweep_type

Sweep type.

Options are: - "kInterpolatingSweep" - "kDiscreteSweep" - "kBroadbandFastSweep"

Returns:

str

Sweep type.

property SweepData.type

Sweep type.

property SweepData.interpolation_use_full_basis

Flag indicating if full-basis elements is used.

Returns:

bool

True if full basis interpolation is used, False otherwise.

property SweepData.interpolation_use_port_impedance

Flag indicating if port impedance interpolation is turned on.

Returns:

bool

True if port impedance is used, False otherwise.

property SweepData.interpolation_use_prop_const

Flag indicating if propagation constants are used.

Returns:

bool

True if propagation constants are used, False otherwise.

property SweepData.interpolation_use_s_matrix

Flag indicating if the S matrix is used.

Returns:

bool

True if S matrix are used, False otherwise.

property SweepData.max_solutions

Number of maximum solutions.

Returns:

int

property SweepData.min_freq_s_mat_only_solve

Minimum frequency SMatrix only solve.

Returns:

str

Frequency with units.

property SweepData.min_solved_freq

Minimum solved frequency with units.

Returns:

str

Frequency with units.

property SweepData.passivity_tolerance

Tolerance for passivity enforcement.

Returns:

float

property SweepData.relative_s_error

S-parameter error tolerance.

Returns:

float

property SweepData.save_fields

Flag indicating if the extraction of surface current data is turned on.

Returns:

bool

True if save fields is enabled, False otherwise.

property SweepData.save_rad_fields_only

Flag indicating if the saving of only radiated fields is turned on.

Returns:

bool

True if save radiated field only is used, False otherwise.

property SweepData.use_q3d_for_dc

Flag indicating if the Q3D solver is used for DC point extraction.

Returns:

bool

True if Q3d for DC point is used, False otherwise.

property SweepData.frequency_string

A string describing the frequency sweep. Below is an example. [‘LIN 0GHz 20GHz 0.05GHz’, ‘LINC 20GHz 30GHz 10’, ‘DEC 40GHz 50GHz 10’]

Attribute detail

SweepData.sim_setup = None

Method detail

SweepData.set_frequencies_linear_scale(start='0.1GHz', stop='20GHz', step='50MHz')

Set a linear scale frequency sweep.

Parameters:

startstr, float, optional

Start frequency. The default is "0.1GHz".

stopstr, float, optional

Stop frequency. The default is "20GHz".

stepstr, float, optional

Step frequency. The default is "50MHz".

Returns:

bool

True if correctly executed, False otherwise.

SweepData.set_frequencies_linear_count(start='1kHz', stop='0.1GHz', count=10)

Set a linear count frequency sweep.

Parameters:

startstr, float, optional

Start frequency. The default is "1kHz".

stopstr, float, optional

Stop frequency. The default is "0.1GHz".

countint, optional

Step frequency. The default is 10.

Returns:

bool

True if correctly executed, False otherwise.

SweepData.set_frequencies_log_scale(start='1kHz', stop='0.1GHz', samples=10)

Set a log-count frequency sweep.

Parameters:

startstr, float, optional

Start frequency. The default is "1kHz".

stopstr, float, optional

Stop frequency. The default is "0.1GHz".

samplesint, optional

Step frequency. The default is 10.

Returns:

bool

True if correctly executed, False otherwise.

SweepData.set_frequencies(frequency_list=None, update=True)

Set frequency list to the sweep frequencies.

Parameters:

frequency_listlist, optional

List of lists with four elements. The default is None. If provided, each list must contain:

1 - frequency type ("linear count", "log scale", or "linear scale") 2 - start frequency 3 - stop frequency 4 - step frequency or count

Returns

——-

bool

True if correctly executed, False otherwise.

SweepData.add(sweep_type, start, stop, increment)

SweepData.add_frequencies(frequencies)

SweepData.clear()