From 0628fe093eb571ec077b013b1f9b89bec48b899f Mon Sep 17 00:00:00 2001 From: Deepak Rangarajan Date: Thu, 12 Dec 2024 21:17:21 -0500 Subject: [PATCH 1/2] Add porous media input section --- .../user_guide/inputs/porous_media_defs.rst | 26 +++++++++++++++++++ .../user_guide/run-time_inputs.rst | 1 + 2 files changed, 27 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..05008db --- /dev/null +++ b/docs/source_docs/user_guide/inputs/porous_media_defs.rst @@ -0,0 +1,26 @@ +.. _InputsPorousMediaDefs: + +Porous Media definitions +======================== + +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. | | | +| | | | | +| | :math:`S_i =-\frac{\mu}{C_1} v_i - C_2\frac{1}{2}\rho\lvert v \rvert v_i`| | | +| | | | | ++--------------------------+--------------------------------------------------------------------------+----------+-----------+ +| [region].c2 | Porous media inertial resistance factor for the source term in fluid | Real | None | +| | momentum equation. | | | +| | | | | +| | :math:`S_i =-\frac{\mu}{C_1} v_i - C_2\frac{1}{2}\rho\lvert v \rvert v_i`| | | +| | | | | ++--------------------------+--------------------------------------------------------------------------+----------+-----------+ 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 From 052e9ae0a200ffefad4744482b1742fe9a6723ba Mon Sep 17 00:00:00 2001 From: Jordan Musser Date: Fri, 13 Dec 2024 08:35:23 -0500 Subject: [PATCH 2/2] Minor tweaks to layout --- .../user_guide/inputs/porous_media_defs.rst | 46 ++++++++++--------- 1 file changed, 25 insertions(+), 21 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/porous_media_defs.rst b/docs/source_docs/user_guide/inputs/porous_media_defs.rst index 05008db..e8487cd 100644 --- a/docs/source_docs/user_guide/inputs/porous_media_defs.rst +++ b/docs/source_docs/user_guide/inputs/porous_media_defs.rst @@ -1,26 +1,30 @@ .. _InputsPorousMediaDefs: -Porous Media definitions -======================== +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. | | | -| | | | | -| | :math:`S_i =-\frac{\mu}{C_1} v_i - C_2\frac{1}{2}\rho\lvert v \rvert v_i`| | | -| | | | | -+--------------------------+--------------------------------------------------------------------------+----------+-----------+ -| [region].c2 | Porous media inertial resistance factor for the source term in fluid | Real | None | -| | momentum equation. | | | -| | | | | -| | :math:`S_i =-\frac{\mu}{C_1} v_i - C_2\frac{1}{2}\rho\lvert v \rvert v_i`| | | -| | | | | -+--------------------------+--------------------------------------------------------------------------+----------+-----------+ ++--------------------------+------------------------------------------------------------------------------+----------+-----------+ +| | 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. | | | ++--------------------------+------------------------------------------------------------------------------+----------+-----------+ -- GitLab