enable_adaptive_setup_single

SetupHFSS.enable_adaptive_setup_single(freq: float | str = None, max_passes: int = None, max_delta_s: float = None) → bool

Enable HFSS single frequency setup.

Parameters:

freqfloat, str, optional

Frequency at which to set the adaptive convergence. The default is None which will not update the value in setup. You can enter a float value in (GHz) or a string.

max_passesint, optional

Maximum number of adaptive passes. The default is None which will not update the value in setup.

max_delta_sfloat, optional

Delta S convergence criteria. The default is None which will not update the value in setup.

Returns:

bool

True when successful, False when failed.

Examples

>>> import ansys.aedt.core
>>> hfss = ansys.aedt.core.Hfss()
>>> setup1 = hfss.create_setup(name="Setup1")
>>> setup1.enable_adaptive_setup_single(freq="1GHz", max_passes=2)