The Transcriptions API#
The transcription is the means by which Dymos converts the problem of finding a continuous control function which optimizes the operation of some system into a discrete optimization problem which can be solved by an off-the-shelf optimizer.
Dymos currently supports the following transcriptions
Radau Pseudospectral Method
Gauss-Lobatto Collocation
Explicit Shooting
Radau Options#
| Option | Default | Acceptable Values | Acceptable Types | Description |
|---|---|---|---|---|
| compressed | True | [True, False] | ['bool'] | Use compressed transcription, meaning state and control valuesat segment boundaries are not duplicated on input. This implicitly enforces value continuity between segments but in some cases may make the problem more difficult to solve. |
| num_segments | 1 | N/A | ['int'] | Number of segments |
| order | 5 | N/A | ['int', 'Sequence', 'ndarray'] | Order of the state transcription. The order of the control transcription is `order - 1`. |
| segment_ends | N/A | N/A | ['Sequence', 'ndarray'] | Locations of segment ends or None for equally spaced segments |
| solve_segments | False | [False, 'forward', 'backward'] | N/A | Applies 'solve_segments' behavior to _all_ states in the Phase. If 'forward', collocation defects within each segment are solved with a Newton solver by fixing the initial value in the phase (if using compressed transcription) or segment (if not using compressed transcription). This provides a forward shooting (or multiple shooting) method. If 'backward', the final value in the phase or segment is fixed and a solver finds the other ones to mimic reverse propagation. Set to False (the default) to explicitly disable the use of a solver to converge the state time history. |
GaussLobatto Options#
| Option | Default | Acceptable Values | Acceptable Types | Description |
|---|---|---|---|---|
| compressed | True | [True, False] | ['bool'] | Use compressed transcription, meaning state and control valuesat segment boundaries are not duplicated on input. This implicitly enforces value continuity between segments but in some cases may make the problem more difficult to solve. |
| num_segments | 1 | N/A | ['int'] | Number of segments |
| order | [5] | N/A | ['int', 'Sequence', 'ndarray'] | Order of the state transcription. The order of the control transcription is `order - 1`. |
| segment_ends | N/A | N/A | ['Sequence', 'ndarray'] | Locations of segment ends or None for equally spaced segments |
| solve_segments | False | [False, 'forward', 'backward'] | N/A | Applies 'solve_segments' behavior to _all_ states in the Phase. If 'forward', collocation defects within each segment are solved with a Newton solver by fixing the initial value in the phase (if using compressed transcription) or segment (if not using compressed transcription). This provides a forward shooting (or multiple shooting) method. If 'backward', the final value in the phase or segment is fixed and a solver finds the other ones to mimic reverse propagation. Set to False (the default) to explicitly disable the use of a solver to converge the state time history. |
ExplicitShooting Options#
| Option | Default | Acceptable Values | Acceptable Types | Description | Deprecation |
|---|---|---|---|---|---|
| atol | 1e-06 | N/A | ['float'] | N/A | |
| compressed | True | [True, False] | ['bool'] | Use compressed transcription, meaning state and control valuesat segment boundaries are not duplicated on input. This implicitly enforces value continuity between segments but in some cases may make the problem more difficult to solve. | N/A |
| first_step | N/A | N/A | ['float'] | N/A | |
| grid | GaussLobattoGrid | N/A | ['GaussLobattoGrid', 'RadauGrid', 'BirkhoffGrid', 'str'] | The grid distribution used to layout the control inputs and provide the default output nodes. | N/A |
| max_step | inf | N/A | ['float'] | N/A | |
| method | DOP853 | N/A | ['str'] | The integration method used. | N/A |
| num_segments | 1 | N/A | ['int'] | Number of segments | N/A |
| num_steps_per_segment | N/A | N/A | ['int'] | Number of integration steps in each segment | Option `num_steps_per_segment is deprecated. ExplicitShooting now uses adaptive-step methods. |
| order | 5 | N/A | ['int', 'Sequence', 'ndarray'] | Order of the state transcription. The order of the control transcription is `order - 1`. | N/A |
| output_grid | N/A | N/A | ['GaussLobattoGrid', 'RadauGrid', 'UniformGrid', 'BirkhoffGrid'] | The grid distribution determining the location of the output nodes. The default value of None will result in the use of the grid for outputs. This is useful for the implementation of path constraints but can result in highly nonlinear dynamics being smoothed over in the outputs. When used for validation through simulation, it is generally wise to choose an output grid that is more dense than the input grid to capture this nonlinearity. | N/A |
| propagate_derivs | True | [True, False] | ['bool'] | If True, propagate the state and derivatives of the state and time with respect to the integration parameters. If False, only propagate the primal states. If only using this transcription to propagate an ODE and derivatives are nof needed, setting this option to False should result in faster execution. | N/A |
| rtol | 1e-09 | N/A | ['float'] | N/A | |
| segment_ends | N/A | N/A | ['Sequence', 'ndarray'] | Locations of segment ends or None for equally spaced segments | N/A |
| subprob_reports | False | N/A | N/A | Controls the reports made when running the subproblems for ExplicitShooting | N/A |