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:
- setupname
str
Name of the setup.
- unit
str
Unit of the frequency. For example,
"MHz"
or"GHz"
.- freqstart
float
Starting frequency of the sweep.
- freqstop
float
Stopping frequency of the sweep.
- step_size
float
Frequency size of the step.
- sweepname
str
,optional
Name of the sweep. The default is
None
.- save_fieldsbool,
optional
Whether to save fields. The default is
True
.- save_rad_fieldsbool,
optional
Whether to save radiating fields. The default is
False
.- sweep_type
str
,optional
Type of the sweep. Options are
"Discrete"
,``”Interpolating”`` and"Fast"
. The default is"Discrete"
.
- setupname
- Returns:
pyaedt.modules.SolveSweeps.SweepHFSS
or boolSweep 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'>