{ "cells": [ { "cell_type": "code", "execution_count": 1, "id": "4d89248f", "metadata": { "execution": { "iopub.execute_input": "2026-10-02T14:40:28.473286Z", "iopub.status.busy": "2026-10-02T14:40:28.473037Z", "iopub.status.idle": "2026-10-02T14:40:28.477991Z", "shell.execute_reply": "2026-10-02T14:40:28.477439Z" }, "papermill": { "duration": 0.123799, "end_time": "2026-10-02T14:40:28.478846+00:00", "exception": false, "start_time": "2026-10-02T14:40:28.355047+00:00", "status": "completed" }, "tags": [ "remove-input", "active-ipynb", "remove-output" ] }, "outputs": [], "source": [ "try:\n", " from openmdao.utils.notebook_utils import notebook_mode # noqa: F401\n", "except ImportError:\n", " !python -m pip install openmdao[notebooks]" ] }, { "cell_type": "markdown", "id": "38b0c73d", "metadata": { "papermill": { "duration": 0.110203, "end_time": "2026-10-02T14:40:28.692346+00:00", "exception": false, "start_time": "2026-10-02T14:40:28.582143+00:00", "status": "completed" }, "tags": [] }, "source": [ "# Sanity Checking Your Model\n", "\n", "In the first two tutorials we showed you the basics of how to build up a model from a set of components,\n", "group them together, connect them together, and optimize them.\n", "\n", "Sometimes you put your model together and things don't work quite the way you would expect.\n", "When this happens, OpenMDAO has a number of [debugging](../../features/debugging/debugging) features to help you\n", "understand the structure of your model better and sort out the issue.\n", "Many debugging features are all accessed via a [command line script](../../other_useful_docs/om_command) that is installed along with OpenMDAO itself.\n", "There are a lot of different tools that are accessible from that script, but in this tutorial we'll focus on the most important one:\n", "[check setup](../../other_useful_docs/om_command).\n", "\n", "\n", "## Check Setup\n", "\n", "Check setup runs through a host of different tests to make sure your model is setup correctly and warn you about things that commonly cause problems.\n", "It will:\n", "\n", "1. identify any unconnected inputs (forgetting to connect things is one of the most common mistakes).\n", "2. look for any cycles in your model that indicate the need for solvers (did you mean to create that cycle?).\n", "3. recurse down the model hierarchy and give every group and component a chance to perform its own custom checks.\n", "\n", "For example, if you tried to build the [sellar problem using connections](sellar-connect),\n", "but forgot to issue one of the connections then your problem wouldn't run correctly and you'd get the wrong answer." ] }, { "cell_type": "code", "execution_count": 2, "id": "d8257327", "metadata": { "execution": { "iopub.execute_input": "2026-10-02T14:40:28.805131Z", "iopub.status.busy": "2026-10-02T14:40:28.804937Z", "iopub.status.idle": "2026-10-02T14:40:30.740571Z", "shell.execute_reply": "2026-10-02T14:40:30.739771Z" }, "papermill": { "duration": 1.940204, "end_time": "2026-10-02T14:40:30.741127+00:00", "exception": false, "start_time": "2026-10-02T14:40:28.800923+00:00", "status": "completed" }, "tags": [ "remove-input", "remove-output" ] }, "outputs": [ { "data": { "application/papermill.record/text/html": "
class SellarDis1(om.ExplicitComponent):\n    """\n    Component containing Discipline 1 -- no derivatives version.\n    """\n\n    def __init__(self, units=None, scaling=None):\n        super().__init__()\n        self.execution_count = 0\n        self._units = units\n        self._do_scaling = scaling\n\n    def setup(self):\n\n        if self._units:\n            units = 'ft'\n        else:\n            units = None\n\n        if self._do_scaling:\n            ref = .1\n        else:\n            ref = 1.\n\n        # Global Design Variable\n        self.add_input('z', val=np.zeros(2), units=units)\n\n        # Local Design Variable\n        self.add_input('x', val=0., units=units)\n\n        # Coupling parameter\n        self.add_input('y2', val=1.0, units=units)\n\n        # Coupling output\n        self.add_output('y1', val=1.0, lower=0.1, upper=1000., units=units, ref=ref)\n\n    def setup_partials(self):\n        # Finite difference everything\n        self.declare_partials('*', '*', method='fd')\n\n    def compute(self, inputs, outputs):\n        """\n        Evaluates the equation\n        y1 = z1**2 + z2 + x1 - 0.2*y2\n        """\n\n        z1 = inputs['z'][0]\n        z2 = inputs['z'][1]\n        x1 = inputs['x']\n        y2 = inputs['y2']\n\n        outputs['y1'] = z1**2 + z2 + x1 - 0.2*y2\n\n        self.execution_count += 1\n
\n", "application/papermill.record/text/latex": "\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n\\PY{k}{class}\\PY{+w}{ }\\PY{n+nc}{SellarDis1}\\PY{p}{(}\\PY{n}{om}\\PY{o}{.}\\PY{n}{ExplicitComponent}\\PY{p}{)}\\PY{p}{:}\n\\PY{+w}{ }\\PY{l+s+sd}{\\PYZdq{}\\PYZdq{}\\PYZdq{}}\n\\PY{l+s+sd}{ Component containing Discipline 1 \\PYZhy{}\\PYZhy{} no derivatives version.}\n\\PY{l+s+sd}{ \\PYZdq{}\\PYZdq{}\\PYZdq{}}\n\n \\PY{k}{def}\\PY{+w}{ }\\PY{n+nf+fm}{\\PYZus{}\\PYZus{}init\\PYZus{}\\PYZus{}}\\PY{p}{(}\\PY{n+nb+bp}{self}\\PY{p}{,} \\PY{n}{units}\\PY{o}{=}\\PY{k+kc}{None}\\PY{p}{,} \\PY{n}{scaling}\\PY{o}{=}\\PY{k+kc}{None}\\PY{p}{)}\\PY{p}{:}\n \\PY{n+nb}{super}\\PY{p}{(}\\PY{p}{)}\\PY{o}{.}\\PY{n+nf+fm}{\\PYZus{}\\PYZus{}init\\PYZus{}\\PYZus{}}\\PY{p}{(}\\PY{p}{)}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{execution\\PYZus{}count} \\PY{o}{=} \\PY{l+m+mi}{0}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{\\PYZus{}units} \\PY{o}{=} \\PY{n}{units}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{\\PYZus{}do\\PYZus{}scaling} \\PY{o}{=} \\PY{n}{scaling}\n\n \\PY{k}{def}\\PY{+w}{ }\\PY{n+nf}{setup}\\PY{p}{(}\\PY{n+nb+bp}{self}\\PY{p}{)}\\PY{p}{:}\n\n \\PY{k}{if} \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{\\PYZus{}units}\\PY{p}{:}\n \\PY{n}{units} \\PY{o}{=} \\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{ft}\\PY{l+s+s1}{\\PYZsq{}}\n \\PY{k}{else}\\PY{p}{:}\n \\PY{n}{units} \\PY{o}{=} \\PY{k+kc}{None}\n\n \\PY{k}{if} \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{\\PYZus{}do\\PYZus{}scaling}\\PY{p}{:}\n \\PY{n}{ref} \\PY{o}{=} \\PY{l+m+mf}{.1}\n \\PY{k}{else}\\PY{p}{:}\n \\PY{n}{ref} \\PY{o}{=} \\PY{l+m+mf}{1.}\n\n \\PY{c+c1}{\\PYZsh{} Global Design Variable}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{add\\PYZus{}input}\\PY{p}{(}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{z}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{,} \\PY{n}{val}\\PY{o}{=}\\PY{n}{np}\\PY{o}{.}\\PY{n}{zeros}\\PY{p}{(}\\PY{l+m+mi}{2}\\PY{p}{)}\\PY{p}{,} \\PY{n}{units}\\PY{o}{=}\\PY{n}{units}\\PY{p}{)}\n\n \\PY{c+c1}{\\PYZsh{} Local Design Variable}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{add\\PYZus{}input}\\PY{p}{(}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{x}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{,} \\PY{n}{val}\\PY{o}{=}\\PY{l+m+mf}{0.}\\PY{p}{,} \\PY{n}{units}\\PY{o}{=}\\PY{n}{units}\\PY{p}{)}\n\n \\PY{c+c1}{\\PYZsh{} Coupling parameter}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{add\\PYZus{}input}\\PY{p}{(}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{y2}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{,} \\PY{n}{val}\\PY{o}{=}\\PY{l+m+mf}{1.0}\\PY{p}{,} \\PY{n}{units}\\PY{o}{=}\\PY{n}{units}\\PY{p}{)}\n\n \\PY{c+c1}{\\PYZsh{} Coupling output}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{add\\PYZus{}output}\\PY{p}{(}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{y1}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{,} \\PY{n}{val}\\PY{o}{=}\\PY{l+m+mf}{1.0}\\PY{p}{,} \\PY{n}{lower}\\PY{o}{=}\\PY{l+m+mf}{0.1}\\PY{p}{,} \\PY{n}{upper}\\PY{o}{=}\\PY{l+m+mf}{1000.}\\PY{p}{,} \\PY{n}{units}\\PY{o}{=}\\PY{n}{units}\\PY{p}{,} \\PY{n}{ref}\\PY{o}{=}\\PY{n}{ref}\\PY{p}{)}\n\n \\PY{k}{def}\\PY{+w}{ }\\PY{n+nf}{setup\\PYZus{}partials}\\PY{p}{(}\\PY{n+nb+bp}{self}\\PY{p}{)}\\PY{p}{:}\n \\PY{c+c1}{\\PYZsh{} Finite difference everything}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{declare\\PYZus{}partials}\\PY{p}{(}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{*}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{,} \\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{*}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{,} \\PY{n}{method}\\PY{o}{=}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{fd}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{)}\n\n \\PY{k}{def}\\PY{+w}{ }\\PY{n+nf}{compute}\\PY{p}{(}\\PY{n+nb+bp}{self}\\PY{p}{,} \\PY{n}{inputs}\\PY{p}{,} \\PY{n}{outputs}\\PY{p}{)}\\PY{p}{:}\n\\PY{+w}{ }\\PY{l+s+sd}{\\PYZdq{}\\PYZdq{}\\PYZdq{}}\n\\PY{l+s+sd}{ Evaluates the equation}\n\\PY{l+s+sd}{ y1 = z1**2 + z2 + x1 \\PYZhy{} 0.2*y2}\n\\PY{l+s+sd}{ \\PYZdq{}\\PYZdq{}\\PYZdq{}}\n\n \\PY{n}{z1} \\PY{o}{=} \\PY{n}{inputs}\\PY{p}{[}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{z}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{]}\\PY{p}{[}\\PY{l+m+mi}{0}\\PY{p}{]}\n \\PY{n}{z2} \\PY{o}{=} \\PY{n}{inputs}\\PY{p}{[}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{z}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{]}\\PY{p}{[}\\PY{l+m+mi}{1}\\PY{p}{]}\n \\PY{n}{x1} \\PY{o}{=} \\PY{n}{inputs}\\PY{p}{[}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{x}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{]}\n \\PY{n}{y2} \\PY{o}{=} \\PY{n}{inputs}\\PY{p}{[}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{y2}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{]}\n\n \\PY{n}{outputs}\\PY{p}{[}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{y1}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{]} \\PY{o}{=} \\PY{n}{z1}\\PY{o}{*}\\PY{o}{*}\\PY{l+m+mi}{2} \\PY{o}{+} \\PY{n}{z2} \\PY{o}{+} \\PY{n}{x1} \\PY{o}{\\PYZhy{}} \\PY{l+m+mf}{0.2}\\PY{o}{*}\\PY{n}{y2}\n\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{execution\\PYZus{}count} \\PY{o}{+}\\PY{o}{=} \\PY{l+m+mi}{1}\n\\end{Verbatim}\n", "application/papermill.record/text/plain": "class SellarDis1(om.ExplicitComponent):\n \"\"\"\n Component containing Discipline 1 -- no derivatives version.\n \"\"\"\n\n def __init__(self, units=None, scaling=None):\n super().__init__()\n self.execution_count = 0\n self._units = units\n self._do_scaling = scaling\n\n def setup(self):\n\n if self._units:\n units = 'ft'\n else:\n units = None\n\n if self._do_scaling:\n ref = .1\n else:\n ref = 1.\n\n # Global Design Variable\n self.add_input('z', val=np.zeros(2), units=units)\n\n # Local Design Variable\n self.add_input('x', val=0., units=units)\n\n # Coupling parameter\n self.add_input('y2', val=1.0, units=units)\n\n # Coupling output\n self.add_output('y1', val=1.0, lower=0.1, upper=1000., units=units, ref=ref)\n\n def setup_partials(self):\n # Finite difference everything\n self.declare_partials('*', '*', method='fd')\n\n def compute(self, inputs, outputs):\n \"\"\"\n Evaluates the equation\n y1 = z1**2 + z2 + x1 - 0.2*y2\n \"\"\"\n\n z1 = inputs['z'][0]\n z2 = inputs['z'][1]\n x1 = inputs['x']\n y2 = inputs['y2']\n\n outputs['y1'] = z1**2 + z2 + x1 - 0.2*y2\n\n self.execution_count += 1" }, "metadata": { "scrapbook": { "mime_prefix": "application/papermill.record/", "name": "code_src1" } }, "output_type": "display_data" } ], "source": [ "from openmdao.utils.notebook_utils import get_code\n", "from myst_nb import glue\n", "glue(\"code_src1\", get_code(\"openmdao.test_suite.components.sellar.SellarDis1\"), display=False)" ] }, { "cell_type": "markdown", "id": "6e0eb3ef", "metadata": { "papermill": { "duration": 0.000932, "end_time": "2026-10-02T14:40:30.743359+00:00", "exception": false, "start_time": "2026-10-02T14:40:30.742427+00:00", "status": "completed" }, "tags": [] }, "source": [ ":::{dropdown} `SellarDis1` class definition \n", "\n", "{glue:}`code_src1`\n", ":::" ] }, { "cell_type": "code", "execution_count": 3, "id": "0c6bfbf7", "metadata": { "execution": { "iopub.execute_input": "2026-10-02T14:40:30.746225Z", "iopub.status.busy": "2026-10-02T14:40:30.746011Z", "iopub.status.idle": "2026-10-02T14:40:30.757068Z", "shell.execute_reply": "2026-10-02T14:40:30.756505Z" }, "papermill": { "duration": 0.013227, "end_time": "2026-10-02T14:40:30.757570+00:00", "exception": false, "start_time": "2026-10-02T14:40:30.744343+00:00", "status": "completed" }, "tags": [ "remove-input", "remove-output" ] }, "outputs": [ { "data": { "application/papermill.record/text/html": "
class SellarDis2(om.ExplicitComponent):\n    """\n    Component containing Discipline 2 -- no derivatives version.\n    """\n\n    def __init__(self, units=None, scaling=None):\n        super().__init__()\n        self.execution_count = 0\n        self._units = units\n        self._do_scaling = scaling\n\n    def setup(self):\n        if self._units:\n            units = 'inch'\n        else:\n            units = None\n\n        if self._do_scaling:\n            ref = .18\n        else:\n            ref = 1.\n\n        # Global Design Variable\n        self.add_input('z', val=np.zeros(2), units=units)\n\n        # Coupling parameter\n        self.add_input('y1', val=1.0, units=units)\n\n        # Coupling output\n        self.add_output('y2', val=1.0, lower=0.1, upper=1000., units=units, ref=ref)\n\n    def setup_partials(self):\n        # Finite difference everything\n        self.declare_partials('*', '*', method='fd')\n\n    def compute(self, inputs, outputs):\n        """\n        Evaluates the equation\n        y2 = y1**(.5) + z1 + z2\n        """\n\n        z1 = inputs['z'][0]\n        z2 = inputs['z'][1]\n        y1 = inputs['y1']\n\n        # Note: this may cause some issues. However, y1 is constrained to be\n        # above 3.16, so lets just let it converge, and the optimizer will\n        # throw it out\n        if y1.real < 0.0:\n            y1 *= -1\n\n        outputs['y2'] = y1**.5 + z1 + z2\n\n        self.execution_count += 1\n
\n", "application/papermill.record/text/latex": "\\begin{Verbatim}[commandchars=\\\\\\{\\}]\n\\PY{k}{class}\\PY{+w}{ }\\PY{n+nc}{SellarDis2}\\PY{p}{(}\\PY{n}{om}\\PY{o}{.}\\PY{n}{ExplicitComponent}\\PY{p}{)}\\PY{p}{:}\n\\PY{+w}{ }\\PY{l+s+sd}{\\PYZdq{}\\PYZdq{}\\PYZdq{}}\n\\PY{l+s+sd}{ Component containing Discipline 2 \\PYZhy{}\\PYZhy{} no derivatives version.}\n\\PY{l+s+sd}{ \\PYZdq{}\\PYZdq{}\\PYZdq{}}\n\n \\PY{k}{def}\\PY{+w}{ }\\PY{n+nf+fm}{\\PYZus{}\\PYZus{}init\\PYZus{}\\PYZus{}}\\PY{p}{(}\\PY{n+nb+bp}{self}\\PY{p}{,} \\PY{n}{units}\\PY{o}{=}\\PY{k+kc}{None}\\PY{p}{,} \\PY{n}{scaling}\\PY{o}{=}\\PY{k+kc}{None}\\PY{p}{)}\\PY{p}{:}\n \\PY{n+nb}{super}\\PY{p}{(}\\PY{p}{)}\\PY{o}{.}\\PY{n+nf+fm}{\\PYZus{}\\PYZus{}init\\PYZus{}\\PYZus{}}\\PY{p}{(}\\PY{p}{)}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{execution\\PYZus{}count} \\PY{o}{=} \\PY{l+m+mi}{0}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{\\PYZus{}units} \\PY{o}{=} \\PY{n}{units}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{\\PYZus{}do\\PYZus{}scaling} \\PY{o}{=} \\PY{n}{scaling}\n\n \\PY{k}{def}\\PY{+w}{ }\\PY{n+nf}{setup}\\PY{p}{(}\\PY{n+nb+bp}{self}\\PY{p}{)}\\PY{p}{:}\n \\PY{k}{if} \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{\\PYZus{}units}\\PY{p}{:}\n \\PY{n}{units} \\PY{o}{=} \\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{inch}\\PY{l+s+s1}{\\PYZsq{}}\n \\PY{k}{else}\\PY{p}{:}\n \\PY{n}{units} \\PY{o}{=} \\PY{k+kc}{None}\n\n \\PY{k}{if} \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{\\PYZus{}do\\PYZus{}scaling}\\PY{p}{:}\n \\PY{n}{ref} \\PY{o}{=} \\PY{l+m+mf}{.18}\n \\PY{k}{else}\\PY{p}{:}\n \\PY{n}{ref} \\PY{o}{=} \\PY{l+m+mf}{1.}\n\n \\PY{c+c1}{\\PYZsh{} Global Design Variable}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{add\\PYZus{}input}\\PY{p}{(}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{z}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{,} \\PY{n}{val}\\PY{o}{=}\\PY{n}{np}\\PY{o}{.}\\PY{n}{zeros}\\PY{p}{(}\\PY{l+m+mi}{2}\\PY{p}{)}\\PY{p}{,} \\PY{n}{units}\\PY{o}{=}\\PY{n}{units}\\PY{p}{)}\n\n \\PY{c+c1}{\\PYZsh{} Coupling parameter}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{add\\PYZus{}input}\\PY{p}{(}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{y1}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{,} \\PY{n}{val}\\PY{o}{=}\\PY{l+m+mf}{1.0}\\PY{p}{,} \\PY{n}{units}\\PY{o}{=}\\PY{n}{units}\\PY{p}{)}\n\n \\PY{c+c1}{\\PYZsh{} Coupling output}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{add\\PYZus{}output}\\PY{p}{(}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{y2}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{,} \\PY{n}{val}\\PY{o}{=}\\PY{l+m+mf}{1.0}\\PY{p}{,} \\PY{n}{lower}\\PY{o}{=}\\PY{l+m+mf}{0.1}\\PY{p}{,} \\PY{n}{upper}\\PY{o}{=}\\PY{l+m+mf}{1000.}\\PY{p}{,} \\PY{n}{units}\\PY{o}{=}\\PY{n}{units}\\PY{p}{,} \\PY{n}{ref}\\PY{o}{=}\\PY{n}{ref}\\PY{p}{)}\n\n \\PY{k}{def}\\PY{+w}{ }\\PY{n+nf}{setup\\PYZus{}partials}\\PY{p}{(}\\PY{n+nb+bp}{self}\\PY{p}{)}\\PY{p}{:}\n \\PY{c+c1}{\\PYZsh{} Finite difference everything}\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{declare\\PYZus{}partials}\\PY{p}{(}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{*}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{,} \\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{*}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{,} \\PY{n}{method}\\PY{o}{=}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{fd}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{)}\n\n \\PY{k}{def}\\PY{+w}{ }\\PY{n+nf}{compute}\\PY{p}{(}\\PY{n+nb+bp}{self}\\PY{p}{,} \\PY{n}{inputs}\\PY{p}{,} \\PY{n}{outputs}\\PY{p}{)}\\PY{p}{:}\n\\PY{+w}{ }\\PY{l+s+sd}{\\PYZdq{}\\PYZdq{}\\PYZdq{}}\n\\PY{l+s+sd}{ Evaluates the equation}\n\\PY{l+s+sd}{ y2 = y1**(.5) + z1 + z2}\n\\PY{l+s+sd}{ \\PYZdq{}\\PYZdq{}\\PYZdq{}}\n\n \\PY{n}{z1} \\PY{o}{=} \\PY{n}{inputs}\\PY{p}{[}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{z}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{]}\\PY{p}{[}\\PY{l+m+mi}{0}\\PY{p}{]}\n \\PY{n}{z2} \\PY{o}{=} \\PY{n}{inputs}\\PY{p}{[}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{z}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{]}\\PY{p}{[}\\PY{l+m+mi}{1}\\PY{p}{]}\n \\PY{n}{y1} \\PY{o}{=} \\PY{n}{inputs}\\PY{p}{[}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{y1}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{]}\n\n \\PY{c+c1}{\\PYZsh{} Note: this may cause some issues. However, y1 is constrained to be}\n \\PY{c+c1}{\\PYZsh{} above 3.16, so lets just let it converge, and the optimizer will}\n \\PY{c+c1}{\\PYZsh{} throw it out}\n \\PY{k}{if} \\PY{n}{y1}\\PY{o}{.}\\PY{n}{real} \\PY{o}{\\PYZlt{}} \\PY{l+m+mf}{0.0}\\PY{p}{:}\n \\PY{n}{y1} \\PY{o}{*}\\PY{o}{=} \\PY{o}{\\PYZhy{}}\\PY{l+m+mi}{1}\n\n \\PY{n}{outputs}\\PY{p}{[}\\PY{l+s+s1}{\\PYZsq{}}\\PY{l+s+s1}{y2}\\PY{l+s+s1}{\\PYZsq{}}\\PY{p}{]} \\PY{o}{=} \\PY{n}{y1}\\PY{o}{*}\\PY{o}{*}\\PY{l+m+mf}{.5} \\PY{o}{+} \\PY{n}{z1} \\PY{o}{+} \\PY{n}{z2}\n\n \\PY{n+nb+bp}{self}\\PY{o}{.}\\PY{n}{execution\\PYZus{}count} \\PY{o}{+}\\PY{o}{=} \\PY{l+m+mi}{1}\n\\end{Verbatim}\n", "application/papermill.record/text/plain": "class SellarDis2(om.ExplicitComponent):\n \"\"\"\n Component containing Discipline 2 -- no derivatives version.\n \"\"\"\n\n def __init__(self, units=None, scaling=None):\n super().__init__()\n self.execution_count = 0\n self._units = units\n self._do_scaling = scaling\n\n def setup(self):\n if self._units:\n units = 'inch'\n else:\n units = None\n\n if self._do_scaling:\n ref = .18\n else:\n ref = 1.\n\n # Global Design Variable\n self.add_input('z', val=np.zeros(2), units=units)\n\n # Coupling parameter\n self.add_input('y1', val=1.0, units=units)\n\n # Coupling output\n self.add_output('y2', val=1.0, lower=0.1, upper=1000., units=units, ref=ref)\n\n def setup_partials(self):\n # Finite difference everything\n self.declare_partials('*', '*', method='fd')\n\n def compute(self, inputs, outputs):\n \"\"\"\n Evaluates the equation\n y2 = y1**(.5) + z1 + z2\n \"\"\"\n\n z1 = inputs['z'][0]\n z2 = inputs['z'][1]\n y1 = inputs['y1']\n\n # Note: this may cause some issues. However, y1 is constrained to be\n # above 3.16, so lets just let it converge, and the optimizer will\n # throw it out\n if y1.real < 0.0:\n y1 *= -1\n\n outputs['y2'] = y1**.5 + z1 + z2\n\n self.execution_count += 1" }, "metadata": { "scrapbook": { "mime_prefix": "application/papermill.record/", "name": "code_src2" } }, "output_type": "display_data" } ], "source": [ "from openmdao.utils.notebook_utils import get_code\n", "from myst_nb import glue\n", "glue(\"code_src2\", get_code(\"openmdao.test_suite.components.sellar.SellarDis2\"), display=False)" ] }, { "cell_type": "markdown", "id": "7dba87a5", "metadata": { "papermill": { "duration": 0.001002, "end_time": "2026-10-02T14:40:30.759729+00:00", "exception": false, "start_time": "2026-10-02T14:40:30.758727+00:00", "status": "completed" }, "tags": [] }, "source": [ ":::{dropdown} `SellarDis2` class definition \n", "\n", "{glue:}`code_src2`\n", ":::" ] }, { "cell_type": "code", "execution_count": 4, "id": "0bd41ad4", "metadata": { "execution": { "iopub.execute_input": "2026-10-02T14:40:30.762597Z", "iopub.status.busy": "2026-10-02T14:40:30.762459Z", "iopub.status.idle": "2026-10-02T14:40:32.024077Z", "shell.execute_reply": "2026-10-02T14:40:32.023293Z" }, "papermill": { "duration": 1.263705, "end_time": "2026-10-02T14:40:32.024512+00:00", "exception": false, "start_time": "2026-10-02T14:40:30.760807+00:00", "status": "completed" }, "tags": [] }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "[1790952031.959586] [runnervm8df0l:5897 :0] ib_iface.c:1269 UCX ERROR mana_0: iface 0x55c4e53b4b50 failed to create UD QP TX wr:256 sge:6 inl:64 resp:0 RX wr:4096 sge:1 resp:0 failed: Operation not supported\n", "[1790952031.959859] [runnervm8df0l:5897 :0] ucp_worker.c:1412 UCX ERROR uct_iface_open(ud_verbs/mana_0:1) failed: Input/output error\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "Optimization terminated successfully (Exit mode 0)\n", " Current function value: 3.1870337508710627\n", " Iterations: 9\n", " Function evaluations: 10\n", " Gradient evaluations: 9\n", "Optimization Complete\n", "-----------------------------------\n", "minimum found at\n", "0.0\n", "[1.83303028e+00 1.06402336e-12]\n", "minumum objective\n", "3.1870337508710627\n" ] }, { "name": "stderr", "output_type": "stream", "text": [ "[runnervm8df0l:05897] pml_ucx.c:313 Error: Failed to create UCP worker\n", "/home/runner/work/OpenMDAO/OpenMDAO/.pixi/envs/dev/lib/python3.13/site-packages/openmdao/core/driver.py:829: DriverWarning:The following design variable initial conditions are out of their specified bounds:\n", " z\n", " val: [-1. -1.]\n", " lower: 0.0\n", " upper: 10.0\n", "Set the initial value of the design variable to a valid value or set the driver option['invalid_desvar_behavior'] to 'ignore'.\n" ] } ], "source": [ "import numpy as np\n", "import openmdao.api as om\n", "\n", "from openmdao.test_suite.components.sellar import SellarDis1, SellarDis2\n", "\n", "\n", "class SellarMDAConnect(om.Group):\n", "\n", " def setup(self):\n", " cycle = self.add_subsystem('cycle', om.Group(), promotes_inputs=['x', 'z'])\n", " cycle.add_subsystem('d1', SellarDis1(), promotes_inputs=['x', 'z'])\n", " cycle.add_subsystem('d2', SellarDis2(), promotes_inputs=['z'])\n", " cycle.connect('d1.y1', 'd2.y1')\n", "\n", " ######################################\n", " # This is a \"forgotten\" connection!!\n", " ######################################\n", " #cycle.connect('d2.y2', 'd1.y2')\n", "\n", " self.set_input_defaults('x', 1.0)\n", " self.set_input_defaults('z', np.array([5.0, 2.0]))\n", "\n", " # Nonlinear Block Gauss Seidel is a gradient free solver\n", " cycle.nonlinear_solver = om.NonlinearBlockGS()\n", "\n", " self.add_subsystem('obj_cmp', om.ExecComp('obj = x**2 + z[1] + y1 + exp(-y2)',\n", " z=np.array([0.0, 0.0]), x=0.0),\n", " promotes_inputs=['x', 'z'])\n", "\n", " self.add_subsystem('con_cmp1', om.ExecComp('con1 = 3.16 - y1'))\n", " self.add_subsystem('con_cmp2', om.ExecComp('con2 = y2 - 24.0'))\n", "\n", " self.connect('cycle.d1.y1', ['obj_cmp.y1', 'con_cmp1.y1'])\n", " self.connect('cycle.d2.y2', ['obj_cmp.y2', 'con_cmp2.y2'])\n", "\n", "\n", "prob = om.Problem()\n", "\n", "prob.model = SellarMDAConnect()\n", "\n", "prob.driver = om.ScipyOptimizeDriver()\n", "prob.driver.options['optimizer'] = 'SLSQP'\n", "# prob.driver.options['maxiter'] = 100\n", "prob.driver.options['tol'] = 1e-8\n", "\n", "prob.set_solver_print(level=0)\n", "\n", "prob.model.add_design_var('x', lower=0, upper=10)\n", "prob.model.add_design_var('z', lower=0, upper=10)\n", "prob.model.add_objective('obj_cmp.obj')\n", "prob.model.add_constraint('con_cmp1.con1', upper=0)\n", "prob.model.add_constraint('con_cmp2.con2', upper=0)\n", "\n", "prob.setup()\n", "\n", "prob.set_val('x', 2.0)\n", "prob.set_val('z', [-1., -1.])\n", "\n", "prob.run_driver()\n", "print('minimum found at')\n", "print(prob.get_val('x')[0])\n", "print(prob.get_val('z'))\n", "print('minumum objective')\n", "print(prob.get_val('obj_cmp.obj')[0])" ] }, { "cell_type": "markdown", "id": "129bc4fa", "metadata": { "papermill": { "duration": 0.04043, "end_time": "2026-10-02T14:40:32.066401+00:00", "exception": false, "start_time": "2026-10-02T14:40:32.025971+00:00", "status": "completed" }, "tags": [ "remove-input" ] }, "source": [ "If you are in colab, the shell command will not find the file because it is a single notebook without the included file." ] }, { "cell_type": "code", "execution_count": 5, "id": "53827be7", "metadata": { "execution": { "iopub.execute_input": "2026-10-02T14:40:32.070905Z", "iopub.status.busy": "2026-10-02T14:40:32.070554Z", "iopub.status.idle": "2026-10-02T14:40:40.686925Z", "shell.execute_reply": "2026-10-02T14:40:40.686113Z" }, "papermill": { "duration": 8.619445, "end_time": "2026-10-02T14:40:40.687646+00:00", "exception": false, "start_time": "2026-10-02T14:40:32.068201+00:00", "status": "completed" }, "tags": [] }, "outputs": [ { "name": "stdout", "output_type": "stream", "text": [ "[1790952039.903263] [runnervm8df0l:5944 :0] ib_iface.c:1269 UCX ERROR mana_0: iface 0x55e16f55f800 failed to create UD QP TX wr:256 sge:6 inl:64 resp:0 RX wr:4096 sge:1 resp:0 failed: Operation not supported\r\n", "[1790952039.903553] [runnervm8df0l:5944 :0] ucp_worker.c:1412 UCX ERROR uct_iface_open(ud_verbs/mana_0:1) failed: Input/output error\r\n", "[runnervm8df0l:05944] pml_ucx.c:313 Error: Failed to create UCP worker\r\n" ] }, { "name": "stdout", "output_type": "stream", "text": [ "INFO: checking all_unserializable_options...\r\n", "INFO: all_unserializable_options check complete (0.000123 sec).\r\n", "INFO: checking comp_has_no_outputs...\r\n", "INFO: comp_has_no_outputs check complete (0.000013 sec).\r\n", "INFO: checking cycles...\r\n", "INFO: cycles check complete (0.000080 sec).\r\n", "INFO: checking dup_inputs...\r\n", "INFO: dup_inputs check complete (0.000021 sec).\r\n", "INFO: checking missing_recorders...\r\n", "WARNING: The Problem has no recorder of any kind attached\r\n", "INFO: missing_recorders check complete (0.000027 sec).\r\n", "INFO: checking out_of_order...\r\n", "INFO: out_of_order check complete (0.000084 sec).\r\n", "INFO: checking promotions...\r\n", "INFO: promotions check complete (0.000027 sec).\r\n", "INFO: checking solvers...\r\n", "INFO: solvers check complete (0.000065 sec).\r\n", "INFO: checking sparsity...\r\n", "INFO: sparsity check complete (0.006040 sec).\r\n", "INFO: checking system...\r\n", "INFO: system check complete (0.000021 sec).\r\n", "INFO: checking unconnected_inputs...\r\n", "WARNING: The following inputs are connected to Auto IVC output variables:\r\n", " cycle.d1.y2 (cycle.d1.y2)\r\n", "\r\n", "INFO: unconnected_inputs check complete (0.000029 sec).\r\n" ] } ], "source": [ "!openmdao check -c all sellar.py" ] }, { "cell_type": "markdown", "id": "bf6fa3ca", "metadata": { "papermill": { "duration": 0.001179, "end_time": "2026-10-02T14:40:40.690309+00:00", "exception": false, "start_time": "2026-10-02T14:40:40.689130+00:00", "status": "completed" }, "tags": [] }, "source": [ "This output tells you several things:\n", "\n", "1. You have an unconnected input: `cycle.d1.y2`\n", "2. There are no reported cycles in your model, but there should be because this is supposed to be a coupled model!\n", "\n", "Whenever you encounter a problem, before you look at anything else you should always run this check first and look over the output carefully." ] } ], "metadata": { "celltoolbar": "Tags", "kernelspec": { "display_name": "Python 3", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.13.14" }, "papermill": { "default_parameters": {}, "duration": 13.605673, "end_time": "2026-10-02T14:40:41.307900+00:00", "environment_variables": {}, "exception": null, "input_path": "/home/runner/work/OpenMDAO/OpenMDAO/openmdao/docs/openmdao_book/basic_user_guide/command_line/check_setup.ipynb", "output_path": "/home/runner/work/OpenMDAO/OpenMDAO/openmdao/docs/_executed_book/basic_user_guide/command_line/check_setup.ipynb", "parameters": {}, "start_time": "2026-10-02T14:40:27.702227+00:00", "version": "2.7.0" } }, "nbformat": 4, "nbformat_minor": 5 }