IpoptOptions Object

 Top  Previous  Next

Description

The IpoptOptions object provides access to configuration parameters that are specific to the third party Ipopt optimization system.

 

Inheritance Hierarchy: Object->OptimizerOptions->IpoptOptions

 

Available In Editions:

Mission

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Properties

 

Name

Description

Attributes

ComplementarityInfeasibilityTolerance

Absolute tolerance on the final complementarity. Refer to Ipopt documentation for more information.

Type:   Variable

Access: Read/Write

DeclaredName

The name of the object as declared.

Type:   String

Access: Read-Only

DualInfeasibilityTolerance

Absolute tolerance on the final dual infeasability. Refer to Ipopt documentation for more information.

Type:   Variable

Access: Read/Write

Name

The name displayed for this object in output windows such as views, plots, and reports.

Type:   String

Access: Read/Write

ObjectId

The unique identifier for the object.

Type:   Variable

Access: Read-Only

ObjectType

The type of the object.

Type:   String

Access: Read-Only

OptionsFilename

Specifies the filename to be used to specify a set of user-defined options specific to the execution of ipopt. If this is left blank, it will look for a file called ipopt.opt in the MissionPlan directory. If that is not present, no user-defined options will be loaded.

Type:   String

Access: Read/Write

OutputFilename

Filename used to redirect standard output written from Ipopt.

Type:   String

Access: Read/Write

SharedLibraryFilename

Path and filename to the shared library (.dll on windows, .so on linux) to use.

Type:   String

Access: Read/Write

Tolerance

Relative convergence tolerance. Refer to Ipopt documentation for more information.

Type:   Variable

Access: Read/Write

UseExactHessian

If set to 1 (true), Ipopt will use an exact hessian instead of the default quasi-newton approximation.

 

Warning: Using an exact hessian will introduce extra computational load. If generic constraints have been added through the Optimizer.AddConstraint method, an exact hessian may also inroduce excessive memory requirements.

Type:   Variable

Access: Read/Write

 
 

 

Methods

 

Name

Description

AddIntOption

Adds an option as an integer value to be used in the optimization process. If the option is not valid, it will throw an error on initialization. See the Ipopt documentation for valid options to be set through this interface.

AddNumOption

Adds an option as a floating point value to be used in the optimization process. If the option is not valid, it will throw an error on initialization. See the Ipopt documentation for valid options to be set through this interface.

AddStrOption

Adds an option as a string value to be used in the optimization process. If the option is not valid, it will throw an error on initialization. See the Ipopt documentation for valid options to be set through this interface.

ClearAllOptions

Clears all options that were previously set for the optimization process.

ClearSavedStates

Clears previous saved states for this object.

GetFromFile

Load the object state from the specified FreeFlyer object file.

GetFromString

Load the object state from the specified string.

PutToFile

Convert the object state to FreeFlyer object xml and write to a file.

PutToString

Convert the object state to FreeFlyer object xml and return as a string.

ReferenceEquals

Returns 1 if the argument refers to the calling object and 0 otherwise.

Restore

Restore an object's state from a previously saved state.

Save

Save the object's state so that it can be restored later.

 
 

 

 

See also

Optimization Guide