From ab3462ab79947773b6e60e3fb7b8d17345781b76 Mon Sep 17 00:00:00 2001 From: Yupeng Xu Date: Wed, 13 Sep 2023 12:52:32 -0400 Subject: [PATCH] correct some typos --- docs/source_docs/Introduction.rst | 2 +- docs/source_docs/eb/EBWalls.rst | 10 +++++----- docs/source_docs/inputs/InputsCoupling.rst | 8 ++++---- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/source_docs/Introduction.rst b/docs/source_docs/Introduction.rst index 86fecf0..d72ed54 100644 --- a/docs/source_docs/Introduction.rst +++ b/docs/source_docs/Introduction.rst @@ -24,7 +24,7 @@ time discretizations differ. Specifically, - Plotfile format supported by AmrVis, VisIt, ParaView, and yt. MFIX-Exa is being developed at NETL and LBNL as part of the U.S. Department of -Energy's `Exascale Computing Project (ECP) `_ +Energy's `Exascale Computing Project (ECP) `_. MFIX-Exa heavily leverages `AMReX`_ which is also supported by ECP as part of the AMReX Co-Design Center. diff --git a/docs/source_docs/eb/EBWalls.rst b/docs/source_docs/eb/EBWalls.rst index b4f0f81..a55079d 100644 --- a/docs/source_docs/eb/EBWalls.rst +++ b/docs/source_docs/eb/EBWalls.rst @@ -13,9 +13,9 @@ Constructing Embedded Boundaries in MFIX-Exa MFIX-Exa uses AMReX's constructive solid geometry framework defined in the namespace :cpp:`amrex::EB2`. See the `AMReX EB documentation`_ for more details. These are -defined in ``src/eb/mfix_eb.cpp``. A the function :cpp:`mfix::make_eb_geometry` -(also defined in ``src/eb/mfix_eb.cpp``) selects :cpp:one of the following -geometries depending on the value of the :cpp:``mfix.geometry`` setting in the +defined in ``src/eb/mfix_eb.cpp``. The function :cpp:`mfix::make_eb_geometry` +(also defined in ``src/eb/mfix_eb.cpp``) selects one of the following +geometries depending on the value of the :cpp:`mfix.geometry` setting in the ``inputs`` file. +------------------------------+----------------------+-------------------------+ @@ -60,8 +60,8 @@ geometries depending on the value of the :cpp:``mfix.geometry`` setting in the | ``clr_riser`` | ``mfix.clr_riser = true`` | +-----------------------------+-------------------------------+ -2. These geometries where not ported from AMReX's old :cpp:``EB`` system to the - new :cpp:``EB2``. +2. These geometries are not ported from AMReX's old :cpp:`EB` system to the + new :cpp:`EB2`. Also note that planar boundary conditions can be specified in the ``mfix.dat`` file. Even if the user does not specify an ``mfix.geometry`` in the ``inputs``, diff --git a/docs/source_docs/inputs/InputsCoupling.rst b/docs/source_docs/inputs/InputsCoupling.rst index ae8632d..ad026f0 100644 --- a/docs/source_docs/inputs/InputsCoupling.rst +++ b/docs/source_docs/inputs/InputsCoupling.rst @@ -10,7 +10,7 @@ The following inputs must be preceded by "mfix." | | Description | Type | Default | +============================+===================================================+========+=============+ | deposition_scheme | The algorithm that will be used to deposit | String | 'trilinear' | -| | particles quantities to the Eulerian grid | | | +| | particles quantities to the Eulerian grid. | | | | | Available methods are: | | | | | | | | | | * 'centroid' | | | @@ -170,7 +170,7 @@ With the variables defined as follows: * pid - particle id number */ -The WenYu model is defined as +The :cpp:`WenYu` model is defined as .. code:: shell @@ -188,7 +188,7 @@ The WenYu model is defined as if (RE < DEMParams::eps) return 0.0; return 0.75 * C_d * vrel * ROPg * std::pow(EPg, -2.65) / DPM; -The Gidaspow model is defined as +The :cpp:`Gidaspow` model is defined as .. code:: shell @@ -218,7 +218,7 @@ The Gidaspow model is defined as if (RE < DEMParams::eps) return 0.0; return (1.0 - PHI_gs)*Ergun + PHI_gs*WenYu; -The Gidaspow model is defined as +The :cpp:`BVK2` model is defined as .. code:: shell -- GitLab