add_subrange

SweepMatrix.add_subrange(range_type: str, start: float, end: float = None, count: float = None, unit: str = 'GHz', clear: bool = False, save_single_fields: bool = False) → bool

Add a subrange to the sweep.

Parameters:

range_typestr

Type of the subrange. Options are "LinearCount", "LinearStep", and "LogScale".

startfloat

Starting frequency.

endfloat

Stopping frequency. The default is None.

countint or float

Frequency count or frequency step. The default is None.

unitstr, optional

Frequency units.

clearbool, optional

Whether to replace the subrange. The default is False, in which case subranges are appended.

save_single_fieldsbool, optional

Whether to save the fields of the single point. The default is False. This parameter is used only for range_type="SinglePoints".

Returns:

bool

True when successful, False when failed.

Examples

>>> from ansys.aedt.core import Q3d
>>> app = Q3d()
>>> setup = app.create_setup()
>>> setup.create_single_point_sweep(save_single_field=[True, False, False], freq=[6, 10, 12], unit="GHz")