add#
- OptimizationSetups.add(calculation=None, ranges=None, variables=None, optimization_type='Optimization', condition='<=', goal_value=1, goal_weight=1, solution=None, name=None, context=None, subdesign_id=None, polyline_points=1001, report_type=None)[source]#
Add a basic optimization analysis. You can customize all options after the analysis is added.
- Parameters:
- calculation
str
,optional
Name of the calculation.
- ranges
dict
,optional
Dictionary of ranges with respective values. Values can be: a list of discrete values, a dict with tuple args of start and stop range. It includes intrinsics like “Freq”, “Time”, “Theta”, “Distance”.
- variables
list
,optional
List of variables to include in the optimization. By default all variables are included.
- optimization_type
strm
optional
Optimization Type. Possible values are “Optimization”, “DXDOE”,`”DesignExplorer”,”Sensitivity”,”Statistical”` and “optiSLang”.
- condition
str
,optional
The default is
"<="
.- goal_value
optional
Value for the goal. The default is
1
.- goal_weight
optional
Value for the goal weight. The default is
1
.- solution
str
,optional
Type of the solution. The default is
None
, in which case the default solution is used.- name
str
,optional
Name of the analysis. The default is
None
, in which case a default name is assigned.- context
str
,optional
Calculation contexts. It can be a sphere, a matrix or a polyline.
- subdesign_id
int
,optional
Subdesign id for Circuit and HFSS 3D Layout objects.
- polyline_points
int
,optional
Number of points for Polyline context.
- report_type
str
,optional
Override the auto computation of Calculation Type.
- calculation
- Returns:
ansys.aedt.core.modules.design_xploration.SetupOpti
Optimization object.
References
>>> oModule.InsertSetup