create_linear_step_sweep#
- Hfss3dLayout.create_linear_step_sweep(setup, unit, start_frequency, stop_frequency, step_size, name=None, save_fields=True, save_rad_fields_only=False, sweep_type='Interpolating', interpolation_tol_percent=0.5, interpolation_max_solutions=250, use_q3d_for_dc=False)[source]#
Create a sweep with the specified frequency step.
- Parameters:
- setup
str
Name of the setup to attach to the sweep.
- unit
str
Unit of the frequency. For example,
"MHz"
or"GHz"
.- start_frequency
float
Starting frequency of the sweep.
- stop_frequency
float
Stopping frequency of the sweep.
- step_size
float
Frequency size of the step.
- name
str
,optional
Name of the sweep. The default is
None
, in which case a name is automatically assigned.- save_fieldsbool,
optional
Whether to save fields for a discrete sweep only. The default is
True
.- save_rad_fields_onlybool,
optional
Whether to save only radiated fields if
save_fields=True
. The default isFalse
.- sweep_type
str
,optional
Type of the sweep. Options are
"Fast"
,"Interpolating"
, and"Discrete"
. The default is"Interpolating"
.- interpolation_tol_percent
float
,optional
Error tolerance threshold for the interpolation process. The default is
0.5
.- interpolation_max_solutions
int
,optional
Maximum number of solutions to evaluate for the interpolation process. The default is
250
.- use_q3d_for_dcbool,
optional
Whether to use Q3D to solve the DC point. The default is
False
.
- setup
- Returns:
ansys.aedt.core.modules.solve_sweeps.SweepHFSS3DLayout
or boolSweep object if successful,
False
otherwise.
References
>>> oModule.AddSweep