Remove yang

CHANGELOG.md

@@ -39,6 +39,7 @@
 
 ## Breaking changes
 
+-   The `Yang2017` parameter set has been removed as the complete parameter set is not publicly available in the literature ([#1577](https://github.com/pybamm-team/PyBaMM/pull/1577))
 -   Changed how options are specified for the "loss of active material" and "particle cracking" submodels. "loss of active material" can now be one of "none", "stress-driven", or "reaction-driven", or a 2-tuple for different options in negative and positive electrode. Similarly "particle cracking" (now called "particle mechanics") can now be "none", "swelling only", "swelling and cracking", or a 2-tuple ([#1490](https://github.com/pybamm-team/PyBaMM/pull/1490))
 -   Changed the variable in the full diffusion model from "Electrolyte concentration" to "Porosity times concentration" ([#1476](https://github.com/pybamm-team/PyBaMM/pull/1476))
 -   Renamed `lithium-ion` folder to `lithium_ion` and `lead-acid` folder to `lead_acid` in parameters ([#1464](https://github.com/pybamm-team/PyBaMM/pull/1464))

examples/scripts/cycling_ageing_yang.py → examples/scripts/cycling_ageing.py

@@ -1,10 +1,17 @@
 import pybamm as pb
 
-# Note: the Yang model is still in active development and results do not
-# match with those reported in the paper
-
 pb.set_logging_level("NOTICE")
-model = pb.lithium_ion.Yang2017()
+model = pb.lithium_ion.DFN(
+    {
+        "SEI": "ec reaction limited",
+        "SEI film resistance": "distributed",
+        "SEI porosity change": "true",
+        "lithium plating": "irreversible",
+        "lithium plating porosity change": "true",
+    }
+)
+
+param = pb.ParameterValues(chemistry=pb.parameter_sets.Mohtat2020)
 
 experiment = pb.Experiment(
     [
@@ -44,8 +51,9 @@
         ),
     ]
 )
-sim = pb.Simulation(model, experiment=experiment)
-sim.solve(solver=pb.CasadiSolver(mode="fast with events"))
+
+sim = pb.Simulation(model, experiment=experiment, parameter_values=param)
+sim.solve(solver=pb.CasadiSolver(mode="safe"))
 sim.plot(
     [
         "Current [A]",

examples/scripts/print_parameters.py

@@ -4,6 +4,6 @@
 import pybamm
 
 parameters = pybamm.LithiumIonParameters()
-parameter_values = pybamm.ParameterValues(chemistry=pybamm.parameter_sets.Yang2017)
+parameter_values = pybamm.ParameterValues(chemistry=pybamm.parameter_sets.Marquis2019)
 output_file = "lithium_ion_parameters.txt"
 parameter_values.print_parameters(parameters, output_file)

pybamm/input/parameters/lithium_ion/lithium_platings/yang2017_Li_plating/README.md

@@ -1,11 +1,5 @@
 # SEI parameters
 
-Some example parameters for SEI growth from the papers:
+Parameters for lithium plating from the paper:
 
-> Ramadass, P., Haran, B., Gomadam, P. M., White, R., & Popov, B. N. (2004). Development of first principles capacity fade model for Li-ion cells. Journal of the Electrochemical Society, 151(2), A196-A203.
-> Ploehn, H. J., Ramadass, P., & White, R. E. (2004). Solvent diffusion model for aging of lithium-ion battery cells. Journal of The Electrochemical Society, 151(3), A456-A462.
-> Single, F., Latz, A., & Horstmann, B. (2018). Identifying the mechanism of continued growth of the solid–electrolyte interphase. ChemSusChem, 11(12), 1950-1955.
-> Safari, M., Morcrette, M., Teyssot, A., & Delacour, C. (2009). Multimodal Physics-Based Aging Model for Life Prediction of Li-Ion Batteries. Journal of The Electrochemical Society, 156(3), 
 > Yang, X., Leng, Y., Zhang, G., Ge, S., Wang, C. (2017). Modeling of lithium plating induced aging of lithium-ion batteries: Transition from linear to nonlinear aging. Journal of Power Sources, 360, 28-40.
-
-Note: this parameter set does not claim to be representative of the true parameter values. Instead these are parameter values that were used to fit SEI models to observed experimental data in the referenced papers.