Skip to content

Commit

Permalink
minor additions to doc
Browse files Browse the repository at this point in the history
  • Loading branch information
tlroy committed May 2, 2024
1 parent 9493626 commit 6152cef
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 3 deletions.
3 changes: 2 additions & 1 deletion demos/flow_reactor/flow_reactor.py.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ We consider simplified CO2 - KHCO3 homogeneous reactions:
\ce{HCO3-} + \ce{OH-} \xrightleftharpoons[k_2^b]{k_2^f} \ce{CO3^2+} + \ce{H2O}
where :math:`k_i^f` and :math:`k_i^b` are the forward and backward rate constants, respectively.
Here, we assume the dilute solution case where :math:`\ce{H2O}`
concentration is not tracked.

Expand Down Expand Up @@ -268,7 +269,7 @@ physical constants described above::
The parameters and the mesh are passed to the initiator of parent class
:py:class:`EchemSolver <echemfem.EchemSolver>`. The optional argument ``family``
sets the finite element space; here, ``"CG"`` stands for continuous Galerkin,
which is usually the fastest option::
which is usually the fastest option, whereas ``"DG"`` stands for discontinuous Galerkin, which can provide more stability for advection-dominated cases::

super().__init__(conc_params, physical_params, mesh, family="CG",
echem_params=echem_params,
Expand Down
16 changes: 14 additions & 2 deletions docs/source/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ Quickstart Guide
Installation
------------

First, please install the open-source finite element library `Firedrake <https://www.firedrakeproject.org/download.html>`_.
On a Mac with Homebrew installed or on an Ubuntu workstation with sudo access, it can be installed using the default configuration.
First, please install the open-source finite element library `Firedrake <https://www.firedrakeproject.org>`_.
On a Mac with Homebrew installed or on an Ubuntu workstation with sudo access, it can be installed using the default configuration as detailed `here <https://www.firedrakeproject.org/download.html>`_.
To get started quickly, a `Docker image <https://hub.docker.com/r/firedrakeproject/firedrake>`_ is also available.
Note that you may need to increase the default memory allocation for Docker in order to run some of the EchemFEM examples.

Expand Down Expand Up @@ -35,6 +35,18 @@ To get started, a demo for a flow reactor is available :doc:`here <demos/index>`
Several examples can be found in `echemfem/examples <https://github.com/LLNL/echemfem/tree/main/examples>`_.
Examples using the generalized modified Poisson-Nernst-Planck model (GMPNP) can be found in `FireCat <https://github.com/LLNL/firecat>`_, where it is coupled with a microkinetics model.

To run an example:

.. code-block:: console
(firedrake) $ python example_name.py
And to run it in parallel with ``n_proc`` processors:

.. code-block:: console
(firedrake) $ mpiexec -n n_proc python example_name.py
Visualization
-------------

Expand Down

0 comments on commit 6152cef

Please sign in to comment.