add_goal

SetupOpti.add_goal(calculation, ranges, variables=None, solution=None, context=None, subdesign_id=None, polyline_points=1001, report_type=None, condition='<=', goal_value=1, goal_weight=1)

Add a goal to the setup.

Parameters:

calculationstr, optional

Name of the calculation.

rangesdict

Dictionary of ranges with respective values. Values can be: None for all values, a List of Discrete Values, a tuple of start and stop range. It includes intrinsics like “Freq”, “Time”, “Theta”, “Distance”.

variableslist, optional

List of variables to include in the optimization.

conditionstr, optional

The default is "<=".

goal_valueoptional

Value for the goal. The default is 1.

goal_weightoptional

Value for the goal weight. The default is 1.

solutionstr, optional

Type of the solution. The default is None, in which case the default solution is used.

contextstr, optional

Calculation contexts. It can be a sphere, a matrix or a polyline.

subdesign_idint, optional

Subdesign id for Circuit and HFSS 3D Layout objects.

polyline_pointsint, optional

Number of points for Polyline context.

report_typestr, optional

Override the auto computation of Calculation Type.

Returns:

bool

True when successful, False when failed.

References

>>> oModule.EditSetup