The Phase API#
-Options#
+Phase Options#
+Phase.options#
+General options available to all dymos Phases.
The transcription is an instance of one of the transcriptions available in Dymos.
+Other options listed below control the behavior of various aspects of Phases.
+While most have corresponding phase methods for setting these values, users may now use the set
method of OpenMDAO’s OptionsDictionary to set the values of these options.
Phase.timeseries_options#
+These options control the behavior of timeseries within a Phase.
+Option | Default | Acceptable Values | Acceptable Types | Description |
---|---|---|---|---|
include_control_rates | False | [True, False] | ['bool'] | If True, include control rates in the timeseries outputs by default. |
include_parameters | False | [True, False] | ['bool'] | If True, include the parameters in the timeseries outputs by default. |
include_state_rates | False | [True, False] | ['bool'] | If True, include state rates in the timeseries outputs by default. |
include_t_phase | False | [True, False] | ['bool'] | If True, include the elapsed phase time in the timeseries outputs by default. |
use_prefix | False | [True, False] | ['bool'] | If True, prefix the timeseries variable output with the type of variable (this is legacy behavior that changed in Dymos 1.8.0) |
Phase.refine_options#
+These options control grid refinement within each Phase.
+Option | Default | Acceptable Values | Acceptable Types | Description |
---|---|---|---|---|
max_order | 14 | N/A | ['int'] | Maximum transcription order for segments in this phase. |
min_order | 3 | N/A | ['int'] | Minimum transcription order for segments in this phase. |
refine | True | [True, False] | ['bool'] | If True, this Phase may be refined during the grid refinement procedure. |
smoothness_factor | 1.2 | N/A | ['float'] | Maximum allowed ratio of state second derivatives across refinement iterations |
tolerance | 0.0001 | N/A | ['float'] | Default tolerance for grid refinement in this phase. |
Phase.simulate_options#
+These options control the behavior of phase explicit simulation.
+Option | Default | Acceptable Values | Acceptable Types | Description |
---|---|---|---|---|
atol | 1e-06 | N/A | ['float', 'array'] | Absolute error tolerance for variable step integration. |
first_step | N/A | N/A | ['float'] | Initial step size, or None if the algorithm should choose. |
max_step | inf | N/A | ['float'] | Maximum allowable step size |
method | DOP853 | ['RK23', 'RK45', 'DOP853', 'BDF', 'Radau', 'LSODA'] | N/A | The method used by simulate to propagate the ODE. |
rtol | 0.001 | N/A | ['float', 'array'] | Relative error tolerance for variable step integration. |
Phase Methods#
set_time_options#
@@ -1581,7 +1688,14 @@interp