Update docs (exa/docs!179) (7151905b) · Commits · exa / docs

docs/source_docs/references/size_distributions.rst

+2 −2

Changes for docs/source_docs/references/size_distributions.rst: 2 added lines, 2 removed lines.
Original line number	Diff line number	Diff line
		@@ -707,7 +707,7 @@ A user-defined ``custom`` distribution can be specified by providing discrete pr
		+---------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| \| Description \| Type \| Default \|
		+=====================+=======================================================================+=============+===========+
		\| custom \| File name of user-defined distribution \| string \| N/A \|
		\| custom \| File name of user-defined distribution \| String \| N/A \|
		+---------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| min \| Minimum particle diameter. Drawn samples below ``min`` are discarded \| Real \| N/A \|
		\| \| and a new sample is drawn. \| \| \|
		@@ -715,7 +715,7 @@ A user-defined ``custom`` distribution can be specified by providing discrete pr
		\| max \| Maximum particle diameter. Drawn samples above ``max`` are discarded \| Real \| N/A \|
		\| \| and a new sample is drawn. \| \| \|
		+---------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| interpolate \| Enable linear interpolation between discrete bins. This option is \| bool \| false \|
		\| interpolate \| Enable linear interpolation between discrete bins. This option is \| Bool \| false \|
		\| \| only available when the initial distribution probability is zero. \| \| \|
		+---------------------+-----------------------------------------------------------------------+-------------+-----------+

docs/source_docs/user_guide/inputs/boundary_conditions.rst

+10 −2

Changes for docs/source_docs/user_guide/inputs/boundary_conditions.rst: 10 added lines, 2 removed lines.
Original line number	Diff line number	Diff line
		@@ -195,7 +195,6 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut
		\| bins \| Number of bins used when discretizing the diameter distribution to \| Int \| 64 \|
		\| \| approximate the number of particles within a boundary condition \| \| \|
		\| \| region. \| \| \|
		\| \| \| \| \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| constant \| Monodisperse (single valued) particle diameter. \| Real \| 0 \|
		\| \| Required for ``constant`` distributions. \| \| \|
		@@ -217,6 +216,11 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut
		\| custom \| File name that specifies either the cumulative or probability \| String \| None \|
		\| \| distribution. Required for ``custom`` distributions. \| \| \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| interpolate \| For ``custom`` distributions, enable linear interpolation between \| Bool \| false \|
		\| \| discrete bins. This option is only available when the initial \| \| \|
		\| \| distribution probability is zero. \| \| \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+



		The following inputs control the density distribution and are defined with
		@@ -256,6 +260,10 @@ the prefix ``bc.[region_name].[solid_name].density``:
		\| custom \| File name that specifies either the cumulative or probability \| String \| None \|
		\| \| distribution. Required for ``custom`` distributions. \| \| \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| interpolate \| For ``custom`` distributions, enable linear interpolation between \| Bool \| false \|
		\| \| discrete bins. This option is only available when the initial \| \| \|
		\| \| distribution probability is zero. \| \| \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+


		Transient boundary conditions
		@@ -406,7 +414,7 @@ Below is an example for specifying a constant temperature boundary condition in

		.. code-block:: none

		bc.regions = hot-wall
		bc.regions = hot-walls

		bc.hot-walls = eb
		bc.hot-walls.eb.temperature = constant

docs/source_docs/user_guide/inputs/fluid_model.rst

+1 −1

Changes for docs/source_docs/user_guide/inputs/fluid_model.rst: 1 added line, 1 removed line.
Original line number	Diff line number	Diff line
		@@ -223,7 +223,7 @@ The following inputs are defined using the prefix ``[fluid_name]``:



		Specific Heat
		Specific heat
		-------------

		The following inputs are defined using the prefix ``[fluid_name].specific_heat``:

docs/source_docs/user_guide/inputs/initial_conditions.rst

+8 −0

Changes for docs/source_docs/user_guide/inputs/initial_conditions.rst: 8 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		@@ -139,6 +139,10 @@ please refer to :ref:`ReferenceParticleDistributions <ReferenceParticleDistribut
		\| custom \| File name that specifies either the cumulative or probability \| String \| None \|
		\| \| distribution. Required for ``custom`` distributions. \| \| \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| interpolate \| For ``custom`` distributions, enable linear interpolation between \| Bool \| false \|
		\| \| discrete bins. This option is only available when the initial \| \| \|
		\| \| distribution probability is zero. \| \| \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+


		The following inputs control the density distribution and are defined with
		@@ -178,6 +182,10 @@ the prefix ``ic.[region_name].[solid_name].density``:
		\| custom \| File name that specifies either the cumulative or probability \| String \| None \|
		\| \| distribution. Required for ``custom`` distributions. \| \| \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+
		\| interpolate \| For ``custom`` distributions, enable linear interpolation between \| Bool \| false \|
		\| \| discrete bins. This option is only available when the initial \| \| \|
		\| \| distribution probability is zero. \| \| \|
		+------------------------+-----------------------------------------------------------------------+-------------+-----------+


		The following input must be preceded by the prefix ``mfix``:

nonexistent-keys.txt

+0 −35

Changes for nonexistent-keys.txt: 0 added lines, 35 removed lines.
Original line number	Diff line number	Diff line
		bc.[region_name].[solid_name].bins
		bc.[region_name].[solid_name].density.custom
		bc.[region_name].[solid_name].density.max
		bc.[region_name].[solid_name].density.mean
		bc.[region_name].[solid_name].density.min
		bc.[region_name].[solid_name].density.std
		bc.[region_name].[solid_name].diameter
		bc.[region_name].[solid_name].diameter.constant
		bc.[region_name].[solid_name].diameter.custom
		bc.[region_name].[solid_name].diameter.max
		bc.[region_name].[solid_name].diameter.mean
		bc.[region_name].[solid_name].diameter.min
		bc.[region_name].[solid_name].diameter.std
		bc.[region_name].[solid_name].massflow
		bc.[region_name].[solid_name].type
		ic.[region_name].[solid_name].bins
		ic.[region_name].[solid_name].type

		mac_proj.bottom_maxiter
		mac_proj.bottom_verbose
		mac_proj.maxiter
		mac_proj.verbose
		mfix.deposition_diffusion_coeff
		mfix.plt_T_p
		mfix.plt_drag_p
		mfix.plt_omega_p
		mfix.plt_phase
		mfix.plt_radius
		mfix.plt_ro_p
		mfix.plt_statwt
		mfix.plt_vel_p
		mfix.solids.[region_name].plt_cp_s
		mfix.solids.[region_name].plt_h_s_txfr
		mfix.solids.[region_name].plt_mass
		@@ -36,8 +6,3 @@ mfix.solids.[region_name].plt_mass_sn_txfr
		mfix.solids.[region_name].plt_omoi
		mfix.solids.[region_name].plt_vel_s_txfr
		mfix.solids.[region_name].plt_volume
		No newline at end of file
		mfix.use_drag_coeff_in_proj_gp
		nodal_proj.bottom_maxiter
		nodal_proj.bottom_verbose
		nodal_proj.maxiter
		nodal_proj.verbose