create_linear_step_sweep

Hfss3dLayout.create_linear_step_sweep(setup: str, unit: str, start_frequency: float, stop_frequency: float, step_size: float, name: str | None = None, save_fields: bool | None = True, save_rad_fields_only: bool | None = False, sweep_type: str | None = 'Interpolating', interpolation_tol_percent: float | None = 0.5, interpolation_max_solutions: int | None = 250, use_q3d_for_dc: bool | None = False) → SweepHFSS3DLayout | bool

Create a sweep with the specified frequency step.

Parameters:

setupstr

Name of the setup to attach to the sweep.

unitstr

Unit of the frequency. For example, "MHz" or "GHz".

start_frequencyfloat

Starting frequency of the sweep.

stop_frequencyfloat

Stopping frequency of the sweep.

step_sizefloat

Frequency size of the step.

namestr, 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 is False.

sweep_typestr, optional

Type of the sweep. Options are "Fast", "Interpolating", and "Discrete". The default is "Interpolating".

interpolation_tol_percentfloat, optional

Error tolerance threshold for the interpolation process. The default is 0.5.

interpolation_max_solutionsint, 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.

Returns:

ansys.aedt.core.modules.solve_sweeps.SweepHFSS3DLayout or bool

Sweep object if successful, False otherwise.

References

>>> oModule.AddSweep