Skip to content

Latest commit

 

History

History
77 lines (53 loc) · 3.84 KB

readme.rst

File metadata and controls

77 lines (53 loc) · 3.84 KB
Raw

BattMo is framework for continuum modelling of electrochemical devices.

The Battery Modelling Toolbox (BattMo) is a resource for continuum modelling of electrochemical devices in MATLAB. The initial development features a pseudo X-dimensional (PXD) framework for the Doyle-Fuller-Newman model of lithium-ion battery cells. However, the development plan for BattMo includes extensions to other battery chemistries (e.g. metal-air) and eventually hydrogen systems (i.e. electrolyzers and fuel cells).

BattMo offers users a flexible framework for building fully coupled electrochemical-thermal simulations of electrochemical devices using 1D, 2D, or 3D geometries. BattMo is implemented in MATLAB and builds on the open-source MATLAB Reservoir Simulation Toolbox (MRST) developed at SINTEF. MRST provides a solid basis for finite volume mesh generation of complex geometries and advanced numerical solvers that enable fast simulations for large systems.

For the latest information including video tutorials and project gallery, please visit the project webpage: https://batterymodel.com

We are also working on a documentation webpage. Even if it is now at a preliminary stage, you may be interested in having a look at it.

Installation

Before cloning this reposity you must make sure you have Git LFS installed. See https://git-lfs.com for instructions on downloading and installation.

BattMo is based on MRST, which provides a general unstructured grid format, generic MATLAB automatic differentiation tools and Newton solvers. The MRST code source wil be installed directly via git submodules. To install BattMo, you have therefore to clone this repository with the submodule option --recurse-submodules, as follows:

git clone --recurse-submodules https://github.com/BattMoTeam/BattMo.git

Then start MATLAB and in the directory where you cloned the repository, run:

startupBattMo

You can check that that your installation is setup correctly by running one of the example scripts :

runBattery1D

Iterative solvers

Iterative solvers are needed to solve large problems with many degrees of freedom. The open source version from 2012 of the AGMG iterative solver from 2012 is provided as a submodule. We plan to integrate newer open source iterative solvers such as AMGCL

Tutorials

Tutorials are presented in documentation (in progress ...)

Naming Conventions (TBC)

Class names are nouns in UpperCamelCase. Function names are verbs or phrases in lowerCamelCase. Instance names are nouns in lower_snake_case. Common variable names are represented by Latin letters (case set according to convention) or spelled-out lowercase Greek letters (e.g. phi). Other variable names may be nouns in lowerCamelCase.

Conntributors, in alphabetical order

  • Dr. Simon Clark, SINTEF Industry
  • Dr. Mike Gerhardt, SINTEF Industry
  • Dr. Halvor Møll Nilsen, SINTEF Digital
  • Dr. Xavier Raynaud, SINTEF Digital
  • Dr. Roberto Scipioni, SINTEF Industry

Acknowledgements

BattMo has received funding from the European Union’s Horizon 2020 innovation program under grant agreement numbers:

  • 875527 HYDRA
  • 957189 BIG-MAP