deploy: a08b3de

BattMoTeam · Jan 15, 2024 · 4044c94 · 4044c94
commit 4044c94
Show file tree

Hide file tree

Showing 185 changed files with 41,870 additions and 0 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 6cba945694f049f88a469ed7f18a502b
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.nojekyll b/.nojekyll
diff --git a/_images/1dmodel.png b/_images/1dmodel.png
diff --git a/_images/3dconc.png b/_images/3dconc.png
diff --git a/_images/3dmodel.png b/_images/3dmodel.png
diff --git a/_images/activematerialgraph.png b/_images/activematerialgraph.png
diff --git a/_images/battMoTutorial_01.png b/_images/battMoTutorial_01.png
diff --git a/_images/battMoTutorial_02.png b/_images/battMoTutorial_02.png
diff --git a/_images/battmologo.png b/_images/battmologo.png
diff --git a/_images/chencomp.png b/_images/chencomp.png
diff --git a/_images/chencompzoom.png b/_images/chencompzoom.png
diff --git a/_images/coatinggraph.png b/_images/coatinggraph.png
diff --git a/_images/coincell.png b/_images/coincell.png
diff --git a/_images/controlExampleCCCV.png b/_images/controlExampleCCCV.png
diff --git a/_images/controlExampleCCCharge.png b/_images/controlExampleCCCharge.png
diff --git a/_images/controlExampleCCDischarge.png b/_images/controlExampleCCDischarge.png
diff --git a/_images/crates.png b/_images/crates.png
diff --git a/_images/cutbatterygraph.png b/_images/cutbatterygraph.png
diff --git a/_images/discharge_voltage_temperature_example.png b/_images/discharge_voltage_temperature_example.png
diff --git a/_images/electolysermodeling.png b/_images/electolysermodeling.png
diff --git a/_images/electrodegraph.png b/_images/electrodegraph.png
diff --git a/_images/electrolyser1.png b/_images/electrolyser1.png
diff --git a/_images/electrolyser2.png b/_images/electrolyser2.png
diff --git a/_images/electrolyser3.png b/_images/electrolyser3.png
diff --git a/_images/electrolyter_volume_fractions.png b/_images/electrolyter_volume_fractions.png
diff --git a/_images/exampleControl.png b/_images/exampleControl.png
diff --git a/_images/externalheattransfercoef.png b/_images/externalheattransfercoef.png
diff --git a/_images/fairlogo.svg b/_images/fairlogo.svg
diff --git a/_images/firstresult.png b/_images/firstresult.png
diff --git a/_images/gridfact.png b/_images/gridfact.png
diff --git a/_images/gridviz.png b/_images/gridviz.png
diff --git a/_images/jellyrollmodel.png b/_images/jellyrollmodel.png
diff --git a/_images/juliarun.png b/_images/juliarun.png
diff --git a/_images/mrst.png b/_images/mrst.png
diff --git a/_images/runBattery1DOptimize.png b/_images/runBattery1DOptimize.png
diff --git a/_images/runBatteryP2D_01.png b/_images/runBatteryP2D_01.png
diff --git a/_images/runElectrolyser_01.png b/_images/runElectrolyser_01.png
diff --git a/_images/runElectrolyser_02.png b/_images/runElectrolyser_02.png
diff --git a/_images/runJsonScript_01.png b/_images/runJsonScript_01.png
diff --git a/_images/runParameterIdentification1.png b/_images/runParameterIdentification1.png
diff --git a/_images/runParameterIdentification2.png b/_images/runParameterIdentification2.png
diff --git a/_images/runSEIActiveMaterial_01.png b/_images/runSEIActiveMaterial_01.png
diff --git a/_images/runSEIActiveMaterial_02.png b/_images/runSEIActiveMaterial_02.png
diff --git a/_images/runSEIActiveMaterial_03.png b/_images/runSEIActiveMaterial_03.png
diff --git a/_images/runSEIActiveMaterial_04.png b/_images/runSEIActiveMaterial_04.png
diff --git a/_images/runSEIActiveMaterial_05.png b/_images/runSEIActiveMaterial_05.png
diff --git a/_images/runSEIActiveMaterial_06.png b/_images/runSEIActiveMaterial_06.png
diff --git a/_images/runSiliconGraphiteBattery_01.png b/_images/runSiliconGraphiteBattery_01.png
diff --git a/_images/runSiliconGraphiteBattery_02.png b/_images/runSiliconGraphiteBattery_02.png
diff --git a/_images/runbattery2d.png b/_images/runbattery2d.png
diff --git a/_images/runbattery3d.png b/_images/runbattery3d.png
diff --git a/_images/temperature_distribution.png b/_images/temperature_distribution.png
diff --git a/_images/temperature_evolution1.png b/_images/temperature_evolution1.png
diff --git a/_images/temperature_evolution2.png b/_images/temperature_evolution2.png
diff --git a/_sources/advancedtopics.rst.txt b/_sources/advancedtopics.rst.txt
@@ -0,0 +1,24 @@
+==============
+Advanced Usage
+==============
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   modelinitialisation
+   controlinput
+   soliddiffusion
+   parsets
+   units
+   thermal
+   optimisation
+
+* :ref:`The Battery Simulation Model<modelinitialisation:The Battery Simulation Model>`
+* :ref:`Control models <controlinput:Control models>`
+* :ref:`Solid diffusion models <soliddiffusion:Solid Diffusion Models>`
+* :ref:`Parameter sets <parsets:Parameter sets>`
+* :ref:`Units <units:Units>`
+* :ref:`Thermal simulation <thermal:Thermal Simulation>`
+* :ref:`Optimisation <optimisation:Optimization>`
+
diff --git a/_sources/architecture.rst.txt b/_sources/architecture.rst.txt
@@ -0,0 +1,86 @@
+=========================
+BattMo Model Architecture
+=========================
+
+We use a multi-model approach. The models are organized in a hierarchy, meaning that a given model can have
+sub-models. A model corresponds to a given physical system and defines the functions and variables that will be needed
+to assemble the discretized governing equations of the system.
+
+For the simulation of Lithium-ion battery, we have at the top of the hierarchy a battery model (see :ref:`schema
+<json:Material Parameters>` for the description of the standard input parameters). The battery model contains the
+following sub-models:
+
+* Negative electrode model :ref:`(schema) <json:Electrode>`
+* Positive electrode model :ref:`(schema) <json:Electrode>`
+* Electrolyte model :ref:`(schema) <json:Electrolyte>`
+* Separator model :ref:`(schema) <json:Separator>`
+* ThermalModel model :ref:`(schema) <json:Thermal Model>`
+* Control model :ref:`(schema) <json:Simulation Control Parameters>`
+
+.. figure:: img/cutbatterygraph.png
+   :target: _images/cutbatterygraph.png
+
+The **negative and positive electrodes** are instances of the same electrode model. An electrode contains a coating
+material and a current collector. The standard input parameters for an electrode model are given in its :ref:`schema
+<json:Electrode>`. The electrode model has two sub-models:
+
+* Coating model :ref:`(schema) <json:Coating>`
+* Current Collector model :ref:`(schema) <json:Current Collector>`
+
+
+.. figure:: img/electrodegraph.png
+   :target: _images/electrodegraph.png
+   :width: 50%
+   :align: center
+
+The current collector model is optional. In particular, for the 1D model it is in fact more realistic to not include it.
+
+The standard input parameters of the **coating model** are given in the associated :ref:`schema <json:Coating>`. The
+coating model has three sub-models, which corresponds of the three components of the solid:
+
+* Active material model :ref:`(schema) <json:Active Material>`
+* Binder :ref:`(schema) <json:Binder>`
+* Conductive additive model :ref:`(schema) <json:Conducting Additive>`
+
+.. figure:: img/coatinggraph.png
+   :target: _images/coatinggraph.png
+   :width: 70%
+   :align: center
+   :class: with-border
+
+
+In the case of a composite material, the coating model will have a different structure, with two active material models.
+
+.. _ArchitectureActiveMaterial:
+
+The input parameters for the **Active Material** are described in the associated :ref:`schema <json:Active Material>`. The active material is
+organized in two sub-models. 
+
+* Interface :ref:`(schema) <json:Interface>`
+* SolidDiffusion :ref:`(schema) <json:Solid Diffusion>`
+
+.. figure:: img/activematerialgraph.png
+   :target: _images/activematerialgraph.png
+   :width: 50%
+   :align: center
+
+In the interface model, the function and variables that enter the reaction are defined (Butler-Volmer model). The solid
+diffusion model contains the functions to model and solve the diffusion equation in the solid. We have implemented two
+solid diffusion model, see :ref:`here <soliddiffusion:Solid Diffusion Models>`.
+
+The **Control** :ref:`(schema) <json:Simulation Control Parameters>`, **Separator** :ref:`(schema) <json:Separator>` and
+**Thermal** :ref:`(schema) <json:Thermal Model>` models do not have sub-models. The control model is described in more
+details :ref:`here<controlinput:Control models>`. A example of a fully coupled thermal simulation is presented
+:ref:`here<thermal:Thermal Simulation>`.
+
+
+
+
+
+
+
+
+
+
+
+