Welcome to cideMOD’s documentation

CIDETEC’s open-source tool cideMOD is based on the Doyle-Fuller- Newman model [1] in which the physicochemical equations are solved by Finite Element methods using the FEniCSx [2] library.It enables doing physics-based battery cell (herein after cell) simulations with a wide variety of use cases, from different drive cycles to studies of the SEI growth under storage conditions.

cideMOD is a pseudo X-dimensional (PXD) model that extends the original pseudo 2-dimensional (P2D) model, proposed by Newman and co-workers, from 1D to 2D and 3D cell geometry. Therefore, charge balance, mass balance and reaction kinetics, as well as energy balance, are spatially resolved for the entire cell geometry, considering the inhomogeneity of cell state properties.

Check out the Installation section for instructions to install the software or the Usage section for information on how to use the library.

Contents:

• Introduction
• Installation
  • Install dependencies with docker
  • Install from source
• Usage
  • Getting Started
  • Specify Model Options
  • Cell Parameters
  • Test Plan
  • Finer control
  • Outputs
• Modelling
  • Geometry and mesh
  • Submodels
  • Pseudo-dimension
  • P2D vs P4D
  • Formulation details
• Use cases
  • Datasets
  • Examples
• API Reference
  • cideMOD.helpers
  • cideMOD.numerics
  • cideMOD.mesh
  • cideMOD.cell
  • cideMOD.models
  • cideMOD.simulation_interface
  • cideMOD.main
• Citing
• Authors
• Acknowledgments
• Contact Us
• Bibliography