Optimizer.SetGradientValue(TrajectoryPhase, Variable, Array, Array) Method

Top

Description

Sets the value of multiple Gradient elements. The state variable indices of the Gradient elements are determined by the TrajectoryPhase, Node, and Indices arguments.

Timing Precision Mode

This page describes functionality in nanosecond timing precision mode.

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

Method Signature

Optimizer.SetGradientValue(	TrajectoryPhase trajectoryPhase,
	Variable node,
	Array stateIndices,
	Array values)

Arguments

trajectoryPhase
Description:	The TrajectoryPhase object associated with the jacobian values to set.

node
Description:	The index of the node point associated with the jacobian values to set.
Valid Range:	node ≥ 0

stateIndices
Description:	The indices of the TrajectoryPhase node state vector associated with the jacobian values to set. Indices: [ 0 : x, 1 : y, 2 : z, 3 : vx, 4 : vy, 5 : vz, 6 : mass, 7 : epoch, 8+ : control variables].
Required Size:	At least 1

values
Description:	The jacobian values to set.
Required Size:	At least 1

Syntax

myOptimizer1.SetGradientValue(myTrajectoryPhase1, myVariable1, myArray1, myArray2);