diff --git a/docs/source/examples.rst b/docs/source/examples.rst new file mode 100644 index 0000000..ee02192 --- /dev/null +++ b/docs/source/examples.rst @@ -0,0 +1,37 @@ +Examples +======== + +Here is a brief overview of the examples in `echemfem/examples `_. + +* **Planar flow reactor** with electroneutral Nernst-Planck. A Butler-Volmer expression is used for the redox reaction, and there are no homogeneous bulk reactions. A custom mesh is used with refinements close to the electrodes. + + * `2D case for binary electrolyte `_ (:math:`\ce{CuSO4}`) + * `Nondimensional version of binary case `_ + * `2D case for three-ion electrolyte `_ (:math:`\ce{CuSO4}` and :math:`\ce{H2SO4}`) + * `Nondimensional version of three ion case `_ + * `3D version of the three-ion case using custom preconditioners for a Discontinuous Galerkin (DG) scheme, and nondimensional `_ + +* Simple 1D reaction-diffusion system for :math:`\ce{CO2}` electrolysis in :math:`\ce{KHCO3}` + + * `Simplified bicarbonate bulk reactions `_ + * `Full bicarbonate bulk reactions `_ + * `Different implementation of the full bicarbonate bulk reactions `_ (using the :doc:`homog_params ` interface) + +* 2D flow-past the electrode with advection-diffusion + + * `Two species toy model with shear flow `_ + * `CO2 electrolysis in bicarbonate with linear charge-transfer kinetics and shear flow `_ + * `Two species toy model with irregular electrode with Navier-Stokes for the flow `_ + +* 1D model for the :math:`\ce{CO2}` electrolysis in a copper catalyst layer of a gas diffusion electrode (GDE). The model uses electroneutral Nernst-Planck in a porous medium. + + * `Using substitution of the electroneutrality equation to eliminate a species `_ + * `Solving the electroneutrality equation explicitly `_ + +* `A simple Vanadium flow battery using advection-diffusion-reaction, Poisson for the ionic potential with a predefinied conductivity and Navier-Stokes-Brinkman for the flow `_ + +* `A symmetric cylindrical pore model for CO2 electrolysis using electroneutral Nernst-Planck and simplified bicarbonate bulk reactions `_ + +* `A tandem flow-past the electrode system with an Ag catalyst placed in front of a Cu catalyst with electroneutral Nernst-Planck and Tafel kinetics `_ + +* `Simple example for the BMCSL model for finite size ion effects `_ diff --git a/docs/source/index.rst b/docs/source/index.rst index e3040c1..c396b5a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -24,6 +24,7 @@ Contents .. toctree:: :titlesonly: + examples api Copyright and License diff --git a/examples/gupta.py b/examples/gupta.py index ca4bcdb..13320b5 100644 --- a/examples/gupta.py +++ b/examples/gupta.py @@ -4,8 +4,8 @@ class GuptaSolver(EchemSolver): """ - A 1D example of diffusion-reaction for CO2 electrolysis with bicarbonate bulk - reactions. + A 1D example of diffusion-reaction for CO2 electrolysis with simplified + bicarbonate bulk reactions. Steady-state version of example from Gupta, N., Gattrell, M. and MacDougall, B., 2006. Calculation for the diff --git a/examples/simple_flow_battery.py b/examples/simple_flow_battery.py index 482bc79..cd1e79e 100644 --- a/examples/simple_flow_battery.py +++ b/examples/simple_flow_battery.py @@ -5,8 +5,8 @@ """ A simple Vanadium flow battery using advection-diffusion-reaction, Poisson for -the ionic potential with a predefinied conductivity and Stokes-Brinkman for the -flow. +the ionic potential with a predefinied conductivity and Navier-Stokes-Brinkman +for the flow. Model taken from Lin, T.Y., Baker, S.E., Duoss, E.B. and Beck, V.A., 2022. Topology optimization