add_calculation#
- SetupParam.add_calculation(calculation, ranges=None, variables=None, solution=None, context=None, subdesign_id=None, polyline_points=1001, report_type=None)#
Add a calculation to the setup.
- Parameters:
- calculation
str,optional Name of the calculation.
- ranges
dict,optional 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”. The default is
None, to be used e.g. in “Eigenmode” design type.- solution
str,optional Type of the solution. The default is
None, in which case the default solution is used.- 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:
- bool
Truewhen successful,Falsewhen failed.
References
>>> oModule.EditSetup