add_sweep_points#

SetupCircuit.add_sweep_points(sweep_variable: str = 'Freq', sweep_points: int = 1, units: str = 'GHz', override_existing_sweep: bool = True) → bool#

Add a linear count sweep to existing Circuit Setup.

Parameters:

sweep_variablestr, optional

Variable to which the sweep belongs. Default is "Freq.

sweep_pointsfloat or str or list, optional

Sweep points to apply linear sweep. It can be a list or single points.: Points can be float or str. If str then no units will be applied.

end_point float or str, optional

End Point of Linear Count sweep. If str then no units will be applied.

unitsstr, optional

Sweeps Units. It will be ignored if strings are provided as start_point or end_point

override_existing_sweepbool, optional

Define if existing sweep on the same variable has to be overridden or kept and added to this new sweep.

Returns:

bool: True is succeeded.

References

>>> oModule.EditLinearNetworkAnalysis
>>> oModule.EditDCAnalysis
>>> oModule.EditTransient
>>> oModule.EditQuickEyeAnalysis
>>> oModule.EditVerifEyeAnalysis
>>> oModule.EditAMIAnalysis

Examples

>>> from ansys.aedt.core import Circuit
>>> from ansys.aedt.core.generic.constants import Setups
>>> circuit_app = Circuit()
>>> setup1 = circuit_app.create_setup("circuit", Setups.NexximLNA)
>>> setup1.add_sweep_points(sweep_variable="Freq", sweep_points=[1, 2, 3])