Partially reversible lithium plating

[DrSOKane]

Description

The partially reversible lithium plating model proposed by O'Kane et al. (2022) is added to PyBaMM.

Fixes # 1807

Type of change

Please add a line in the relevant section of CHANGELOG.md to document the change (include PR #) - note reverse order of PR #s. If necessary, also add to the list of breaking changes.

• [Y] New feature (non-breaking change which adds functionality)
• Optimization (back-end change that speeds up the code)
• Bug fix (non-breaking change which fixes an issue)

Key checklist:

• [Y] No style issues: $ flake8
• [N] All tests pass: $ python run-tests.py --unit
  test_symbol/test_visualize fails
• [Y] The documentation builds: $ cd docs and then $ make clean; make html

You can run all three at once, using $ python run-tests.py --quick.

Further checks:

• [Y] Code is commented, particularly in hard-to-understand areas
• [Y] Tests added that prove fix is effective or that feature works

[valentinsulzer]

See comments. Also, please add tests for partially reversible plating

[codecov]

Codecov Report

Merging #2043 (ad9e600) into develop (9d3b1c3) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff            @@
##           develop    #2043   +/-   ##
========================================
  Coverage    99.38%   99.38%           
========================================
  Files          348      352    +4     
  Lines        19234    19289   +55     
========================================
+ Hits         19115    19170   +55     
  Misses         119      119           

Impacted Files	Coverage Δ
...s/graphite_Chen2020/graphite_LGM50_ocp_Chen2020.py	100.00% <ø> (ø)
...graphite_ORegan2021/graphite_LGM50_ocp_Chen2020.py	100.00% <ø> (ø)
...s/LiNiCoO2_Ecker2015/nco_ocp_Ecker2015_function.py	100.00% <ø> (ø)
...2_Li_plating/SEI_limited_dead_lithium_OKane2022.py	100.00% <100.00%> (ø)
...ting/plating_exchange_current_density_OKane2020.py	100.00% <100.00%> (ø)
...ng/stripping_exchange_current_density_OKane2020.py	100.00% <100.00%> (ø)
...te_Chen2020_plating/graphite_LGM50_ocp_Chen2020.py	100.00% <100.00%> (ø)
..._electrolyte_exchange_current_density_Ecker2015.py	100.00% <100.00%> (ø)
..._electrolyte_exchange_current_density_Ecker2015.py	100.00% <100.00%> (ø)
...m/models/full_battery_models/base_battery_model.py	99.76% <100.00%> (+<0.01%)	⬆️
... and 6 more

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 9d3b1c3...ad9e600. Read the comment docs.

[DrSOKane]

For some reason, merging UpdateParameters into this branch fixed the error stopping that from being merged into develop, so that pull request is now closed and the same changes proposed as part of this one.

[valentinsulzer]

This looks great now, thanks @DrSOKane !

[valentinsulzer]

Forgot to ask for a new line in CHANGELOG, can you do that?

[DrSOKane]

I have pushed the new line to my fork, but not sure if that will be pulled in or if I have to make a new request

…

________________________________ From: Valentin Sulzer ***@***.***> Sent: 16 June 2022 16:55 To: pybamm-team/PyBaMM ***@***.***> Cc: O'Kane, Simon ***@***.***>; Mention ***@***.***> Subject: Re: [pybamm-team/PyBaMM] Partially reversible lithium plating (PR #2043) This email from ***@***.*** originates from outside Imperial. Do not click on links and attachments unless you recognise the sender. If you trust the sender, add them to your safe senders list<https://spam.ic.ac.uk/SpamConsole/Senders.aspx> to disable email stamping for this address. Forgot to ask for a new line in CHANGELOG, can you do that? — Reply to this email directly, view it on GitHub<#2043 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AKH3KYIWNCXH6ST2CHQ4NSTVPNE7PANCNFSM5USFA77A>. You are receiving this because you were mentioned.Message ID: ***@***.***>