pyaedt.modules.SetupTemplates.SweepHFSS#

class pyaedt.modules.SetupTemplates.SweepHFSS(setup, sweepname, sweeptype='Interpolating', props=None, **kwargs)[source]#

Initializes, creates, and updates sweeps in HFSS.

Parameters:
app:class ‘pyaedt.modules.SolveSetup.Setup’

Setup used for the analysis.

setupnamestr

Name of the setup.

sweepnamestr

Name of the sweep.

sweeptypestr, optional

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

propsdict, optional

Dictionary of the properties. The default is None, in which case the default properties are retrieved.

Examples

>>> hfss = Hfss(specified_version=version, projectname=proj, designname=gtemDesign, solution_type=solutiontype,
                setup_name=setupname, new_desktop_session=False, close_on_exit=False)
>>> hfss_setup = hfss.setups[0]
>>> hfss_sweep = SweepHFSS(hfss_setup, 'Sweep', sweeptype ='Interpolating', props=None)

Methods

SweepHFSS.add_subrange(rangetype, start[, ...])

Add a range to the sweep.

SweepHFSS.create()

Create a sweep.

SweepHFSS.update()

Update a sweep.

Attributes

SweepHFSS.basis_frequencies

Get the list of all frequencies which have fields available.

SweepHFSS.frequencies

Get the list of all frequencies of the active sweep.

SweepHFSS.is_solved

Verify if solutions are available for given sweep.