Commit ed2ceed5 authored by Charles G Waldman's avatar Charles G Waldman
Browse files

update docs (exa/docs!151)

parent 9ee55786

docs/source_docs/user_guide/inputs/output/plotting.rst

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

docs/source_docs/user_guide/inputs/solids_model.rst

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

undocumented-keys.txt

+0 −14
Original line number Diff line number Diff line
@@ -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