|
| 1 | +# |
| 2 | +# Newman Tobias Model |
| 3 | +# |
| 4 | +import pybamm |
| 5 | +from .dfn import DFN |
| 6 | + |
| 7 | + |
| 8 | +class NewmanTobias(DFN): |
| 9 | + """ |
| 10 | + Newman-Tobias model of a lithium-ion battery based on the formulation in [1]_. |
| 11 | + This model assumes a uniform concentration profile in the electrolyte. |
| 12 | + Unlike the model posed in [1]_, this model accounts for nonlinear Butler-Volmer |
| 13 | + kinetics. It also tracks the average concentration in the solid phase in each |
| 14 | + electrode, which is equivalent to including an equation for the local state of |
| 15 | + charge as in [2]_. The user can pass the "particle" option to include mass |
| 16 | + transport in the particles. |
| 17 | +
|
| 18 | + Parameters |
| 19 | + ---------- |
| 20 | + options : dict, optional |
| 21 | + A dictionary of options to be passed to the model. |
| 22 | + name : str, optional |
| 23 | + The name of the model. |
| 24 | + build : bool, optional |
| 25 | + Whether to build the model on instantiation. Default is True. Setting this |
| 26 | + option to False allows users to change any number of the submodels before |
| 27 | + building the complete model (submodels cannot be changed after the model is |
| 28 | + built). |
| 29 | +
|
| 30 | + References |
| 31 | + ---------- |
| 32 | + .. [1] JS Newman and CW Tobias. "Theoretical Analysis of Current Distribution |
| 33 | + in Porous Electrodes". Journal of The Electrochemical Society, |
| 34 | + 109(12):A1183-A1191, 1962 |
| 35 | + .. [2] HN Chu, SU Kim, SK Rahimian, JB Siegel and CW Monroe. "Parameterization |
| 36 | + of prismatic lithium–iron–phosphate cells through a streamlined |
| 37 | + thermal/electrochemical model". Journal of Power Sources, 453, p.227787, |
| 38 | + 2020 |
| 39 | +
|
| 40 | +
|
| 41 | + **Extends:** :class:`pybamm.lithium_ion.DFN` |
| 42 | + """ |
| 43 | + |
| 44 | + def __init__(self, options=None, name="Newman-Tobias model", build=True): |
| 45 | + |
| 46 | + # Set default option "uniform profile" for particle submodel. Other |
| 47 | + # default options are those given in `pybamm.Options` defined in |
| 48 | + # `base_battery_model.py`. |
| 49 | + options = options or {} |
| 50 | + if "particle" not in options: |
| 51 | + options["particle"] = "uniform profile" |
| 52 | + |
| 53 | + super().__init__(options, name, build) |
| 54 | + |
| 55 | + pybamm.citations.register("Newman1962") |
| 56 | + pybamm.citations.register("Chu2020") |
| 57 | + |
| 58 | + def set_particle_submodel(self): |
| 59 | + |
| 60 | + if self.options["particle"] == "Fickian diffusion": |
| 61 | + self.submodels["negative particle"] = pybamm.particle.FickianSingleParticle( |
| 62 | + self.param, "Negative" |
| 63 | + ) |
| 64 | + self.submodels["positive particle"] = pybamm.particle.FickianSingleParticle( |
| 65 | + self.param, "Positive" |
| 66 | + ) |
| 67 | + elif self.options["particle"] in [ |
| 68 | + "uniform profile", |
| 69 | + "quadratic profile", |
| 70 | + "quartic profile", |
| 71 | + ]: |
| 72 | + self.submodels[ |
| 73 | + "negative particle" |
| 74 | + ] = pybamm.particle.PolynomialSingleParticle( |
| 75 | + self.param, "Negative", self.options["particle"] |
| 76 | + ) |
| 77 | + self.submodels[ |
| 78 | + "positive particle" |
| 79 | + ] = pybamm.particle.PolynomialSingleParticle( |
| 80 | + self.param, "Positive", self.options["particle"] |
| 81 | + ) |
| 82 | + |
| 83 | + def set_electrolyte_submodel(self): |
| 84 | + |
| 85 | + surf_form = pybamm.electrolyte_conductivity.surface_potential_form |
| 86 | + |
| 87 | + self.submodels[ |
| 88 | + "electrolyte diffusion" |
| 89 | + ] = pybamm.electrolyte_diffusion.ConstantConcentration(self.param) |
| 90 | + |
| 91 | + if self.options["electrolyte conductivity"] not in ["default", "full"]: |
| 92 | + raise pybamm.OptionError( |
| 93 | + "electrolyte conductivity '{}' not suitable for Newman-Tobias".format( |
| 94 | + self.options["electrolyte conductivity"] |
| 95 | + ) |
| 96 | + ) |
| 97 | + |
| 98 | + if self.options["surface form"] == "false": |
| 99 | + self.submodels[ |
| 100 | + "electrolyte conductivity" |
| 101 | + ] = pybamm.electrolyte_conductivity.Full(self.param) |
| 102 | + elif self.options["surface form"] == "differential": |
| 103 | + for domain in ["Negative", "Separator", "Positive"]: |
| 104 | + self.submodels[ |
| 105 | + domain.lower() + " electrolyte conductivity" |
| 106 | + ] = surf_form.FullDifferential(self.param, domain) |
| 107 | + elif self.options["surface form"] == "algebraic": |
| 108 | + for domain in ["Negative", "Separator", "Positive"]: |
| 109 | + self.submodels[ |
| 110 | + domain.lower() + " electrolyte conductivity" |
| 111 | + ] = surf_form.FullAlgebraic(self.param, domain) |
0 commit comments