Name
|
Description
|
Attributes
|
BoundEnforcementMethod
|
The method used to ensure inequality bounds on the state variables are respected. If the computed step will violate a variable bound, the following will be done:
Recompute: A new step is computed that steps directly to the violated bounds.
Truncate: The step is truncated in the dimension of the violation to align with the bound. This is done separately for all state variable dimensions.
|
Type: Variable
Access: Read/Write
|
DeclaredName
|
The name of the object as declared.
|
Type: String
Access: Read-Only
|
DisplayName
|
The name displayed for this object in output windows such as views, plots, and reports.
|
Type: String
Access: Read/Write
|
LineSearchAcceptanceThreshold
|
Defines the minimum amount of improvement required for the line search to accept a step. If the improvement is smaller than this threshold, the solver will decrease the step length until an acceptable step is found or the step length becomes smaller than MinimumStepLength. The improvement is measured by comparing the actual violation reduction to the predicted reduction.
|
Type: Variable
Access: Read/Write
|
LineSearchExpansionThreshold
|
Defines the minimum amount of improvement needed for the line search to increase the maximum step length on the next line search iteration. The improvement is measured by comparing the actual violation reduction to the predicted reduction.
|
Type: Variable
Access: Read/Write
|
MatrixSolveMethod
|
The method used to solve the linear system J * J' where J is the Jacobian of the residuals. The residuals represent all bound violations from both the constraints and the state variables.
|
Type: Variable
Access: Read/Write
|
MaximumStepLength
|
Determines the maximum fraction of the computed step that can be used. A value of 1 means the full computed step can be used. A value of 0.5 means only half of the computed step can be used. If the line search is enabled, this value sets the initial step length for the search. If the line search is not enabled, this value directly determines the step length.
|
Type: Variable
Access: Read/Write
|
MinimumStepLength
|
The smallest value that the line search is allowed to decrease the step length to. If the line search doesn't achieve progress with a step length larger than this value the solver will exit unsuccessfully. The step length represents the fraction of the computed step to use.
|
Type: Variable
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
|
SharedLibraryFilename
|
Path and filename to the shared library (.dll on windows, .so on linux) to use.
|
Type: String
Access: Read/Write
|
UseLineSearch
|
Determines whether a line search will be used to require that each iteration decreases the 2-norm merit function. When the line search is disabled, the maximum step length will define the fraction of the computed step to take.
|
Type: Variable
Access: Read/Write
|
