create_linear_count_sweep

Hfss.create_linear_count_sweep(setupname, unit, freqstart, freqstop, 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)

Create a sweep with a specified number of points.

Parameters:

setupnamestr

Name of the setup.

unitstr

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

freqstartfloat

Starting frequency of the sweep, such as 1.

freqstopfloat

Stopping frequency of the sweep.

num_of_freq_pointsint

Number of frequency points in the range. The default is 401 for sweep_type = "Interpolating". The defaults are “Fast”`` and 5 for sweep_type = ""Discrete".

sweepnamestr, optional

Name of the sweep. The default is None, in which case the default name is automatically assigned.

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'>