Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added various phase options dictionaries to the API documentation. #956

Merged
merged 1 commit into from
Aug 9, 2023
Merged

Added various phase options dictionaries to the API documentation. #956

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 87 additions & 5 deletions docs/dymos_book/api/phase_api.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,15 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# The Phase API"
"# Phase Options"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Options"
"## Phase.options\n",
"General options available to all dymos Phases."
]
},
{
Expand All @@ -67,14 +68,95 @@
},
"outputs": [],
"source": [
"om.show_options_table('dymos.phase.Phase')"
"import dymos\n",
"phase = dymos.Phase()\n",
"\n",
"om.show_options_table(phase)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"The transcription is an instance of one of the [transcriptions](./transcriptions_api) available in Dymos.\n",
"\n",
"\n",
"Other options listed below control the behavior of various aspects of Phases.\n",
"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."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Phase.timeseries_options\n",
"\n",
"These options control the behavior of timeseries within a Phase."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"scrolled": true,
"tags": [
"remove-input"
]
},
"outputs": [],
"source": [
"om.show_options_table(phase.timeseries_options)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Phase.refine_options\n",
"These options control grid refinement within each Phase."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"scrolled": true,
"tags": [
"remove-input"
]
},
"outputs": [],
"source": [
"om.show_options_table(phase.refine_options)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Phase.simulate_options\n",
"These options control the behavior of phase explicit simulation."
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"scrolled": true,
"tags": [
"remove-input"
]
},
"outputs": [],
"source": [
"om.show_options_table(phase.simulate_options)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"The transcription is an instance of one of the [transcriptions](./transcriptions_api) available in Dymos.\n"
"# Phase Methods"
]
},
{
Expand Down Expand Up @@ -205,7 +287,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.10.5"
"version": "3.11.4"
}
},
"nbformat": 4,
Expand Down