Commit ccef1a67 authored by William D. Fullmer's avatar William D. Fullmer Committed by Jordan Musser
Browse files

add diameter dist inputs to table of users guide section (!92)

parent 6ab89d4d

docs/source_docs/user_guide/inputs/initial_conditions.rst

+18 −4
Original line number Diff line number Diff line
@@ -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 <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