From b6fffa87e0a11121f6b6a7f31f15948e69605781 Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Fri, 20 Feb 2026 09:36:30 -0600 Subject: [PATCH 1/2] update doc for distribution keys --- .../references/size_distributions.rst | 52 ++++----- .../user_guide/inputs/boundary_conditions.rst | 106 +++++++++++------- .../user_guide/inputs/chemical_reactions.rst | 4 +- .../user_guide/inputs/initial_conditions.rst | 106 +++++++++++------- 4 files changed, 160 insertions(+), 108 deletions(-) diff --git a/docs/source_docs/references/size_distributions.rst b/docs/source_docs/references/size_distributions.rst index 4cb49e9..514020e 100644 --- a/docs/source_docs/references/size_distributions.rst +++ b/docs/source_docs/references/size_distributions.rst @@ -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 @@ -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 @@ -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 | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ @@ -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) @@ -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)` | | | @@ -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) @@ -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. | | | @@ -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) @@ -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) @@ -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 @@ -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 diff --git a/docs/source_docs/user_guide/inputs/boundary_conditions.rst b/docs/source_docs/user_guide/inputs/boundary_conditions.rst index dcaf2dd..06c50f6 100644 --- a/docs/source_docs/user_guide/inputs/boundary_conditions.rst +++ b/docs/source_docs/user_guide/inputs/boundary_conditions.rst @@ -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. | | | @@ -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 `. +For inflow boundary conditions , the solids inputs are defined using the prefix ``bc.[region_name].[solid_name]``: +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | @@ -163,70 +161,98 @@ please refer to :ref:`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 | | | -| | * ``custom`` - user-defined distribution | | | +| | * ``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 | | | -| | * ``custom`` - user-defined distribution | | | +| | * ``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. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ diff --git a/docs/source_docs/user_guide/inputs/chemical_reactions.rst b/docs/source_docs/user_guide/inputs/chemical_reactions.rst index a81e6bf..5631937 100644 --- a/docs/source_docs/user_guide/inputs/chemical_reactions.rst +++ b/docs/source_docs/user_guide/inputs/chemical_reactions.rst @@ -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 diff --git a/docs/source_docs/user_guide/inputs/initial_conditions.rst b/docs/source_docs/user_guide/inputs/initial_conditions.rst index 505bff8..d831651 100644 --- a/docs/source_docs/user_guide/inputs/initial_conditions.rst +++ b/docs/source_docs/user_guide/inputs/initial_conditions.rst @@ -72,8 +72,7 @@ using the compound prefix ``ic.[region_name]``: For each initial condition region, the solid inputs are defined using the compound prefix ``ic.[region_name].[solid_name]``: -Note that diameter distributions must define a weighting type, -please refer to :ref:`ReferenceParticleDistributions `. + +------------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | @@ -86,73 +85,100 @@ please refer to :ref:`ReferenceParticleDistributions | 0 0 0 | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ -| diameter | Method to specify particle diameter in the IC region. This is | String | None | + +For automatically generated particles, diameter and density distributions can be specified. + +The following inputs control the diameter distribution and are defined with +the prefix ``ic.[region_name].[solid_name].diameter``: + +Note that diameter distributions must define a weighting type, +please refer to :ref:`ReferenceParticleDistributions `. ++------------------------+-----------------------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++========================+=======================================================================+=============+===========+ +| distribution | Type of distribution for particle diameter in the IC region. This is | String | None | | | only used for auto-generated particles. | | | | | | | | | | Options: | | | | | | | | -| | * ``constant`` - specified constant | | | -| | * ``uniform`` - uniform distribution | | | -| | * ``normal`` - normal distribution | | | -| | * ``custom`` - user-defined distribution | | | +| | * ``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 an initial 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 | + + +The following inputs control the density distribution and are defined with +the prefix ``ic.[region_name].[solid_name].density``: + ++------------------------+-----------------------------------------------------------------------+-------------+-----------+ +| | Description | Type | Default | ++========================+=======================================================================+=============+===========+ +| distribution | Type of distribution for particle density in the IC region. This is | String | None | | | only used for auto-generated particles. | | | | | | | | | | Options: | | | | | | | | -| | * ``constant`` - specified constant | | | -| | * ``uniform`` - uniform distribution | | | -| | * ``normal`` - normal distribution | | | -| | * ``custom`` - user-defined distribution | | | +| | * ``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. | | | +------------------------+-----------------------------------------------------------------------+-------------+-----------+ + The following inputs must be preceded by the prefix ``mfix``: +----------------------+-----------------------------------------------------------------------+-------------+--------------+ @@ -206,10 +232,10 @@ Below is an example for specifying an initial condition for a fluid (``fluid``) ic.bed0.my_solid0.velocity = 0.00 0.00 0.00 - ic.bed0.my_solid0.diameter = constant + ic.bed0.my_solid0.diameter.distribution = constant ic.bed0.my_solid0.diameter.constant = 100.0e-6 - ic.bed0.my_solid0.density = constant + ic.bed0.my_solid0.density.distribution = constant ic.bed0.my_solid0.density.constant = 1000.0 ic.bed1.fluid.volfrac = 0.925 @@ -231,13 +257,13 @@ Below is an example for specifying an initial condition for a fluid (``fluid``) ic.bed1.solid0.velocity = 0.10 0.00 0.00 - ic.bed1.solid0.diameter = uniform - ic.bed1.solid0.diameter.type = number-weighted + ic.bed1.solid0.diameter.distribution = uniform + ic.bed1.solid0.diameter.weighting = number-weighted ic.bed1.solid0.diameter.bins = 20 ic.bed1.solid0.diameter.min = 90.0e-6 ic.bed1.solid0.diameter.max = 110.0e-6 - ic.bed1.solid0.density = normal + ic.bed1.solid0.density.distribution = normal ic.bed1.solid0.density.mean = 900.0 ic.bed1.solid0.density.std = 30.0 ic.bed1.solid0.density.min = 800.0 -- GitLab From 8be984304a1de87ed83fa1704045332cb00351ec Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Fri, 20 Feb 2026 09:36:46 -0600 Subject: [PATCH 2/2] add Makefile --- Makefile | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 Makefile diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..20d99e7 --- /dev/null +++ b/Makefile @@ -0,0 +1,13 @@ +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) -- GitLab