From 988e693e0780c9c0c0259273791770bbce17a1c2 Mon Sep 17 00:00:00 2001 From: wfullmer Date: Tue, 17 Sep 2024 13:01:28 -0400 Subject: [PATCH 1/2] add diameter dist inputs to table of users guide section --- .../user_guide/inputs/initial_conditions.rst | 22 +++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/initial_conditions.rst b/docs/source_docs/user_guide/inputs/initial_conditions.rst index 0af28ed..3f20fc9 100644 --- a/docs/source_docs/user_guide/inputs/initial_conditions.rst +++ b/docs/source_docs/user_guide/inputs/initial_conditions.rst @@ -73,6 +73,8 @@ using the ``ic.[region]`` compound prefix. For each initial condition region, the solid inputs are defined using the ``ic.[region].[solid]`` compound prefix. +Note that diameter distributions must define a weighting type, +please refer to :ref:`ReferenceParticleDistributions`. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | @@ -93,6 +95,11 @@ using the ``ic.[region].[solid]`` compound prefix. | | * 'normal' -- normal distribution | | | | | * 'custom' -- user defined distribution | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ +| type | distribution weighting: ``number-weighted`` or ``volume-weighted`` | string | N/A | ++---------------------+-----------------------------------------------------------------------+-------------+-----------+ +| bins | Number of bins used when discretizing the distribution to approximate | int | 64 | +| | the number of particles within an initial condition region. | | | ++---------------------+-----------------------------------------------------------------------+-------------+-----------+ | diameter.constant | Monodisperse (single valued) particle diameter. | Real | 0 | | | Required for ``constant`` distributions. | | | +---------------------+-----------------------------------------------------------------------+-------------+-----------+ @@ -209,8 +216,15 @@ 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 = constant - ic.bed1.solid0.diameter.constant = 110.0e-6 - ic.bed1.solid0.density = constant - ic.bed1.solid0.density.constant = 900.0 + ic.bed1.solid0.diameter = uniform + ic.bed1.solid0.diameter.type = 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.mean = 900.0 + ic.bed1.solid0.density.std = 30.0 + ic.bed1.solid0.density.min = 800.0 + ic.bed1.solid0.density.max = 1000.0 -- GitLab From 7423c3f680c8b71b53dc2b7356cf35b6ab445793 Mon Sep 17 00:00:00 2001 From: wfullmer Date: Tue, 17 Sep 2024 13:32:22 -0400 Subject: [PATCH 2/2] fix hyper ref --- docs/source_docs/user_guide/inputs/initial_conditions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source_docs/user_guide/inputs/initial_conditions.rst b/docs/source_docs/user_guide/inputs/initial_conditions.rst index 3f20fc9..12195a9 100644 --- a/docs/source_docs/user_guide/inputs/initial_conditions.rst +++ b/docs/source_docs/user_guide/inputs/initial_conditions.rst @@ -74,7 +74,7 @@ using the ``ic.[region]`` compound prefix. For each initial condition region, the solid inputs are defined using the ``ic.[region].[solid]`` compound prefix. Note that diameter distributions must define a weighting type, -please refer to :ref:`ReferenceParticleDistributions`. +please refer to :ref:`ReferenceParticleDistributions `. +---------------------+-----------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | -- GitLab