From 6a1636a41428bfcf6d54c13deab0818966c4e4af Mon Sep 17 00:00:00 2001 From: "robbberto88@gmail.com" <robbberto88@gmail.com> Date: Mon, 23 May 2022 16:49:17 -0400 Subject: [PATCH] add documentation about solids regions plot filters --- .../source/inputs/InputsProblemDefinition.rst | 34 +++++++++++-------- 1 file changed, 19 insertions(+), 15 deletions(-) diff --git a/docs/source/inputs/InputsProblemDefinition.rst b/docs/source/inputs/InputsProblemDefinition.rst index e4b5a26..b579259 100644 --- a/docs/source/inputs/InputsProblemDefinition.rst +++ b/docs/source/inputs/InputsProblemDefinition.rst @@ -301,21 +301,25 @@ Solids model settings --------------------- Enabling the SOLIDS solver and specifying options common to both DEM and PIC -models. - -+------------------------------+----------------------------------------------------------+----------+----------+ -| | Description | Type | Default | -+==============================+==========================================================+==========+==========+ -| solids.types | Specified name(s) of the SOLIDS types or None to disable | String | None | -| | the SOLIDS solver. The user defined names are used to | | | -| | specify DEM and/or PIC model inputs. | | | -+------------------------------+----------------------------------------------------------+----------+----------+ -| newton_solver.absolute_tol | Define absolute tolerance for Damped-Newton solver | Real | 1.e-6 | -+------------------------------+----------------------------------------------------------+----------+----------+ -| newton_solver.relative_tol | Define relative tolerance for Damped-Newton solver | Real | 1.e-6 | -+------------------------------+----------------------------------------------------------+----------+----------+ -| newton_solver.max_iterations | Define max number of iterations for Damped-Newton solver | int | 100 | -+------------------------------+----------------------------------------------------------+----------+----------+ +models. The following inputs must be preceded by the "solids." root + ++------------------------------+-------------------------------------------------------------+----------+----------+ +| | Description | Type | Default | ++==============================+=============================================================+==========+==========+ +| types | Specified name(s) of the SOLIDS types or None to disable | String | None | +| | the SOLIDS solver. The user defined names are used to | | | +| | specify DEM and/or PIC model inputs. | | | ++------------------------------+-------------------------------------------------------------+----------+----------+ +| newton_solver.absolute_tol | Define absolute tolerance for Damped-Newton solver | Real | 1.e-6 | ++------------------------------+-------------------------------------------------------------+----------+----------+ +| newton_solver.relative_tol | Define relative tolerance for Damped-Newton solver | Real | 1.e-6 | ++------------------------------+-------------------------------------------------------------+----------+----------+ +| newton_solver.max_iterations | Define max number of iterations for Damped-Newton solver | int | 100 | ++------------------------------+-------------------------------------------------------------+----------+----------+ +| plot_regions | This input helps setting which regions to use for filtering | String | None | +| | solids data by plotting only those particles that reside | | | +| | in the specified regions | | | ++------------------------------+-------------------------------------------------------------+----------+----------+ The following inputs define the single solids properties. -- GitLab