IPOPTResult

class ansys.stk.core.stkobjects.astrogator.IPOPTResult

Properties for objecvtive and constraints of a IPOPT profile.

Overview

Properties

enable	If true, the variable is being used.
name	Get the name of the parameter.
current_value	Get the value achieved for this dependent variable in the last targeter run. Dimension depends on context.
parent_name	Object - the name of the segment to which the parameter belongs.
lower_bound	Get or set the lower limit achievable by this quantity in the optimizer’s iteration history. Dimension depends on context.
upper_bound	Get or set the upper limit achievable by this quantity in the optimizer’s iteration history. Dimension depends on context.
scaling_value	Apply to the Specified Value scaling method. Dimension depends on context.
weight	Get or set the factor by which the constraint error is to be multiplied.
goal	Get or set the purpose of the element in the problem.
use_custom_display_unit	If true, allows display of values in another unit.
custom_display_unit	Get or set the unit in which the value will be displayed in the GUI.

Import detail

from ansys.stk.core.stkobjects.astrogator import IPOPTResult

Property detail

property IPOPTResult.enable: bool

If true, the variable is being used.

property IPOPTResult.name: str

Get the name of the parameter.

property IPOPTResult.current_value: Any

Get the value achieved for this dependent variable in the last targeter run. Dimension depends on context.

property IPOPTResult.parent_name: str

Object - the name of the segment to which the parameter belongs.

property IPOPTResult.lower_bound: Any

Get or set the lower limit achievable by this quantity in the optimizer’s iteration history. Dimension depends on context.

property IPOPTResult.upper_bound: Any

Get or set the upper limit achievable by this quantity in the optimizer’s iteration history. Dimension depends on context.

property IPOPTResult.scaling_value: Any

Apply to the Specified Value scaling method. Dimension depends on context.

property IPOPTResult.weight: float

Get or set the factor by which the constraint error is to be multiplied.

property IPOPTResult.goal: IPOPTGoal

Get or set the purpose of the element in the problem.

property IPOPTResult.use_custom_display_unit: bool

If true, allows display of values in another unit.

property IPOPTResult.custom_display_unit: str

Get or set the unit in which the value will be displayed in the GUI.