IPOPTControl

class ansys.stk.core.stkobjects.astrogator.IPOPTControl

Control parameters for IPOPT optimizer profile.

Overview

Properties

enable	If true, the variable is being used.
name	Get the name of the parameter.
parent_name	Get the name of the segment to which the parameter belongs.
initial_value	Get the nominal value of the element selected as a parameter. Dimension depends on context.
current_value	Get or set the value of the independent variable after the last targeter run.
lower_bound	Dimension depends on context.
upper_bound	Dimension depends on context.
scaling_value	Apply to the Specified Value scaling method. Dimension depends on context.
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 IPOPTControl

Property detail

property IPOPTControl.enable: bool

If true, the variable is being used.

property IPOPTControl.name: str

Get the name of the parameter.

property IPOPTControl.parent_name: str

Get the name of the segment to which the parameter belongs.

property IPOPTControl.initial_value: Any

Get the nominal value of the element selected as a parameter. Dimension depends on context.

property IPOPTControl.current_value: Any

Get or set the value of the independent variable after the last targeter run.

property IPOPTControl.lower_bound: Any

Dimension depends on context.

property IPOPTControl.upper_bound: Any

Dimension depends on context.

property IPOPTControl.scaling_value: Any

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

property IPOPTControl.use_custom_display_unit: bool

If true, allows display of values in another unit.

property IPOPTControl.custom_display_unit: str

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