Full cell v2: flow, tanks, Shah's 2D cell, and a layered sumfem.electrochemistry

_toc.yml

@@ -27,6 +27,7 @@ parts:
       - file: "examples/electrochemistry/vanadium_half_cell_1d.py"
       - file: "examples/electrochemistry/vanadium_half_cell_2d.py"
       - file: "examples/electrochemistry/vanadium_half_cell_3d.py"
+      - file: "examples/electrochemistry/vanadium_full_cell_2d.py"
   - caption: "Python API"
     chapters:
       - file: "docs/api/index"

docs/api/electrochemistry.md

@@ -4,7 +4,15 @@
 .. automodule:: sumfem.electrochemistry
 ```
 
-## Electrolytes
+## Materials
+
+```{eval-rst}
+.. automodule:: sumfem.electrochemistry.materials
+
+.. currentmodule:: sumfem.electrochemistry
+```
+
+### Electrolytes
 
 ```{eval-rst}
 .. autoclass:: Electrolyte
@@ -14,7 +22,14 @@
    :members:
 ```
 
-## Porous electrodes
+### Redox couples
+
+```{eval-rst}
+.. autoclass:: RedoxCouple
+   :members:
+```
+
+### Porous electrodes
 
 ```{eval-rst}
 .. autoclass:: PorousElectrode
@@ -24,7 +39,15 @@
    :members:
 ```
 
-## Charge and transport
+## Models
+
+```{eval-rst}
+.. automodule:: sumfem.electrochemistry.models
+
+.. currentmodule:: sumfem.electrochemistry
+```
+
+### Charge and transport
 
 ```{eval-rst}
 .. autoclass:: ElectrolyteConduction
@@ -37,7 +60,7 @@
    :members:
 ```
 
-## Kinetics
+### Kinetics
 
 ```{eval-rst}
 .. autoclass:: ElectrodeReaction
@@ -56,7 +79,7 @@
    :members:
 ```
 
-## Membranes
+### Membranes
 
 ```{eval-rst}
 .. autoclass:: ProtonExchangeMembrane
@@ -69,17 +92,35 @@
    :members:
 ```
 
-## Half-cells
+### Flow through the electrodes
 
 ```{eval-rst}
-.. autoclass:: RedoxCouple
+.. autoclass:: ElectrodeFlow
+   :members:
+
+.. autoclass:: DarcyFlow
+   :members:
+
+.. autoclass:: FlowSetup
    :members:
+```
 
+## Cells
+
+```{eval-rst}
+.. automodule:: sumfem.electrochemistry.cells
+
+.. currentmodule:: sumfem.electrochemistry
+```
+
+### Half-cells
+
+```{eval-rst}
 .. autoclass:: RedoxHalfCell
    :members:
 ```
 
-## Full cells
+### Full cells
 
 ```{eval-rst}
 .. autoclass:: FullCell
@@ -90,4 +131,8 @@
 
 .. autoclass:: MembraneSpec
    :members:
+
+.. autoclass:: FlowSpec
+   :members:
+   :exclude-members: model
 ```

docs/api/symbolic.md

@@ -58,6 +58,10 @@
 
 .. autofunction:: expression_or_parameter
 
+.. autodata:: ExpressionOrValue
+
+.. autodata:: ExpressionOrDefault
+
 .. autoclass:: Residual
    :members:
 
@@ -163,6 +167,20 @@
 .. currentmodule:: sumfem.symbolic
 
 .. autofunction:: boltzmann_constant
+
+.. currentmodule:: sumfem.symbolic.si
+
+.. autodata:: CONCENTRATION
+
+.. autodata:: DENSITY
+
+.. autodata:: DIFFUSIVITY
+
+.. autodata:: PERMEABILITY
+
+.. autodata:: VISCOSITY
+
+.. currentmodule:: sumfem.symbolic
 ```
 
 ## Errors