Issue 658 experiment

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 ## Features
 
+-   Added functionality to solve DAE models with non-smooth current inputs ([#808](https://github.com/pybamm-team/PyBaMM/pull/808))
+-   Added functionality to simulate experiments and testing protocols ([#807](https://github.com/pybamm-team/PyBaMM/pull/807))
 -   Added fuzzy string matching for parameters and variables ([#796](https://github.com/pybamm-team/PyBaMM/pull/796))
 -   Changed ParameterValues to raise an error when a parameter that wasn't previously defined is updated ([#796](https://github.com/pybamm-team/PyBaMM/pull/796))
 -   Added some basic models (BasicSPM and BasicDFN) in order to clearly demonstrate the PyBaMM model structure for battery models ([#795](https://github.com/pybamm-team/PyBaMM/pull/795))
@@ -63,6 +65,7 @@
 
 ## Breaking changes
 
+-   Removed `ParameterValues.update_model`, whose functionality is now replaced by `InputParameter` ([#801](https://github.com/pybamm-team/PyBaMM/pull/801))
 -   Removed `Outer` and `Kron` nodes as no longer used ([#777](https://github.com/pybamm-team/PyBaMM/pull/777))
 -   Moved `results` to separate repositories ([#761](https://github.com/pybamm-team/PyBaMM/pull/761))
 -   The parameters "Bruggeman coefficient" must now be specified separately as "Bruggeman coefficient (electrolyte)" and "Bruggeman coefficient (electrode)"

docs/index.rst

@@ -30,6 +30,7 @@ Contents
     source/meshes/index
     source/spatial_methods/index
     source/solvers/index
+    source/experiments/index
     source/processed_variable
     source/util
     source/simulation

docs/source/experiments/experiment.rst

@@ -0,0 +1,5 @@
+Base Experiment Class
+=====================
+
+.. autoclass:: pybamm.Experiment
+  :members:

docs/source/experiments/index.rst

@@ -0,0 +1,8 @@
+Experiments
+===========
+
+Classes to help set operating conditions for some standard battery modelling experiments
+
+.. toctree::
+
+  experiment

docs/source/solvers/solution.rst

@@ -1,5 +1,8 @@
 Solution
 ========
 
+.. autoclass:: pybamm._BaseSolution
+  :members:
+
 .. autoclass:: pybamm.Solution
   :members:

examples/scripts/DFN.py

@@ -7,15 +7,15 @@
 
 pybamm.set_logging_level("INFO")
 
+
 # load model
-model = pybamm.lithium_ion.DFN({"operating mode": "voltage"})
+model = pybamm.lithium_ion.DFN()
 
 # create geometry
 geometry = model.default_geometry
 
 # load parameter values and process model and geometry
 param = model.default_parameter_values
-param.update({"Voltage function [V]": 4.1}, check_already_exists=False)
 param.process_model(model)
 param.process_geometry(geometry)
 

examples/scripts/experimental_protocols/cccv.py

@@ -0,0 +1,39 @@
+#
+# Constant-current constant-voltage charge
+#
+import pybamm
+import matplotlib.pyplot as plt
+
+pybamm.set_logging_level("INFO")
+experiment = pybamm.Experiment(
+    [
+        "Discharge at C/10 for 13 hours or until 3.3 V",
+        "Rest for 1 hour",
+        "Charge at 1 A until 4.1 V",
+        "Hold at 4.1 V until 50 mA",
+        "Rest for 1 hour",
+    ]
+    * 3,
+    period="2 minutes",
+)
+model = pybamm.lithium_ion.DFN()
+sim = pybamm.Simulation(model, experiment=experiment, solver=pybamm.CasadiSolver())
+sim.solve()
+
+# Plot voltages from the discharge segments only
+fig, ax = plt.subplots()
+for i in range(3):
+    # Extract sub solutions
+    sol = sim.solution.sub_solutions[i * 5]
+    # Extract variables
+    t = sol["Time [h]"].entries
+    V = sol["Terminal voltage [V]"].entries
+    # Plot
+    ax.plot(t - t[0], V, label="Discharge {}".format(i + 1))
+    ax.set_xlabel("Time [h]")
+    ax.set_ylabel("Voltage [V]")
+    ax.set_xlim([0, 13])
+ax.legend()
+
+# Show all plots
+sim.plot()

examples/scripts/experimental_protocols/cccv_lead_acid.py

@@ -0,0 +1,19 @@
+#
+# Constant-current constant-voltage charge
+#
+import pybamm
+
+pybamm.set_logging_level("INFO")
+experiment = pybamm.Experiment(
+    [
+        "Discharge at C/2 until 11 V",
+        "Rest for 1 hour",
+        "Charge at C/2 until 14.5 V",
+        "Hold at 14.5 V until 200 mA",
+        "Rest for 1 hour",
+    ]
+)
+model = pybamm.lead_acid.Full()
+sim = pybamm.Simulation(model, experiment=experiment, solver=pybamm.CasadiSolver())
+sim.solve()
+sim.plot()

examples/scripts/experimental_protocols/gitt.py

@@ -0,0 +1,13 @@
+#
+# GITT discharge
+#
+import pybamm
+
+pybamm.set_logging_level("INFO")
+experiment = pybamm.Experiment(
+    ["Discharge at C/20 for 1 hour", "Rest for 1 hour"] * 20,
+)
+model = pybamm.lithium_ion.DFN()
+sim = pybamm.Simulation(model, experiment=experiment, solver=pybamm.CasadiSolver())
+sim.solve()
+sim.plot()

pybamm/__init__.py

@@ -237,7 +237,7 @@ def version(formatted=False):
 #
 # Solver classes
 #
-from .solvers.solution import Solution
+from .solvers.solution import Solution, _BaseSolution
 from .solvers.base_solver import BaseSolver
 from .solvers.algebraic_solver import AlgebraicSolver
 from .solvers.casadi_solver import CasadiSolver
@@ -246,6 +246,12 @@ def version(formatted=False):
 from .solvers.scipy_solver import ScipySolver
 from .solvers.idaklu_solver import IDAKLUSolver, have_idaklu
 
+#
+# Experiments
+#
+from .experiments.experiment import Experiment
+from . import experiments
+
 #
 # other
 #