SweepData

class pyedb.grpc.database.simulation_setup.sweep_data.SweepData(pedb, name='sweep_data', distribution='lin', start_f=0.0, end_f=10000000000.0, step=10000000.0, core: GrpcSweepData = None)

Frequency sweep data class. PARAMETERS ———- pedb : Pedb

Parent EDB object.

namestr, default: “”

Name of the sweep data.

distributionstr, default: “lin”

Distribution type of the frequency sweep. Supported types are: “lin”, “dec”, “estp”, “linc”, “oct”.

start_ffloat, default: 0.0

Start frequency of the sweep in Hz.

end_ffloat, default: 10e9

End frequency of the sweep in Hz.

stepfloat, default: 10e6

Frequency step of the sweep in Hz.

Overview

Properties

name	Get the name of the frequency sweep data.
frequency_data	Get the frequency data of the sweep.
enabled	Get the enabled status of the frequency sweep.
type	Get the type of the frequency sweep.
use_q3d_for_dc	Get the flag indicating if Q3D is used for DC bias.
save_fields	Get the flag indicating if fields are saved during the sweep.
save_rad_fields_only	Get the flag indicating if only radiation fields are saved.
compute_dc_point	Get the flag indicating if DC point is computed.
siwave_with_3dddm	Get the flag indicating if SIwave with 3D-DDM is used.
use_hfss_solver_regions	Get the flag indicating if HFSS solver regions are used.
frequency_string	Get the frequency sweep string.
enforce_causality	Get the flag indicating if causality is enforced.
enforce_passivity	Get the flag indicating if passivity is enforced.
interpolation_data	Get the interpolation data points.

Import detail

from pyedb.grpc.database.simulation_setup.sweep_data import SweepData

Property detail

property SweepData.name: str

Get the name of the frequency sweep data.

property SweepData.frequency_data: ansys.edb.core.simulation_setup.simulation_setup.FrequencyData

Get the frequency data of the sweep.

Returns:

GrpcFrequencyData

Frequency data object.

property SweepData.enabled: bool

Get the enabled status of the frequency sweep.

Returns:

bool

Enabled status.

property SweepData.type: str

Get the type of the frequency sweep.

Returns:

str

Frequency sweep type. Values are: “interpolating”, “discrete”, “broadband”.

property SweepData.use_q3d_for_dc: bool

Get the flag indicating if Q3D is used for DC bias.

Returns:

bool

True if Q3D is used for DC bias, False otherwise.

property SweepData.save_fields: bool

Get the flag indicating if fields are saved during the sweep.

Returns:

bool

True if fields are saved, False otherwise.

property SweepData.save_rad_fields_only: bool

Get the flag indicating if only radiation fields are saved.

Returns:

bool

True if only radiation fields are saved, False otherwise.

property SweepData.compute_dc_point: bool

Get the flag indicating if DC point is computed.

Returns:

bool

True if DC point is computed, False otherwise.

property SweepData.siwave_with_3dddm: bool

Get the flag indicating if SIwave with 3D-DDM is used.

Returns:

bool

True if SIwave with 3D-DDM is used, False otherwise.

property SweepData.use_hfss_solver_regions: bool

Get the flag indicating if HFSS solver regions are used.

Returns:

bool

True if HFSS solver regions are used, False otherwise.

property SweepData.frequency_string: str

Get the frequency sweep string.

Returns:

str

Frequency sweep string.

property SweepData.enforce_causality: bool

Get the flag indicating if causality is enforced.

Returns:

bool

True if causality is enforced, False otherwise.

property SweepData.enforce_passivity: bool

Get the flag indicating if passivity is enforced.

Returns:

bool

True if passivity is enforced, False otherwise.

property SweepData.interpolation_data

Get the interpolation data points.

Returns:

list[float]

List of interpolation data points in Hz.