add_sweep

SetupHFSS.add_sweep(name: str = None, sweep_type: str = 'Interpolating', **props) → 'SweepHFSS' | bool

Add a sweep to the project.

Parameters:

namestr, optional

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

sweep_typestr, optional

Type of the sweep. The default is "Interpolating".

**propsOptional context-dependent keyword arguments can be passed

to the sweep setup

Returns:

ansys.aedt.core.modules.solve_sweeps.SweepHFSS

Sweep object.

References

>>> oModule.InsertFrequencySweep

Examples

>>> from ansys.aedt.core.modules.solve_setup import SetupHFSS
>>> obj = SetupHFSS()
>>> obj.add_sweep(name="MyObject", sweep_type=1)