From 4edad80a76ecf4aebaea56a3076a9c18a5045dba Mon Sep 17 00:00:00 2001 From: Charles G Waldman Date: Mon, 17 Nov 2025 19:21:20 -0600 Subject: [PATCH] update docs --- .../user_guide/inputs/output/plotting.rst | 2 +- .../source_docs/user_guide/inputs/solids_model.rst | 2 +- undocumented-keys.txt | 14 -------------- 3 files changed, 2 insertions(+), 16 deletions(-) diff --git a/docs/source_docs/user_guide/inputs/output/plotting.rst b/docs/source_docs/user_guide/inputs/output/plotting.rst index b6a2141..d408dbf 100644 --- a/docs/source_docs/user_guide/inputs/output/plotting.rst +++ b/docs/source_docs/user_guide/inputs/output/plotting.rst @@ -87,7 +87,7 @@ The following inputs must be preceded by the prefix ``mfix`` and control whether +----------------------+--------------------------------------------------------------------------+-------------+-----------+ | | Description | Type | Default | +======================+==========================================================================+=============+===========+ -| write_ls | Write a plotfile holding the level set and volfrac. | Bool | false | +| write_ls | Write a plotfile holding the level set and volume fraction. | Bool | false | | | If enabled, it will only be written once, after initialization or restart| | | +----------------------+--------------------------------------------------------------------------+-------------+-----------+ | write_eb_surface | Write out the EB geometry in vtp format. | Bool | false | diff --git a/docs/source_docs/user_guide/inputs/solids_model.rst b/docs/source_docs/user_guide/inputs/solids_model.rst index f5b3cba..aabca8b 100644 --- a/docs/source_docs/user_guide/inputs/solids_model.rst +++ b/docs/source_docs/user_guide/inputs/solids_model.rst @@ -103,7 +103,7 @@ Enabling the DEM solver and specifying model options. The following keys must b +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | | Description | Type | Default | +===============================+=========================================================================+==========+===========+ -| solve | Specified name(s) of the DEM types or None to disable the DEM solver. | Strings | "None" | +| solve | Specified name(s) of the DEM types or None to disable the DEM solver. | Strings | None | | | The user-defined names are used to specify DEM model inputs. | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | friction_coeff.pp | Friction coefficient :: particle to particle collisions [required] | Real | 0 | diff --git a/undocumented-keys.txt b/undocumented-keys.txt index 2724863..9ac9c76 100644 --- a/undocumented-keys.txt +++ b/undocumented-keys.txt @@ -88,20 +88,6 @@ mfix.test_tracer_conservation mfix.use_new_depdt_algo mfix.use_ppm particles.reduceGhostParticles -pic.advance_vel_p -pic.beta -pic.close_pack -pic.damping_factor -pic.damping_factor_wall_normal -pic.damping_factor_wall_tangent -pic.initial_step_type -pic.max_iter -pic.parcels_per_cell_at_pack -pic.pressure_coefficient -pic.small_number -pic.solve -pic.velocity_reference_frame -pic.verbose pic2dem.convert stl.internal_flow tracer -- GitLab