create_frequency_sweep#
- Q3d.create_frequency_sweep(setupname, units=None, freqstart=0, freqstop=1, freqstep=None, sweepname=None)[source]#
Create a frequency sweep.
- Parameters:
- setupname
str
Name of the setup that is attached to the sweep.
- units
str
,optional
Units of the frequency. For example,
"MHz"
or"GHz"
. The default isNone
which takes the Default Desktop units.- freqstart
float
,str
,optional
- Starting frequency of the sweep. The default is
0
. If a unit is passed with the number, such as
"1MHz"
, the unit is ignored.
- Starting frequency of the sweep. The default is
- freqstop
float
,str
,optional
Stopping frequency of the sweep. The default is
1
. If a unit is passed with the number, such as``”1MHz”``, the unit is ignored.- freqstep
optional
Frequency step point.
- sweepname
str
,optional
Name of the sweep. The default is
None
, in which case the default name is used.
- setupname
- Returns:
pyaedt.modules.SolveSweeps.SweepHFSS3DLayout
Sweep object when successful,
False
when failed.
References
>>> oModule.InsertSweep