-
-

The Phase API#

-
-

Options#

+
+

Phase Options#

+
+

Phase.options#

+

General options available to all dymos Phases.

@@ -531,7 +543,102 @@

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.

+
+
+
+ + + + + + +

+ + + + + + + +
OptionDefaultAcceptable ValuesAcceptable TypesDescription
include_control_ratesFalse[True, False]['bool']If True, include control rates in the timeseries outputs by default.
include_parametersFalse[True, False]['bool']If True, include the parameters in the timeseries outputs by default.
include_state_ratesFalse[True, False]['bool']If True, include state rates in the timeseries outputs by default.
include_t_phaseFalse[True, False]['bool']If True, include the elapsed phase time in the timeseries outputs by default.
use_prefixFalse[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.

+
+
+
+ + + + + + +

+ + + + + + + +
OptionDefaultAcceptable ValuesAcceptable TypesDescription
max_order14N/A['int']Maximum transcription order for segments in this phase.
min_order3N/A['int']Minimum transcription order for segments in this phase.
refineTrue[True, False]['bool']If True, this Phase may be refined during the grid refinement procedure.
smoothness_factor1.2N/A['float']Maximum allowed ratio of state second derivatives across refinement iterations
tolerance0.0001N/A['float']Default tolerance for grid refinement in this phase.
+ + +
+
+
+
+

Phase.simulate_options#

+

These options control the behavior of phase explicit simulation.

+
+
+
+ + + + + + +

+ + + + + + + +
OptionDefaultAcceptable ValuesAcceptable TypesDescription
atol1e-06N/A['float', 'array']Absolute error tolerance for variable step integration.
first_stepN/AN/A['float']Initial step size, or None if the algorithm should choose.
max_stepinfN/A['float']Maximum allowable step size
methodDOP853['RK23', 'RK45', 'DOP853', 'BDF', 'Radau', 'LSODA']N/AThe method used by simulate to propagate the ODE.
rtol0.001N/A['float', 'array']Relative error tolerance for variable step integration.
+ + +
+
+
+
+
+

Phase Methods#

set_time_options#

@@ -1581,7 +1688,14 @@

interp diff --git a/api/run_problem_function.html b/api/run_problem_function.html index 9c357f131..85f5290ff 100644 --- a/api/run_problem_function.html +++ b/api/run_problem_function.html @@ -65,7 +65,7 @@ - + @@ -240,7 +240,8 @@