create_linear_step_sweep#

SetupQ3D.create_linear_step_sweep(unit='GHz', freqstart=0, freqstop=2, step_size=0.05, sweepname=None, save_fields=True, sweep_type='Discrete')[source]#

Create a Sweep with a specified frequency step.

Parameters:
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.

sweep_typestr, optional

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

Returns:
pyaedt.modules.SolveSweeps.SweepQ3D 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". >>> from pyaedt import Q3d >>> q3d = Q3d() >>> setup = q3d.create_setup(“LinearStepSetup”) >>> linear_step_sweep = setup.create_linear_step_sweep(sweepname=”LinearStepSweep”, … unit=”MHz”, freqstart=1.1e3, … freqstop=1200.1, step_size=153.8) >>> type(linear_step_sweep) >>> q3d.release_desktop(True, True)