Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue 2111 custom transport efficiency #3437

Merged
merged 58 commits into from
May 13, 2024
Merged
Show file tree
Hide file tree
Changes from 56 commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
4a7e409
Merge pull request #2739 from pybamm-team/develop
brosaplanella Feb 28, 2023
10aba28
Merge branch 'main' of https://github.com/pybamm-team/PyBaMM into dev…
juliawind Mar 29, 2023
e12ef05
Merge branch 'develop' of https://github.com/juliawind/PyBaMMj into d…
juliawind Mar 29, 2023
d627b1a
log transport efficiency
amirDahari1 Mar 29, 2023
41b6584
logsqrt_transport
tommaull Mar 29, 2023
3663de4
Merge pull request #1 from tldr-group/log-efficiency
amirDahari1 Mar 29, 2023
442a2ea
adding linear transport efficiency
juliawind Mar 29, 2023
e57e221
Merge branch 'transport-efficiency-models' into tortuosity
juliawind Mar 29, 2023
a94f738
half_transport_effciency added
Ruimin-S Mar 29, 2023
3372e80
Merge pull request #3 from juliawind/tortuosity
isaacsquires Mar 29, 2023
54179af
Merge branch 'transport-efficiency-models' into half_transport
Ruimin-S Mar 29, 2023
f5f5eb7
Merge pull request #5 from tldr-group/half_transport
Ruimin-S Mar 29, 2023
b188ce0
Merge pull request #6 from tommaull/https--github.com/tldr-group/PyBa…
isaacsquires Mar 29, 2023
ca33083
add tortuosity factor submodel
isaacsquires Mar 29, 2023
1bf3b48
add multiple tortuosity models
isaacsquires Mar 29, 2023
f513627
add tortuosity factor to model examples
isaacsquires Mar 29, 2023
19ac474
Merge branch 'transport-efficiency-models' of https://github.com/tldr…
TomTranter Oct 11, 2023
14c0ced
Update submodel options and add citations. Also change the solid phas…
TomTranter Oct 11, 2023
ad757e4
Update notebook and index for docs, get rid of unnecessary Bruggeman …
TomTranter Oct 11, 2023
21670f5
Update docs
TomTranter Oct 11, 2023
34d3068
Forgot the new file
TomTranter Oct 11, 2023
488d6e4
Update title underline and add well_posed tests
TomTranter Oct 11, 2023
8d22bed
Merge branch 'develop' of https://github.com/pybamm-team/PyBaMM into …
TomTranter Oct 11, 2023
3039450
style: pre-commit fixes
pre-commit-ci[bot] Oct 11, 2023
197b700
Add some missing tests
TomTranter Oct 12, 2023
b05a4be
Merge branch 'issue-2111-custom-transport-efficiency' of https://gith…
TomTranter Oct 12, 2023
c79113e
Update the transport efficieny print_name and add a bit more to notebook
TomTranter Oct 12, 2023
ee27daf
Split the models into separate classes
TomTranter Oct 15, 2023
e96ff9a
style: pre-commit fixes
pre-commit-ci[bot] Oct 15, 2023
dcc55f3
Merge branch 'develop' of https://github.com/pybamm-team/PyBaMM into …
TomTranter Nov 13, 2023
28e96dd
Update docs and add citations
TomTranter Nov 13, 2023
a68445a
style: pre-commit fixes
pre-commit-ci[bot] Nov 13, 2023
66b05f5
Change docs to footcite
TomTranter Nov 15, 2023
e15fbc7
style: pre-commit fixes
pre-commit-ci[bot] Nov 15, 2023
9974367
Update pybamm/models/submodels/transport_efficiency/tortuosity_factor.py
TomTranter Nov 15, 2023
4134909
Merge branch 'develop' into issue-2111-custom-transport-efficiency
TomTranter Jan 20, 2024
5b66b88
style: pre-commit fixes
pre-commit-ci[bot] Jan 20, 2024
cf9e796
Remove image from notebook
TomTranter Jan 20, 2024
e7adb41
Merge branch 'issue-2111-custom-transport-efficiency' of https://gith…
TomTranter Jan 20, 2024
fa88985
remove .virtual_documents
TomTranter Jan 20, 2024
46cc6c8
Update syntax for style
TomTranter Jan 20, 2024
cefec68
style: pre-commit fixes
pre-commit-ci[bot] Jan 20, 2024
b586a50
Update index.rst
TomTranter Jan 20, 2024
3ff48fa
Adjust reference to Shen and Chen
TomTranter Jan 20, 2024
7f4c703
Merge branch 'develop' into issue-2111-custom-transport-efficiency
brosaplanella Jan 22, 2024
eca0c9b
Merge branch 'develop' into issue-2111-custom-transport-efficiency
TomTranter Apr 29, 2024
c3173c2
style: pre-commit fixes
pre-commit-ci[bot] Apr 29, 2024
506cf5c
Add footbibliography to rst files
TomTranter Apr 29, 2024
e4ab9c3
style: pre-commit fixes
pre-commit-ci[bot] Apr 29, 2024
f44e3f9
Merge branch 'develop' into issue-2111-custom-transport-efficiency
valentinsulzer May 2, 2024
bc2055d
Merge branch 'develop' into issue-2111-custom-transport-efficiency
brosaplanella May 3, 2024
8be88e9
Update CHANGELOG.md
TomTranter May 3, 2024
33149af
Merge branch 'develop' into issue-2111-custom-transport-efficiency
brosaplanella May 3, 2024
bb587c0
Update CHANGELOG.md
TomTranter May 4, 2024
ddcbf3d
Merge branch 'develop' into issue-2111-custom-transport-efficiency
valentinsulzer May 9, 2024
b6a1065
Merge branch 'develop' into issue-2111-custom-transport-efficiency
agriyakhetarpal May 10, 2024
f3e710c
Merge branch 'develop' into issue-2111-custom-transport-efficiency
TomTranter May 11, 2024
156a5f5
Update CITATIONS.bib
TomTranter May 13, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

