Loading Makefile 0 → 100644 +13 −0 Changes for Makefile: 13 added lines, 0 removed lines. Original line number Diff line number Diff line SPHINXBUILD = sphinx-build SOURCEDIR = docs/source_docs/ BUILDDIR = build html: $(SPHINXBUILD) -b html $(SOURCEDIR) $(BUILDDIR)/html pdf: $(SPHINXBUILD) -b latex $(SOURCEDIR) $(BUILDDIR)/latex cd $(BUILDDIR)/latex && make clean: rm -rf $(BUILDDIR) docs/source_docs/references/size_distributions.rst +26 −26 Changes for docs/source_docs/references/size_distributions.rst: 26 added lines, 26 removed lines. Original line number Diff line number Diff line Loading @@ -27,7 +27,7 @@ Volume-weighted diameter distribution Number-weighted and volume-weighted distributions are not interchangeable. Failing to specify the correct distribution weighting can result in unexpected behavior. MFIX uses both distribution weightings, computing (or approximating) Internally, MFIX uses both distribution weightings, computing (or approximating) whichever distribution weighting that was not provided. For example, if a number-weighted normal distribution is provided, the corresponding volume-weighted normal distribution is computed. The volume-weighted distribution is used to calculate Loading Loading @@ -88,15 +88,15 @@ density. The initial condition region volume is 0.001 m\ :sup:`3`, and it has a ic.full-domain.solid0.volfrac = 0.05 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = constant ic.full-domain.solid0.diameter.distribution = constant ic.full-domain.solid0.diameter.constant = 1000.e-6 # (m) ic.full-domain.solid0.density = constant ic.full-domain.solid0.density.distribution = constant ic.full-domain.solid0.density.constant = 2500.0 # (kg/m^3) An MFIX-Exa DEM simulation generates approximately 95,500 particles, while a PIC simulation with ``pic.close_pack = 0.64``, ``pic.parcels_per_cell_at_pack = 64``, and an Eulerian mesh spacing :math:`\Delta x` of 3.125 mm generates approximately 164,000 parcels. With these settings, an MFIX-Exa DEM simulation generates approximately 95,500 particles, while a PIC simulation with ``pic.close_pack = 0.64``, ``pic.parcels_per_cell_at_pack = 64``, and an Eulerian mesh spacing :math:`\Delta x` of 3.125 mm generates approximately 164,000 parcels. ``normal`` distribution Loading @@ -115,7 +115,7 @@ used to specify the distribution are provided in the following table. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | type | distribution weighting: ``number-weighted`` or ``volume-weighted`` | string | N/A | | weighting | distribution weighting: ``number-weighted`` or ``volume-weighted`` | string | N/A | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | mean | mean of the normal random variable, :math:`X` | Real | N/A | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading Loading @@ -167,14 +167,14 @@ and 1.75 mm, respectively. ic.full-domain.solid0.volfrac = 0.05 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = normal ic.full-domain.solid0.diameter.type = number-weighted ic.full-domain.solid0.diameter.distribution = normal ic.full-domain.solid0.diameter.weighting = number-weighted ic.full-domain.solid0.diameter.mean = 1000.e-6 # (m) ic.full-domain.solid0.diameter.std = 250.e-6 # (m) ic.full-domain.solid0.diameter.min = 250.e-6 # (m) ic.full-domain.solid0.diameter.max = 1750.e-6 # (m) ic.full-domain.solid0.density = constant ic.full-domain.solid0.density.distribution = constant ic.full-domain.solid0.density.constant = 2500.0 # (kg/m^3) Loading Loading @@ -355,7 +355,7 @@ where :math:`\mu` and :math:`\sigma` are parameters defining the distribution. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | type | distribution weighting: ``number-weighted`` or ``volume-weighted`` | string | N/A | | weighting | distribution weighting: ``number-weighted`` or ``volume-weighted`` | string | N/A | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | mean | mean of of the normal random variable, | Real | N/A | | | :math:`\mathrm{ln}(X)` | | | Loading Loading @@ -409,14 +409,14 @@ and 3.00 mm, respectively. ic.full-domain.solid0.volfrac = 0.25 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = log-normal ic.full-domain.solid0.diameter.type = volume-weighted ic.full-domain.solid0.diameter.distribution = log-normal ic.full-domain.solid0.diameter.weighting = volume-weighted ic.full-domain.solid0.diameter.mean = -3.662955279 ic.full-domain.solid0.diameter.std = 1.04 ic.full-domain.solid0.diameter.min = 30.e-6 # (m) ic.full-domain.solid0.diameter.max = 3000.e-6 # (m) ic.full-domain.solid0.density = constant ic.full-domain.solid0.density.distribution = constant ic.full-domain.solid0.density.constant = 2500.0 # (kg/m^3) Loading Loading @@ -508,7 +508,7 @@ used to specify the distribution are provided in the following table. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | type | distribution weighting: ``number-weighted`` or ``volume-weighted`` | string | N/A | | weighting | distribution weighting: ``number-weighted`` or ``volume-weighted`` | string | N/A | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | min | Minimum particle diameter. Drawn samples below ``min`` are discarded | Real | N/A | | | and a new sample is drawn. | | | Loading Loading @@ -554,12 +554,12 @@ The minimum and maximum particle diameters are 0.25 mm and 1.75 mm, respectively ic.full-domain.solid0.volfrac = 0.05 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = uniform ic.full-domain.solid0.diameter.type = number-weighted ic.full-domain.solid0.diameter.distribution = uniform ic.full-domain.solid0.diameter.weighting = number-weighted ic.full-domain.solid0.diameter.min = 250.e-6 # (m) ic.full-domain.solid0.diameter.max = 1750.e-6 # (m) ic.full-domain.solid0.density = constant ic.full-domain.solid0.density.distribution = constant ic.full-domain.solid0.density.constant = 2500.0 # (kg/m^3) Loading Loading @@ -766,14 +766,14 @@ distribution is a 50/50 mixture of two particle sizes. ic.full-domain.solid0.volfrac = 0.05 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = custom ic.full-domain.solid0.diameter.distribution = custom ic.full-domain.solid0.diameter.custom = bidisperse-pdf.dist ic.full-domain.solid0.diameter.type = number-weighted ic.full-domain.solid0.diameter.weighting = number-weighted ic.full-domain.solid0.density = constant ic.full-domain.solid0.density.distribution = constant ic.full-domain.solid0.density.constant = 2500.0 # (kg/m^3) ic.full-domain.solid0.density = constant ic.full-domain.solid0.density.distribution = constant ic.full-domain.solid0.density.constant = 2500.0 # (kg/m^3) Loading Loading @@ -805,9 +805,9 @@ is of a CDF describing a bimodal distribution created by combining two normal di ic.full-domain.solid0.volfrac = 0.05 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = custom ic.full-domain.solid0.diameter.distribution = custom ic.full-domain.solid0.diameter.custom = bimodal-cdf.dist ic.full-domain.solid0.diameter.type = number-weighted ic.full-domain.solid0.diameter.weighting = number-weighted .. code-block:: bash :caption: Custom bimodal distribution created by combining two normal distributions Loading Loading @@ -888,9 +888,9 @@ is a CDF describing an experimentally measured size distribution and the distrib ic.full-domain.solid0.volfrac = 0.05 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = custom ic.full-domain.solid0.diameter.distribution = custom ic.full-domain.solid0.diameter.custom = qicpic-cdf.dist ic.full-domain.solid0.diameter.type = volume-weighted ic.full-domain.solid0.diameter.weighting = volume-weighted .. code-block:: bash Loading docs/source_docs/user_guide/inputs/boundary_conditions.rst +58 −32 Changes for docs/source_docs/user_guide/inputs/boundary_conditions.rst: 58 added lines, 32 removed lines. Original line number Diff line number Diff line Loading @@ -14,8 +14,8 @@ The following inputs are defined using the prefix ``bc``: +=====================+==========================================================================+=============+===========+ | regions | Regions used to define boundary conditions. Supported shapes for | Strings | None | | | mass inflow, pressure inflow, and pressure outflow include ``plane`` | | | | | and ``disk``. Embedded‑boundary regions support ``box``, ``cylinder``, | | | | | and ``sphere`` shapes. | | | | | and ``disk``. Embedded boundary (EB) regions support ``box``, | | | | |``cylinder``, and ``sphere`` shapes. | | | +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | | | should also be periodic. | | | Loading Loading @@ -144,9 +144,7 @@ For each inflow boundary condition region, general solids inputs are defined usi Mass inflow boundary conditions, ``bc.[region_name] = mi``, only support PIC parcels. EB inflow boundary conditions, ``bc.[region_name] = eb``, support DEM particles and PIC parcels. For inflow boundary conditions , the solid inputs are defined using the prefix ``bc.[region_name].[solid_name]``: Note that diameter distributions must define a weighting type, please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistributions>`. For inflow boundary conditions , the solids inputs are defined using the prefix ``bc.[region_name].[solid_name]``: +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | Loading @@ -163,70 +161,98 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | massflow | Mass flow rate. | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter | Method to specify particle diameter in the IC region. This is | String | None | | | only used for auto-generated particles. | | | For inflow boundary conditions, diameter and density distributions can be specified.. The following inputs control the diameter distribution and are defined with the prefix ``bc.[region_name].[solid_name].diameter``: Note that diameter distributions must define a weighting type, please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistributions>`. +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +========================+=======================================================================+=============+===========+ | distribution | Type of distribution for particle diameter in the BC region. This is | String | None | | | only used for inflow boundary conditions. | | | | | | | | | | Options: | | | | | | | | | | * ``constant`` - specified constant | | | | | * ``uniform`` - uniform distribution | | | | | * ``normal`` - normal distribution | | | | | * ``log-normal`` - log-noremal distribution | | | | | * ``custom`` - user-defined distribution | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | type | Distribution weighting. | String | N/A | | weighting | Weighting for diameter distribution. | String | N/A | | | | | | | | Options: | | | | | | | | | | * ``number-weighted`` | | | | | * ``volume-weighted`` | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | bins | Number of bins used when discretizing the distribution to approximate | Int | 64 | | | the number of particles within an initial condition region. | | | | bins | Number of bins used when discretizing the diameter distribution to | Int | 64 | | | approximate the number of particles within a boundary condition | | | | | region. | | | | | | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter.constant | Monodisperse (single valued) particle diameter. | Real | 0 | | constant | Monodisperse (single valued) particle diameter. | Real | 0 | | | Required for ``constant`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter.mean | Distribution mean. | Real | 0 | | | Required for ``normal`` distributions. | | | | mean | Distribution mean. | Real | 0 | | | Required for ``normal`` and ``log-normal`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter.std | Distribution standard deviation. | Real | 0 | | | Required for ``normal`` distributions. | | | | std | Distribution standard deviation. | Real | 0 | | | Required for ``normal`` and ``log-normal`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter.min | Minimum diameter to clip distribution. | Real | 0 | | | Required for ``normal`` distributions and ``uniform`` distributions. | | | | min | Minimum diameter to clip distribution. | Real | 0 | | | Required for ``normal``, ``log-normal``, and ``uniform`` | | | | | distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter.max | Maximum diameter to clip distribution. | Real | 0 | | | Required for ``normal`` distributions and ``uniform`` distributions. | | | | max | Maximum diameter to clip distribution. | Real | 0 | | | Required for ``normal``, ``log-normal``, and ``uniform`` | | | | | distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter.custom | File name that specifies either the cumulative or probability | String | None | | custom | File name that specifies either the cumulative or probability | String | None | | | distribution. Required for ``custom`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | density | Method to specify particle density in the IC region. This is | String | None | | | only used for auto-generated particles. | | | The following inputs control the density distribution and are defined with the prefix ``bc.[region_name].[solid_name].density``: +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +========================+=======================================================================+=============+===========+ | distribution | Type of distribution for particle density in the BC region. This is | String | None | | | only used for inflow boundary conditions. | | | | | | | | | | Options: | | | | | | | | | | * ``constant`` - specified constant | | | | | * ``uniform`` - uniform distribution | | | | | * ``normal`` - normal distribution | | | | | * ``log-normal`` - log-noremal distribution | | | | | * ``custom`` - user-defined distribution | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | density.constant | Monodisperse (single valued) particle density. | Real | 0 | | constant | Monodisperse (single valued) particle diameter. | Real | 0 | | | Required for ``constant`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | density.mean | Distribution mean. | Real | 0 | | | Required for ``normal`` distributions. | | | | mean | Distribution mean. | Real | 0 | | | Required for ``normal`` and ``log-normal`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | density.std | Distribution standard deviation. | Real | 0 | | | Required for ``normal`` distributions. | | | | std | Distribution standard deviation. | Real | 0 | | | Required for ``normal`` and ``log-normal`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | density.min | Minimum diameter to clip distribution. | Real | 0 | | | Required for ``normal`` distributions and ``uniform`` distributions. | | | | min | Minimum density to clip distribution. | Real | 0 | | | Required for ``normal``, ``log-normal``, and ``uniform`` | | | | | distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | density.max | Maximum diameter to clip distribution. | Real | 0 | | | Required for ``normal`` distributions and ``uniform`` distributions. | | | | max | Maximum density to clip distribution. | Real | 0 | | | Required for ``normal``, ``log-normal``, and ``uniform`` | | | | | distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | density.custom | File name that specifies either the cumulative or probability | String | None | | custom | File name that specifies either the cumulative or probability | String | None | | | distribution. Required for ``custom`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading docs/source_docs/user_guide/inputs/chemical_reactions.rst +2 −2 Changes for docs/source_docs/user_guide/inputs/chemical_reactions.rst: 2 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -313,8 +313,8 @@ to chemical reactions. ic.full-domain.solid0.volfrac = 0.275 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = constant ic.full-domain.solid0.density = constant ic.full-domain.solid0.diameter.distribution = constant ic.full-domain.solid0.density.distribution = constant ic.full-domain.solid0.diameter.constant = 100.0e-6 ic.full-domain.solid0.density.constant = 2000.0 Loading docs/source_docs/user_guide/inputs/initial_conditions.rst +58 −32 File changed.Preview size limit exceeded, changes collapsed. Show changes Loading
Makefile 0 → 100644 +13 −0 Changes for Makefile: 13 added lines, 0 removed lines. Original line number Diff line number Diff line SPHINXBUILD = sphinx-build SOURCEDIR = docs/source_docs/ BUILDDIR = build html: $(SPHINXBUILD) -b html $(SOURCEDIR) $(BUILDDIR)/html pdf: $(SPHINXBUILD) -b latex $(SOURCEDIR) $(BUILDDIR)/latex cd $(BUILDDIR)/latex && make clean: rm -rf $(BUILDDIR)
docs/source_docs/references/size_distributions.rst +26 −26 Changes for docs/source_docs/references/size_distributions.rst: 26 added lines, 26 removed lines. Original line number Diff line number Diff line Loading @@ -27,7 +27,7 @@ Volume-weighted diameter distribution Number-weighted and volume-weighted distributions are not interchangeable. Failing to specify the correct distribution weighting can result in unexpected behavior. MFIX uses both distribution weightings, computing (or approximating) Internally, MFIX uses both distribution weightings, computing (or approximating) whichever distribution weighting that was not provided. For example, if a number-weighted normal distribution is provided, the corresponding volume-weighted normal distribution is computed. The volume-weighted distribution is used to calculate Loading Loading @@ -88,15 +88,15 @@ density. The initial condition region volume is 0.001 m\ :sup:`3`, and it has a ic.full-domain.solid0.volfrac = 0.05 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = constant ic.full-domain.solid0.diameter.distribution = constant ic.full-domain.solid0.diameter.constant = 1000.e-6 # (m) ic.full-domain.solid0.density = constant ic.full-domain.solid0.density.distribution = constant ic.full-domain.solid0.density.constant = 2500.0 # (kg/m^3) An MFIX-Exa DEM simulation generates approximately 95,500 particles, while a PIC simulation with ``pic.close_pack = 0.64``, ``pic.parcels_per_cell_at_pack = 64``, and an Eulerian mesh spacing :math:`\Delta x` of 3.125 mm generates approximately 164,000 parcels. With these settings, an MFIX-Exa DEM simulation generates approximately 95,500 particles, while a PIC simulation with ``pic.close_pack = 0.64``, ``pic.parcels_per_cell_at_pack = 64``, and an Eulerian mesh spacing :math:`\Delta x` of 3.125 mm generates approximately 164,000 parcels. ``normal`` distribution Loading @@ -115,7 +115,7 @@ used to specify the distribution are provided in the following table. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | type | distribution weighting: ``number-weighted`` or ``volume-weighted`` | string | N/A | | weighting | distribution weighting: ``number-weighted`` or ``volume-weighted`` | string | N/A | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | mean | mean of the normal random variable, :math:`X` | Real | N/A | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading Loading @@ -167,14 +167,14 @@ and 1.75 mm, respectively. ic.full-domain.solid0.volfrac = 0.05 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = normal ic.full-domain.solid0.diameter.type = number-weighted ic.full-domain.solid0.diameter.distribution = normal ic.full-domain.solid0.diameter.weighting = number-weighted ic.full-domain.solid0.diameter.mean = 1000.e-6 # (m) ic.full-domain.solid0.diameter.std = 250.e-6 # (m) ic.full-domain.solid0.diameter.min = 250.e-6 # (m) ic.full-domain.solid0.diameter.max = 1750.e-6 # (m) ic.full-domain.solid0.density = constant ic.full-domain.solid0.density.distribution = constant ic.full-domain.solid0.density.constant = 2500.0 # (kg/m^3) Loading Loading @@ -355,7 +355,7 @@ where :math:`\mu` and :math:`\sigma` are parameters defining the distribution. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | type | distribution weighting: ``number-weighted`` or ``volume-weighted`` | string | N/A | | weighting | distribution weighting: ``number-weighted`` or ``volume-weighted`` | string | N/A | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | mean | mean of of the normal random variable, | Real | N/A | | | :math:`\mathrm{ln}(X)` | | | Loading Loading @@ -409,14 +409,14 @@ and 3.00 mm, respectively. ic.full-domain.solid0.volfrac = 0.25 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = log-normal ic.full-domain.solid0.diameter.type = volume-weighted ic.full-domain.solid0.diameter.distribution = log-normal ic.full-domain.solid0.diameter.weighting = volume-weighted ic.full-domain.solid0.diameter.mean = -3.662955279 ic.full-domain.solid0.diameter.std = 1.04 ic.full-domain.solid0.diameter.min = 30.e-6 # (m) ic.full-domain.solid0.diameter.max = 3000.e-6 # (m) ic.full-domain.solid0.density = constant ic.full-domain.solid0.density.distribution = constant ic.full-domain.solid0.density.constant = 2500.0 # (kg/m^3) Loading Loading @@ -508,7 +508,7 @@ used to specify the distribution are provided in the following table. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +=====================+=======================================================================+=============+===========+ | type | distribution weighting: ``number-weighted`` or ``volume-weighted`` | string | N/A | | weighting | distribution weighting: ``number-weighted`` or ``volume-weighted`` | string | N/A | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | min | Minimum particle diameter. Drawn samples below ``min`` are discarded | Real | N/A | | | and a new sample is drawn. | | | Loading Loading @@ -554,12 +554,12 @@ The minimum and maximum particle diameters are 0.25 mm and 1.75 mm, respectively ic.full-domain.solid0.volfrac = 0.05 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = uniform ic.full-domain.solid0.diameter.type = number-weighted ic.full-domain.solid0.diameter.distribution = uniform ic.full-domain.solid0.diameter.weighting = number-weighted ic.full-domain.solid0.diameter.min = 250.e-6 # (m) ic.full-domain.solid0.diameter.max = 1750.e-6 # (m) ic.full-domain.solid0.density = constant ic.full-domain.solid0.density.distribution = constant ic.full-domain.solid0.density.constant = 2500.0 # (kg/m^3) Loading Loading @@ -766,14 +766,14 @@ distribution is a 50/50 mixture of two particle sizes. ic.full-domain.solid0.volfrac = 0.05 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = custom ic.full-domain.solid0.diameter.distribution = custom ic.full-domain.solid0.diameter.custom = bidisperse-pdf.dist ic.full-domain.solid0.diameter.type = number-weighted ic.full-domain.solid0.diameter.weighting = number-weighted ic.full-domain.solid0.density = constant ic.full-domain.solid0.density.distribution = constant ic.full-domain.solid0.density.constant = 2500.0 # (kg/m^3) ic.full-domain.solid0.density = constant ic.full-domain.solid0.density.distribution = constant ic.full-domain.solid0.density.constant = 2500.0 # (kg/m^3) Loading Loading @@ -805,9 +805,9 @@ is of a CDF describing a bimodal distribution created by combining two normal di ic.full-domain.solid0.volfrac = 0.05 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = custom ic.full-domain.solid0.diameter.distribution = custom ic.full-domain.solid0.diameter.custom = bimodal-cdf.dist ic.full-domain.solid0.diameter.type = number-weighted ic.full-domain.solid0.diameter.weighting = number-weighted .. code-block:: bash :caption: Custom bimodal distribution created by combining two normal distributions Loading Loading @@ -888,9 +888,9 @@ is a CDF describing an experimentally measured size distribution and the distrib ic.full-domain.solid0.volfrac = 0.05 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = custom ic.full-domain.solid0.diameter.distribution = custom ic.full-domain.solid0.diameter.custom = qicpic-cdf.dist ic.full-domain.solid0.diameter.type = volume-weighted ic.full-domain.solid0.diameter.weighting = volume-weighted .. code-block:: bash Loading
docs/source_docs/user_guide/inputs/boundary_conditions.rst +58 −32 Changes for docs/source_docs/user_guide/inputs/boundary_conditions.rst: 58 added lines, 32 removed lines. Original line number Diff line number Diff line Loading @@ -14,8 +14,8 @@ The following inputs are defined using the prefix ``bc``: +=====================+==========================================================================+=============+===========+ | regions | Regions used to define boundary conditions. Supported shapes for | Strings | None | | | mass inflow, pressure inflow, and pressure outflow include ``plane`` | | | | | and ``disk``. Embedded‑boundary regions support ``box``, ``cylinder``, | | | | | and ``sphere`` shapes. | | | | | and ``disk``. Embedded boundary (EB) regions support ``box``, | | | | |``cylinder``, and ``sphere`` shapes. | | | +---------------------+--------------------------------------------------------------------------+-------------+-----------+ | delp_dir | Direction for specified pressure drop. Note that this direction | Int | 0 | | | should also be periodic. | | | Loading Loading @@ -144,9 +144,7 @@ For each inflow boundary condition region, general solids inputs are defined usi Mass inflow boundary conditions, ``bc.[region_name] = mi``, only support PIC parcels. EB inflow boundary conditions, ``bc.[region_name] = eb``, support DEM particles and PIC parcels. For inflow boundary conditions , the solid inputs are defined using the prefix ``bc.[region_name].[solid_name]``: Note that diameter distributions must define a weighting type, please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistributions>`. For inflow boundary conditions , the solids inputs are defined using the prefix ``bc.[region_name].[solid_name]``: +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | Loading @@ -163,70 +161,98 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | massflow | Mass flow rate. | Real | 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter | Method to specify particle diameter in the IC region. This is | String | None | | | only used for auto-generated particles. | | | For inflow boundary conditions, diameter and density distributions can be specified.. The following inputs control the diameter distribution and are defined with the prefix ``bc.[region_name].[solid_name].diameter``: Note that diameter distributions must define a weighting type, please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistributions>`. +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +========================+=======================================================================+=============+===========+ | distribution | Type of distribution for particle diameter in the BC region. This is | String | None | | | only used for inflow boundary conditions. | | | | | | | | | | Options: | | | | | | | | | | * ``constant`` - specified constant | | | | | * ``uniform`` - uniform distribution | | | | | * ``normal`` - normal distribution | | | | | * ``log-normal`` - log-noremal distribution | | | | | * ``custom`` - user-defined distribution | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | type | Distribution weighting. | String | N/A | | weighting | Weighting for diameter distribution. | String | N/A | | | | | | | | Options: | | | | | | | | | | * ``number-weighted`` | | | | | * ``volume-weighted`` | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | bins | Number of bins used when discretizing the distribution to approximate | Int | 64 | | | the number of particles within an initial condition region. | | | | bins | Number of bins used when discretizing the diameter distribution to | Int | 64 | | | approximate the number of particles within a boundary condition | | | | | region. | | | | | | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter.constant | Monodisperse (single valued) particle diameter. | Real | 0 | | constant | Monodisperse (single valued) particle diameter. | Real | 0 | | | Required for ``constant`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter.mean | Distribution mean. | Real | 0 | | | Required for ``normal`` distributions. | | | | mean | Distribution mean. | Real | 0 | | | Required for ``normal`` and ``log-normal`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter.std | Distribution standard deviation. | Real | 0 | | | Required for ``normal`` distributions. | | | | std | Distribution standard deviation. | Real | 0 | | | Required for ``normal`` and ``log-normal`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter.min | Minimum diameter to clip distribution. | Real | 0 | | | Required for ``normal`` distributions and ``uniform`` distributions. | | | | min | Minimum diameter to clip distribution. | Real | 0 | | | Required for ``normal``, ``log-normal``, and ``uniform`` | | | | | distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter.max | Maximum diameter to clip distribution. | Real | 0 | | | Required for ``normal`` distributions and ``uniform`` distributions. | | | | max | Maximum diameter to clip distribution. | Real | 0 | | | Required for ``normal``, ``log-normal``, and ``uniform`` | | | | | distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter.custom | File name that specifies either the cumulative or probability | String | None | | custom | File name that specifies either the cumulative or probability | String | None | | | distribution. Required for ``custom`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | density | Method to specify particle density in the IC region. This is | String | None | | | only used for auto-generated particles. | | | The following inputs control the density distribution and are defined with the prefix ``bc.[region_name].[solid_name].density``: +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +========================+=======================================================================+=============+===========+ | distribution | Type of distribution for particle density in the BC region. This is | String | None | | | only used for inflow boundary conditions. | | | | | | | | | | Options: | | | | | | | | | | * ``constant`` - specified constant | | | | | * ``uniform`` - uniform distribution | | | | | * ``normal`` - normal distribution | | | | | * ``log-normal`` - log-noremal distribution | | | | | * ``custom`` - user-defined distribution | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | density.constant | Monodisperse (single valued) particle density. | Real | 0 | | constant | Monodisperse (single valued) particle diameter. | Real | 0 | | | Required for ``constant`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | density.mean | Distribution mean. | Real | 0 | | | Required for ``normal`` distributions. | | | | mean | Distribution mean. | Real | 0 | | | Required for ``normal`` and ``log-normal`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | density.std | Distribution standard deviation. | Real | 0 | | | Required for ``normal`` distributions. | | | | std | Distribution standard deviation. | Real | 0 | | | Required for ``normal`` and ``log-normal`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | density.min | Minimum diameter to clip distribution. | Real | 0 | | | Required for ``normal`` distributions and ``uniform`` distributions. | | | | min | Minimum density to clip distribution. | Real | 0 | | | Required for ``normal``, ``log-normal``, and ``uniform`` | | | | | distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | density.max | Maximum diameter to clip distribution. | Real | 0 | | | Required for ``normal`` distributions and ``uniform`` distributions. | | | | max | Maximum density to clip distribution. | Real | 0 | | | Required for ``normal``, ``log-normal``, and ``uniform`` | | | | | distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | density.custom | File name that specifies either the cumulative or probability | String | None | | custom | File name that specifies either the cumulative or probability | String | None | | | distribution. Required for ``custom`` distributions. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ Loading
docs/source_docs/user_guide/inputs/chemical_reactions.rst +2 −2 Changes for docs/source_docs/user_guide/inputs/chemical_reactions.rst: 2 added lines, 2 removed lines. Original line number Diff line number Diff line Loading @@ -313,8 +313,8 @@ to chemical reactions. ic.full-domain.solid0.volfrac = 0.275 ic.full-domain.solid0.velocity = 0.00 0.00 0.00 ic.full-domain.solid0.diameter = constant ic.full-domain.solid0.density = constant ic.full-domain.solid0.diameter.distribution = constant ic.full-domain.solid0.density.distribution = constant ic.full-domain.solid0.diameter.constant = 100.0e-6 ic.full-domain.solid0.density.constant = 2000.0 Loading
docs/source_docs/user_guide/inputs/initial_conditions.rst +58 −32 File changed.Preview size limit exceeded, changes collapsed. Show changes
