create_single_point_sweep#
- SetupHFSS.create_single_point_sweep(unit='GHz', freq=1, sweepname=None, save_single_field=True, save_fields=False, save_rad_fields=False)[source]#
Create a Sweep with a single frequency point.
- Parameters:
- setupname
str
Name of the setup.
- unit
str
Unit of the frequency. For example,
"MHz
or"GHz"
.- freq
float
,list
Frequency of the single point or list of frequencies to create distinct single points.
- sweepname
str
,optional
Name of the sweep. The default is
None
.- save_single_fieldbool,
list
,optional
Whether to save the fields of the single point. The default is
True
. If a list is specified, the length must be the same as freq length.- save_fieldsbool,
optional
Whether to save the fields for all points and subranges defined in the sweep. The default is
False
.- save_rad_fieldsbool,
optional
Whether to save only the radiating fields. The default is
False
.
- 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 single point sweep named"SinglePointSweep"
.>>> setup = hfss.create_setup("LinearStepSetup") >>> single_point_sweep = hfss.create_single_point_sweep(setupname="LinearStepSetup", ... sweepname="SinglePointSweep", ... unit="MHz", freq=1.1e3) >>> type(single_point_sweep) <class 'pyaedt.modules.SetupTemplates.SweepHFSS'>