## Features

- Transport efficiency submodel has new options from the literature relating to different tortuosity factor models and also a new option called "tortuosity factor" for specifying the value or function directly as parameters ([#3437](https://github.com/pybamm-team/PyBaMM/pull/3437))
TomTranter marked this conversation as resolved.
Show resolved Hide resolved
agriyakhetarpal marked this conversation as resolved.
Show resolved Hide resolved
- Added `plot_thermal_components` to plot the contributions to the total heat generation in a battery ([#4021](https://github.com/pybamm-team/PyBaMM/pull/4021))
- Added functions for normal probability density function (`pybamm.normal_pdf`) and cumulative distribution function (`pybamm.normal_cdf`) ([#3999](https://github.com/pybamm-team/PyBaMM/pull/3999))
- "Basic" models are now compatible with experiments ([#3995](https://github.com/pybamm-team/PyBaMM/pull/3995))
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Bruggeman Transport Efficiency Model
====================================

.. autoclass:: pybamm.transport_efficiency.Bruggeman
:members:

.. footbibliography::

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Cation-Exchange Membrane Transport Efficiency Model
===================================================

.. autoclass:: pybamm.transport_efficiency.CationExchangeMembrane
:members:

.. footbibliography::
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Heterogeneous Catalyst Transport Efficiency Model
=================================================

.. autoclass:: pybamm.transport_efficiency.HeterogeneousCatalyst
:members:

.. footbibliography::
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Hyperbola of Revolution Transport Efficiency Model
==================================================

.. autoclass:: pybamm.transport_efficiency.HyperbolaOfRevolution
:members:

.. footbibliography::
Original file line number Diff line number Diff line change
@@ -1,8 +1,15 @@
transport_efficiency
Transport Efficiency
====================

.. toctree::
:maxdepth: 1

base_transport_efficiency
bruggeman_transport_efficiency
bruggeman
cation_exchange_membrane
heterogeneous_catalyst
TomTranter marked this conversation as resolved.
Show resolved Hide resolved
hyperbola_of_revolution
ordered_packing
overlapping_spheres
random_overlapping_cylinders
tortuosity_factor
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Ordered Packing Transport Efficiency Model
==========================================

.. autoclass:: pybamm.transport_efficiency.OrderedPacking
:members:

.. footbibliography::
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Overlapping Spheres Transport Efficiency Model
==============================================

.. autoclass:: pybamm.transport_efficiency.OverlappingSpheres
:members:

.. footbibliography::
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Random Overlapping Cylinders Transport Efficiency Model
=======================================================

.. autoclass:: pybamm.transport_efficiency.RandomOverlappingCylinders
:members:

.. footbibliography::
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Tortuosity Factor Transport Efficiency Model
============================================

.. autoclass:: pybamm.transport_efficiency.TortuosityFactor
:members:

.. footbibliography::
1 change: 1 addition & 0 deletions docs/source/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ The notebooks are organised into subfolders, and can be viewed in the galleries
notebooks/models/submodel_cracking_DFN_or_SPM.ipynb
notebooks/models/loss_of_active_materials.ipynb
notebooks/models/thermal-models.ipynb
notebooks/models/tortuosity_models.ipynb
notebooks/models/unsteady-heat-equation.ipynb
notebooks/models/using-model-options_thermal-example.ipynb
notebooks/models/using-submodels.ipynb
Expand Down
562 changes: 329 additions & 233 deletions docs/source/examples/notebooks/models/latexify.ipynb

Large diffs are not rendered by default.

Loading
Loading