BattMo Logo
  • Installation
    • Update existing installation
  • You First Example
    • A First BattMo Model
      • Define Parameters
      • Run Simulation
      • Show the Dashboard
      • Explore the Output
      • Explore the Grid
      • Explore the States
      • Plot a Result
    • Change Control Parameters
    • Change Structural Parameters
    • Change Material Parameters
    • Notebooks
    • Next Steps
  • Tutorials
    • Tutorial 1 - Your First BattMo Model
      • Introduction
      • Define Parameters
      • Run Simulation
      • Show the Dashboard
      • Explore the Output
      • Explore the Grid
      • Explore the States
      • Plot a Result
    • Tutorial 2 - Change the Control Protocol
      • Introduction
      • Explore the Control Protocol
      • Setup and Run a Parameter Sweep
      • Summary
    • Tutorial 3 - Modify Structural Parameters
      • Introduction
      • Explore the Structural Parameters
      • Setup and Run a Parameter Sweep
      • Summary
    • Tutorial 4 - Modify Material Parameters
      • Introduction
      • Explore the Material Parameters
      • Make a Simple Change
      • Swap Active Materials
      • Summary
    • Tutorial 5 - Simulate CC-CV Cycling
      • Introduction
      • Explore the Control Definition
      • Summary
    • Tutorial 6 - Simulate Thermal Performance
      • Introduction
      • Setup material properties
      • Setup the geometry
      • Run the simulation
      • Visualisation of the results
      • Temperature distribution at final time
      • The external heat transfer coefficient
    • Tutorial 7 - A Simple P4D Simulation
      • Introduction
      • Visualize the Results
      • Compare with a P2D Simulation
      • Summary
    • Tutorial 8 - Simulate a Multilayer Pouch Cell
      • Introduction
      • Setup the model for inspection
      • Run the simulation
      • Visualize the Results
    • Tutorial 9 - Simulate a cylindrical cell
      • Introduction
      • Setup the model for inspection
      • Run the simulation
      • Visualize the Results
  • BattMo Input
    • Introduction
    • My First Json Input
      • Simulation
      • Battery
      • Negative Electrode
      • Coating
      • Active Material
      • Interface
      • Solid Diffusion
      • Binder
      • Conducting Additive
      • Electrolyte
      • Current Collector
      • Separator
      • Thermal Model
      • Geometry
      • Control
      • Model Specification
      • State Initialization
      • Time Stepping
    • JSON input specification
      • Simulation Schema
      • Material Parameters
        • Electrolyte
        • Electrode
        • Coating
        • Active Material
        • Interface
        • Solid Diffusion
        • Full Solid Diffusion
        • Binder
        • Conducting Additive
        • Current Collector
        • Separator
        • Thermal Model
      • Geometry Setup
      • Control Parameters
      • Time Stepping Parameters
      • Solver Parameters
      • Output Parameters
    • Merging parameters
      • Setup a P4D Model using mergeJsonStructs
        • Define Parameters
        • Run Simulation
        • Visualize Results
      • File links and insertions with parseBattmoJson
    • List of Json File Examples
    • Functional parameters
      • Function name
      • Function formula
      • Tabulated function
      • CSV file
      • Example
        • Example of the function interface
    • Control models
      • Examples of the different control policies
        • Setup json input
        • Setup Constant Current Discharge control and run simulation
        • Setup Constant Current Charge control and run simulation
        • Plot Results
        • Setup Constant Current Constant Voltage control and run the simulation
        • Plot Results
      • Example of function control
        • Case setup
        • Functional time control
        • Value Control setup
        • We finalize the setup of the jsonstruct input
        • Tabulated data for the function control
      • Example using generic control input
        • Input setup
        • Plotting
      • Example using generic control input with cycles
        • Input setup
        • Plotting
    • Parameter sets
  • BattMo output
    • Simulation Output Structure
      • Output structure overview
      • Simulation Model
      • Battery States
      • Simulation Setup
      • Json Input
      • full set of state variables
    • Cell Specifications
  • Battery Geometries
    • BatteryGeneratorP2D
    • BatteryGeneratorP3D
    • BatteryGeneratorP4D
    • SpiralBatteryGenerator
    • CoinCellBatteryGenerator
    • BatteryGeneratorMultilayerPouch
  • Battery Physics
    • Thermal simulation
      • Setup of the material properties
      • Setup of the geometry
      • Setup of the Control
      • Plot of the external heat transfer coefficient
      • Run the simulation
      • Plot of the voltage
      • Plot of the minimum and maximum values of the temperature
      • We change setup for cooling coefficient
      • Plot of temperatures
      • Plot of the temperature distribution
    • Comparison between coupled and uncoupled thermal simulation
      • setup material property input
      • Setup geometry input
      • Setup Control input
      • Modify input structure
      • Run thermal simulation
      • Plot mesh
      • Run iso-thermal simulation
      • Setup thermal-only simulation
      • Setup heat source term
      • Setup thermal-only model
      • Setup the simulation schedule
      • setup initial state
      • run thermal-only simulation
      • Plotting
    • Simulation with Surface Electrolyte Interface (SEI)
      • Setup the properties of the Li-ion battery materials and of the cell design
      • Simulation
      • Plotting
      • SEI thickness
      • SEI voltage drop
      • Lithium content
      • Lithium total mass balance
      • Capacity loss
    • Simulation of a composite active material
      • Setup the properties of the battery
      • We modify some parameters
      • We run the simulations
      • Plotting
      • plot of the particle concentration distribution in the particle at the end time
      • Charge step
      • Visualisation
    • Lithium Plating
      • Run stand-alone active material model with lithium plating
        • Parameter setup
        • Setup simulation schedule
        • Setup initial state
        • Run first simulation, particle charge
        • Setup discharge simulation
        • Run second simulation, particle discharge
        • Plotting
        • Sum up
      • Lithium plating example
        • Parameter setup
        • Plotting
    • Silicon Swelling Example
      • Geometry
      • Control
      • Plotting the results
    • Solid Diffusion Models
  • Other Electro-Chemical Systems
    • Alkaline Membrane Electrolyser
      • Setup input
      • Setup model
      • Setup the initial condition
      • Setup the schedule with the time discretization
      • Setup the non-linear solver
      • Run the simulation
      • Visualize the results
      • pH distribution plot
    • Proton Ceramic Membrane
      • Proton Ceramic Membrane
        • Model overview
        • Load and parse input from given json files
        • Input structure setup
        • Model setup
        • Initial state setup
        • Schedule
        • Simulation
        • Plotting
        • Evolution of the Faradic efficiency
      • Gas Supply
        • Model overview
        • json input data
        • Input parameter setup
        • Model setup
        • Model Plot
        • Setup initial state
        • Schedule setup
        • Simulation
        • Result plots
      • Full Cell
        • Model coupling
        • json input data
        • Input parameter setup
        • Model setup
        • Grid plots
        • Setup initial state
        • Setup schedule
        • Setup nonlinear solver
        • Start simulation
        • plotting setup
        • Electrolyte results
        • Gas Layer results
        • Interface results
  • Optimization
    • Parameter identification example
    • Optimization example
  • Modeling with BattMo
    • Part1
      • Part I: Table of Contents
      • 1. Lithium-Ion Battery Basics
        • 1.1 Cell Components
        • 1.2 Working Principle
        • 1.3 Battery Properties
        • 1.4 Operational Protocols
      • 2. Modelling with BattMo
        • 2.1 P2D/P3D/P4D Models
        • 2.2 Influence of structural and material parameters on the capacity
        • 3. Summary
        • 4. References
    • Part2
      • Part II: Table of Contents
      • 1. DFN Model Overview
      • 2. Overpotentials and Voltage losses
        • Example 1. OCV curve and voltage loss at different C-rates
        • Example 2. Mass fraction of active material and binder in electrode
        • Example 3. Temperature
        • Example 4. Saturation concentration of the material
        • Example 5. Charge transfer coefficient, anodic and cathodic at the surface of the active particles: Butler-Volmer equation
        • Example 6. Reaction rate constant at the surface of the active particles: Butler-Volmer equation (exchange current density)
        • Example 7. Reference diffusion coefficient (Solid diffusion)
        • Example 8. Active particle radius (Solid diffusion)
        • Example 9. Electronic conductivity of the active material in the electrodes (effective electronic conductivity)
        • Example 10. Bruggeman coefficient in the electrodes (effective electronic conductivity)
        • Example 11. Bruggeman coefficient in the electrolyte (effective ionic conductivity)
        • Example 12. Initial electrolyte concentration (electrolyte diffusion)
        • Example 13. Transference number (electrolyte diffusion)
  • BattMo Internals
    • BattMo Model Architecture
    • Computational Graph
      • Introduction
      • Model assembly
      • Model explorability
      • Model hierarchy and composition
      • Basic Example
      • Graph Setup and Implementation
  • Programming Interfaces
    • BattMo Julia bridge
      • Introduction
      • Start Server
      • Send simulation parameters
      • Run the simulation
      • Post process the output
    • BattMoApp
      • Features
        • Utilize Default Materials
        • Customize with Your Own Materials
        • Visualize Your Battery Geometry
        • Download Input Data
        • Upload Input Data
        • Visualize and Download Results
        • Upload your previous results
      • Troubleshooting
        • Unnatural artifacts
        • Unsuccessful simulation
    • Octave
  • See Also
    • MRST
      • Visualization Tutorial
      • Grid Factory Tutorial
    • FAIR Data
  • References
BattMo
  • Tutorials
  • View page source

Tutorials

Your First BattMo Model

Change the Control Protocol

Modify Structural Parameters

Modify Material Parameters

Simulate CC-CV Cycling

Simulate Thermal Performance

A Simple P4D Simulation

Simulate a Multilayer Pouch Cell

Simulate a cylindrical cell

Previous Next

© Copyright 2021-2024.

Built with Sphinx using a theme provided by Read the Docs.