SweepData

class ansys.edb.core.simulation_setup.simulation_setup.SweepData(name, distribution, start_f, end_f, step)

Class representing a sweep data setting.

Notes

Here are the choices for the distribution parameter:

Values for distribution parameter

Distribution	Description	Example
LIN	linear (start, stop, step)	LIN 2GHz 4GHz 100MHz or LIN 1dBm 10dBm 1dB
LINC	linear (start, stop, count)	LINC 2GHz 4GHz 11
ESTP	Exponential step (start, stop, count)	ESTP 2MHz 10MHz 3
DEC	decade (start, stop, number of decades)	DEC 10KHz 10GHz 6
OCT	octave (start, stop, number of octaves)	OCT 10MHz 160MHz 5

Attributes:

namestr

Name of this sweep.

distributionstr

Sweep distribution type (see table below).

start_fstr

Start frequency is number with optional frequency units.

end_fstr

End frequency is number with optional frequency units.

stepstr

Step is either frequency with optional frequency units or an integer when a count is needed.

enabledbool

True if this is enabled.

typeFreqSweepType

Type of sweep.

use_q3d_for_dcbool

Use Q3D solver for dc calculations.

save_fieldsbool

Save fields during simulations.

save_rad_fields_onlybool

Save only radiation fields during simulations.

compute_dc_pointbool

Calculate DC point during simulations.

siwave_with_3dddmbool

SIwave with 3D DDM.

use_hfss_solver_regionsbool

SIwave with HFSS solver regions.

use_hfss_solver_region_sch_genbool

SIwave with HFSS solver regions schematic.

use_hfss_solver_region_parallel_solvebool

SIwave with HFSS solver parallel region simulation.

use_adp_solution_for_all_sweep_freqbool

Enable Using Adaptive Solution for all frequency points.

num_parallel_hfss_regionsint

SIwave with HFSS regions: number of regions to solve in parallel.

parallel_hfss_regions_sim_cfglist[HFSSRegionComputeResource]

List of CHFSSRegionComputeResource assignments for parallel region sims.

auto_s_mat_only_solvebool

Auto/Manual SMatrix only solve.

min_freq_s_mat_only_solvestr

Minimum frequency SMatrix only solve.

frequencieslist[str]

Frequency points in the frequency sweep.

steady_state_startfloat

Frequency of Steady State Start.

mesh_freq_choiceint

Meshing frequencies of the observation mesh.

mesh_freq_pointslist[str]

Frequency points in meshing frequencies.

mesh_freq_range_startstr

Start meshing frequency.

mesh_freq_range_stopstr

Stop meshing frequency.

interpolation_dataInterpolatingSweepData

Data for interpolating frequency sweeps.

Methods

Attributes

SweepData.frequency_string

str: String representing the frequency sweep data.