From 66b2be106c4d566a64d75df9d130331746ed5ae7 Mon Sep 17 00:00:00 2001
From: Deepak Rangarajan <deepak.rangarajan@netl.doe.gov>
Date: Fri, 13 Dec 2024 13:37:20 +0000
Subject: [PATCH] Add porous media input section (exa/docs!104)

---
 .../user_guide/inputs/porous_media_defs.rst   | 30 +++++++++++++++++++
 .../user_guide/run-time_inputs.rst            |  1 +
 2 files changed, 31 insertions(+)
 create mode 100644 docs/source_docs/user_guide/inputs/porous_media_defs.rst

diff --git a/docs/source_docs/user_guide/inputs/porous_media_defs.rst b/docs/source_docs/user_guide/inputs/porous_media_defs.rst
new file mode 100644
index 0000000..e8487cd
--- /dev/null
+++ b/docs/source_docs/user_guide/inputs/porous_media_defs.rst
@@ -0,0 +1,30 @@
+.. _InputsPorousMediaDefs:
+
+Porous media
+============
+
+Homogeneous porous media are modeled by the addition of a momentum
+source term, :math:`\boldsymbol{S}_{pm}`, to the fluid momentum equation.
+
+.. math::
+
+   \boldsymbol{S}_{pm} =-\frac{\mu_f}{C_1} \boldsymbol{u}_f - C_2\frac{1}{2}\rho_f\lvert \boldsymbol{u}_f \rvert \boldsymbol{u}_f
+
+:math:`\mu_f`, :math:`\rho_f`, and :math:`\boldsymbol{u}_f` are the fluid viscosity, density, and velocity and
+:math:`C_1` and :math:`C_2` are user defined constants.
+
+The following inputs are defined using the ``pm`` prefix.
+
++--------------------------+------------------------------------------------------------------------------+----------+-----------+
+|                          | Description                                                                  |   Type   | Default   |
++==========================+==============================================================================+==========+===========+
+| regions                  | Regions used to define porous media.                                         | String   |  None     |
++--------------------------+------------------------------------------------------------------------------+----------+-----------+
+| [region].fluid.volfrac   | Fluid volume fraction of the porous media region.                            |  Real    |  None     |
++--------------------------+------------------------------------------------------------------------------+----------+-----------+
+| [region].c1              | Porous media permeabilty constant for the source term in fluid               |  Real    |  None     |
+|                          | momentum equation.                                                           |          |           |
++--------------------------+------------------------------------------------------------------------------+----------+-----------+
+| [region].c2              | Porous media inertial resistance factor for the source term in fluid         |  Real    |  None     |
+|                          | momentum equation.                                                           |          |           |
++--------------------------+------------------------------------------------------------------------------+----------+-----------+
diff --git a/docs/source_docs/user_guide/run-time_inputs.rst b/docs/source_docs/user_guide/run-time_inputs.rst
index c232438..1e3a339 100644
--- a/docs/source_docs/user_guide/run-time_inputs.rst
+++ b/docs/source_docs/user_guide/run-time_inputs.rst
@@ -50,6 +50,7 @@ keywords such as ``mfix``, ``amr``, ``geometry``, ``nodal_proj`` etc.
    inputs/fluid_model
    inputs/solids_model
    inputs/species_defs
+   inputs/porous_media_defs
    inputs/chemical_reactions
    inputs/regions_defs
    inputs/initial_conditions
-- 
GitLab