pybamm-team · valentinsulzer · Jan 15, 2020 · Dec 13, 2019 · Dec 13, 2019 · Dec 13, 2019
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,7 @@
 ## Features
 
 -   Added the harmonic mean to the Finite Volume method, which is now used when computing fluxes ([#783](https://github.com/pybamm-team/PyBaMM/pull/783))
+-   Refactored `Solution` to make it a dictionary that contains all of the solution variables. This automatically creates `ProcessedVariable` objects when required, so that the solution can be obtained much more easily. ([#781](https://github.com/pybamm-team/PyBaMM/pull/781))
 -   Added notebook to explain broadcasts ([#776](https://github.com/pybamm-team/PyBaMM/pull/776))
 -   Added a step to discretisation that automatically compute the inverse of the mass matrix of the differential part of the problem so that the underlying DAEs can be provided in semi-explicit form, as required by the CasADi solver ([#769](https://github.com/pybamm-team/PyBaMM/pull/769))
 -   Added the gradient operation for the Finite Element Method ([#767](https://github.com/pybamm-team/PyBaMM/pull/767))

diff --git a/docs/source/processed_variable.rst b/docs/source/processed_variable.rst
@@ -1,7 +1,5 @@
 Post-Process Variables
 ======================
 
-.. autofunction:: pybamm.post_process_variables
-
 .. autoclass:: pybamm.ProcessedVariable
   :members:
diff --git a/examples/notebooks/change-input-current.ipynb b/examples/notebooks/change-input-current.ipynb
@@ -97,7 +97,7 @@
     "solution = solver.solve(model, t_eval)\n",
     "\n",
     "# plot\n",
-    "quick_plot = pybamm.QuickPlot(model, mesh, solution)\n",
+    "quick_plot = pybamm.QuickPlot(solution)\n",
     "\n",
     "import ipywidgets as widgets\n",
     "widgets.interact(quick_plot.plot, t=widgets.FloatSlider(min=0,max=solution.t[-1],step=0.005,value=0));"
@@ -107,7 +107,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "The one case where we would change \"Current function\" instead of \"Typical current [A]\" is for a simulation at zero-current, since \"Typical current [A]\" cannot be zero (as it is used for non-dimensionalisation). In this case, the current function should be set to zero instead:"
+    "PyBaMM can also simulate rest behaviour by setting the current function to zero:"
    ]
   },
   {
@@ -154,7 +154,7 @@
     "solution = solver.solve(model, t_eval)\n",
     "\n",
     "# plot\n",
-    "quick_plot = pybamm.QuickPlot(model, mesh, solution)\n",
+    "quick_plot = pybamm.QuickPlot(solution)\n",
     "\n",
     "import ipywidgets as widgets\n",
     "widgets.interact(quick_plot.plot, t=widgets.FloatSlider(min=0,max=solution.t[-1],step=0.005,value=0));"
@@ -216,7 +216,7 @@
     "solution = solver.solve(model, t_eval)\n",
     "\n",
     "# plot\n",
-    "quick_plot = pybamm.QuickPlot(model, mesh, solution)\n",
+    "quick_plot = pybamm.QuickPlot(solution)\n",
     "\n",
     "import ipywidgets as widgets\n",
     "widgets.interact(quick_plot.plot, t=widgets.FloatSlider(min=0,max=solution.t[-1],step=0.001,value=0));"
@@ -331,7 +331,7 @@
     "\n",
     "# plot current and voltage\n",
     "output_variables = [\"Current [A]\", \"Terminal voltage [V]\"]\n",
-    "quick_plot = pybamm.QuickPlot(model, mesh, solution, output_variables, label)\n",
+    "quick_plot = pybamm.QuickPlot(solution, output_variables, label)\n",
     "\n",
     "import ipywidgets as widgets\n",
     "widgets.interact(quick_plot.plot, t=widgets.FloatSlider(min=0,max=solution.t[-1],step=solution.t[-1]/20,value=0));"
@@ -366,4 +366,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}
diff --git a/examples/notebooks/change-settings.ipynb b/examples/notebooks/change-settings.ipynb
diff --git a/examples/notebooks/compare-comsol-discharge-curve.ipynb b/examples/notebooks/compare-comsol-discharge-curve.ipynb
diff --git a/examples/notebooks/create-model.ipynb b/examples/notebooks/create-model.ipynb
@@ -576,12 +576,8 @@
     "solution = solver.solve(model, t)\n",
     "\n",
     "# Extract output variables\n",
-    "L_out = pybamm.ProcessedVariable(\n",
-    "    model.variables[\"SEI thickness\"], solution.t, solution.y, mesh\n",
-    ")\n",
-    "c_out = pybamm.ProcessedVariable(\n",
-    "    model.variables[\"Solvent concentration\"], solution.t, solution.y, mesh\n",
-    ")\n",
+    "L_out = solution[\"SEI thickness\"]\n",
+    "c_out = solution[\"Solvent concentration\"]\n",
     "x = np.linspace(0, 1, 100)"
    ]
   },
@@ -600,7 +596,7 @@
     {
      "data": {
       "application/vnd.jupyter.widget-view+json": {
-       "model_id": "521ab96b2c074ac0a709cb3ae87b051e",
+       "model_id": "0f7f4e8850354ea3a745351e85077a75",
        "version_major": 2,
        "version_minor": 0
       },

diff --git a/examples/notebooks/models/DFN.ipynb b/examples/notebooks/models/DFN.ipynb
@@ -219,7 +219,7 @@
     }
    ],
    "source": [
-    "quick_plot = pybamm.QuickPlot(model, mesh, solution)\n",
+    "quick_plot = pybamm.QuickPlot(solution)\n",
     "\n",
     "import ipywidgets as widgets\n",
     "widgets.interact(quick_plot.plot, t=widgets.FloatSlider(min=0,max=solution.t[-1],step=0.05,value=0));"

diff --git a/examples/notebooks/models/SPM.ipynb b/examples/notebooks/models/SPM.ipynb
diff --git a/examples/notebooks/models/SPMe.ipynb b/examples/notebooks/models/SPMe.ipynb
@@ -217,7 +217,7 @@
     }
    ],
    "source": [
-    "quick_plot = pybamm.QuickPlot(model, mesh, solution)\n",
+    "quick_plot = pybamm.QuickPlot(solution)\n",
     "\n",
     "import ipywidgets as widgets\n",
     "widgets.interact(quick_plot.plot, t=widgets.FloatSlider(min=0,max=solution.t[-1],step=0.05,value=0));"
@@ -273,7 +273,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.6.8"
+   "version": "3.7.3"
   }
  },
  "nbformat": 4,

diff --git a/examples/notebooks/models/compare-lithium-ion.ipynb b/examples/notebooks/models/compare-lithium-ion.ipynb
diff --git a/examples/notebooks/models/lead-acid.ipynb b/examples/notebooks/models/lead-acid.ipynb
diff --git a/examples/notebooks/models/spm1.png b/examples/notebooks/models/spm1.png
diff --git a/examples/notebooks/models/spm2.png b/examples/notebooks/models/spm2.png
diff --git a/examples/notebooks/parameter-values.ipynb b/examples/notebooks/parameter-values.ipynb
diff --git a/examples/notebooks/solution-data-and-processed-variables.ipynb b/examples/notebooks/solution-data-and-processed-variables.ipynb
diff --git a/examples/notebooks/solvers/scikits-dae-solver.ipynb b/examples/notebooks/solvers/scikits-dae-solver.ipynb
diff --git a/examples/notebooks/solvers/scikits-ode-solver.ipynb b/examples/notebooks/solvers/scikits-ode-solver.ipynb
diff --git a/examples/notebooks/unsteady_heat_equation.ipynb b/examples/notebooks/unsteady_heat_equation.ipynb
@@ -267,7 +267,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "After solving, we can process variables using the class `pybamm.ProcessedVariable`. This returns a callable object which can be evaluated at any time and position by means of interpolating the solution. Processed variables provide a convinient way of comparing the solution to solutions from different models, or to exact solutions. Since all of the variables are names with informative strings, the user doesn't need to keep track of where they are stored in the state vector `solution.y`. This is particularly useful in complex models with lots of variables. Here we create `T_out` which is the processed temperature. In order to do so, we pass the variable, solution times, solution states, and the mesh to `pybamm.ProcessedVariable`."
+    "After solving, we can process variables using the class `pybamm.ProcessedVariable`. This returns a callable object which can be evaluated at any time and position by means of interpolating the solution. Processed variables provide a convinient way of comparing the solution to solutions from different models, or to exact solutions. Since all of the variables are names with informative strings, the user doesn't need to keep track of where they are stored in the state vector `solution.y`. This is particularly useful in complex models with lots of variables, and is automatically handled by the solution dictionary."
    ]
   },
   {
@@ -276,7 +276,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "T_out = pybamm.ProcessedVariable(model.variables[\"Temperature\"], solution.t, solution.y, mesh)"
+    "T_out = solution[\"Temperature\"]"
    ]
   },
   {

diff --git a/examples/notebooks/using-model-options_thermal-example.ipynb b/examples/notebooks/using-model-options_thermal-example.ipynb
@@ -159,7 +159,7 @@
     "    \"X-averaged cell temperature [K]\",\n",
     "    \"Cell temperature [K]\",\n",
     "]\n",
-    "quick_plot = pybamm.QuickPlot(model, mesh, solution, output_variables)\n",
+    "quick_plot = pybamm.QuickPlot(solution, output_variables)\n",
     "\n",
     "import ipywidgets as widgets\n",
     "widgets.interact(quick_plot.plot, t=widgets.FloatSlider(min=0,max=1,step=0.05,value=0));"
@@ -209,4 +209,4 @@
  },
  "nbformat": 4,
  "nbformat_minor": 2
-}
+}