create_linear_step_sweep

Hfss.create_linear_step_sweep(setupname, unit, freqstart, freqstop, step_size, sweepname=None, save_fields=True, save_rad_fields=False, sweep_type='Discrete')[source]

Create a Sweep with a specified frequency step.

Parameters
setupnamestr

Name of the setup.

unitstr

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

freqstartfloat

Starting frequency of the sweep.

freqstopfloat

Stopping frequency of the sweep.

step_sizefloat

Frequency size of the step.

sweepnamestr, optional

Name of the sweep. The default is None.

save_fieldsbool, optional

Whether to save the fields. The default is True.

save_rad_fieldsbool, optional

Whether to save the radiating fields. The default is False.

sweep_typestr, optional

Whether to create a "Discrete",``”Interpolating”`` or "Fast" sweep. The default is "Discrete".

Returns
pyaedt.modules.SetupTemplates.SweepHFSS or bool

Sweep object if successful, False otherwise.

References

>>> oModule.InsertFrequencySweep

Examples

Create a setup named "LinearStepSetup" and use it in a linear step sweep named "LinearStepSweep".

>>> setup = hfss.create_setup("LinearStepSetup")
>>> linear_step_sweep = hfss.create_linear_step_sweep(setupname="LinearStepSetup",
...                                                   sweepname="LinearStepSweep",
...                                                   unit="MHz", freqstart=1.1e3,
...                                                   freqstop=1200.1, step_size=153.8)
>>> type(linear_step_sweep)
<class 'pyaedt.modules.SetupTemplates.SweepHFSS'>