create_frequency_sweep#

SetupHFSS.create_frequency_sweep(unit=None, freqstart=1, freqstop=10, num_of_freq_points=None, sweepname=None, save_fields=True, save_rad_fields=False, sweep_type='Discrete', interpolation_tol=0.5, interpolation_max_solutions=250)[source]#

Create a sweep with the specified number of points.

Parameters:
unitstr, optional

Frequency Units. The default is None which takes the Default Desktop units.

freqstartfloat, str, optional

Starting frequency of the sweep. The default is 1. If a unit is passed with number, such as "1MHz", the unit will be ignored.

freqstopfloat, str, optional

Stopping frequency of the sweep. The default is 10. If a unit is passed with number, such as ``”1MHz”`, the unit is ignored.

num_of_freq_pointsint

Number of frequency points in the range. The default is 401 for a sweep type of "Interpolating" or "Fast". The default is 5 for a sweep type of "Discrete".

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

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

interpolation_tolfloat, optional

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

interpolation_max_solutionsint, optional

Maximum number of solutions evaluated for the interpolation process. The default is 250.

Returns:
pyaedt.modules.SolveSweeps.SweepHFSS or bool

Sweep object if successful, False otherwise.

References

>>> oModule.InsertFrequencySweep

Examples

Create a setup named "LinearCountSetup" and use it in a linear count sweep named "LinearCountSweep".

>>> setup = hfss.create_setup("LinearCountSetup")
>>> linear_count_sweep = hfss.create_linear_count_sweep(setupname="LinearCountSetup",
...                                                     sweepname="LinearCountSweep",
...                                                     unit="MHz", freqstart=1.1e3,
...                                                     freqstop=1200.1, num_of_freq_points=1658)
>>> type(linear_count_sweep)
<class 'pyaedt.modules.SetupTemplates.SweepHFSS'>