Loading docs/source_docs/user_guide/inputs/solids_model.rst +14 −14 Original line number Diff line number Diff line Loading @@ -64,43 +64,43 @@ DEM model settings .. |RollingFricModelB| replace:: :math:`\boldsymbol{\tau}_{ij}^{(r)} = -\mu_{r}\hat{r}_{ij} \left| f_{ij}^{(n)} \right| \boldsymbol{u}_{ij}^{\omega}` Enabling the DEM solver and specifying model options. Enabling the DEM solver and specifying model options. The following keys must be defined with the prefix ``dem``: +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | | Description | Type | Default | +===============================+=========================================================================+==========+===========+ | dem.solve | Specified name(s) of the DEM types or None to disable the DEM solver. | String | None | | solve | Specified name(s) of the DEM types or None to disable the DEM solver. | String | None | | | The user defined names are used to specify DEM model inputs. | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.friction_coeff.pp | Friction coefficient :: particle to particle collisions [required] | Real | 0 | | friction_coeff.pp | Friction coefficient :: particle to particle collisions [required] | Real | 0 | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.friction_coeff.pw | Friction coefficient :: particle to wall collisions [required] | Real | 0 | | friction_coeff.pw | Friction coefficient :: particle to wall collisions [required] | Real | 0 | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.spring_const.pp | Normal spring constant :: particle to particle collisions [required] | Real | 0 | | spring_const.pp | Normal spring constant :: particle to particle collisions [required] | Real | 0 | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.spring_const.pw | Normal spring constant :: particle to wall collisions [required] | Real | 0 | | spring_const.pw | Normal spring constant :: particle to wall collisions [required] | Real | 0 | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.spring_tang_fac.pp | Tangential-to-normal spring constant factor :: particle to particle | Real | 0.2857 | | spring_tang_fac.pp | Tangential-to-normal spring constant factor :: particle to particle | Real | 0.2857 | | | collisions | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.spring_tang_fac.pw | Tangential-to-normal spring constant factor :: particle to wall | Real | 0.2857 | | spring_tang_fac.pw | Tangential-to-normal spring constant factor :: particle to wall | Real | 0.2857 | | | collisions | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.damping_tang_fac.pp | Factor relating the tangential damping coefficient to the normal | Real | 0.5 | | damping_tang_fac.pp | Factor relating the tangential damping coefficient to the normal | Real | 0.5 | | | damping coefficient :: particle to particle collisions | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.damping_tang_fac.pw | Factor relating the tangential damping coefficient to the normal | Real | 0.5 | | damping_tang_fac.pw | Factor relating the tangential damping coefficient to the normal | Real | 0.5 | | | damping coefficient :: particle to wall collisions | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.implicit_drag | Apply fluid-particle drag force by | int | 0 | | implicit_drag | Apply fluid-particle drag force by | int | 0 | | | :ref:`implicit velocity update<InputsDEMImplicitDrag>`. | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.tan_history | Include tangential history force in the collision model. | Bool | False | | tan_history | Include tangential history force in the collision model. | Bool | False | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.tan_history.max_contacts | When tangential history is enabled, the maximum number of contacts | Int | 10 | | tan_history.max_contacts | When tangential history is enabled, the maximum number of contacts | Int | 10 | | | per particle that are tracked at any point | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.rolling_friction | When tangential history is enabled, the rolling friction model | String | None | | rolling_friction | When tangential history is enabled, the rolling friction model | String | None | | | to be used. :cite:p:`zhou1999,ai2011,wensrich2012,blais2019` | | | | | | | | | | * ``None`` | | | Loading Loading
docs/source_docs/user_guide/inputs/solids_model.rst +14 −14 Original line number Diff line number Diff line Loading @@ -64,43 +64,43 @@ DEM model settings .. |RollingFricModelB| replace:: :math:`\boldsymbol{\tau}_{ij}^{(r)} = -\mu_{r}\hat{r}_{ij} \left| f_{ij}^{(n)} \right| \boldsymbol{u}_{ij}^{\omega}` Enabling the DEM solver and specifying model options. Enabling the DEM solver and specifying model options. The following keys must be defined with the prefix ``dem``: +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | | Description | Type | Default | +===============================+=========================================================================+==========+===========+ | dem.solve | Specified name(s) of the DEM types or None to disable the DEM solver. | String | None | | solve | Specified name(s) of the DEM types or None to disable the DEM solver. | String | None | | | The user defined names are used to specify DEM model inputs. | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.friction_coeff.pp | Friction coefficient :: particle to particle collisions [required] | Real | 0 | | friction_coeff.pp | Friction coefficient :: particle to particle collisions [required] | Real | 0 | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.friction_coeff.pw | Friction coefficient :: particle to wall collisions [required] | Real | 0 | | friction_coeff.pw | Friction coefficient :: particle to wall collisions [required] | Real | 0 | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.spring_const.pp | Normal spring constant :: particle to particle collisions [required] | Real | 0 | | spring_const.pp | Normal spring constant :: particle to particle collisions [required] | Real | 0 | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.spring_const.pw | Normal spring constant :: particle to wall collisions [required] | Real | 0 | | spring_const.pw | Normal spring constant :: particle to wall collisions [required] | Real | 0 | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.spring_tang_fac.pp | Tangential-to-normal spring constant factor :: particle to particle | Real | 0.2857 | | spring_tang_fac.pp | Tangential-to-normal spring constant factor :: particle to particle | Real | 0.2857 | | | collisions | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.spring_tang_fac.pw | Tangential-to-normal spring constant factor :: particle to wall | Real | 0.2857 | | spring_tang_fac.pw | Tangential-to-normal spring constant factor :: particle to wall | Real | 0.2857 | | | collisions | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.damping_tang_fac.pp | Factor relating the tangential damping coefficient to the normal | Real | 0.5 | | damping_tang_fac.pp | Factor relating the tangential damping coefficient to the normal | Real | 0.5 | | | damping coefficient :: particle to particle collisions | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.damping_tang_fac.pw | Factor relating the tangential damping coefficient to the normal | Real | 0.5 | | damping_tang_fac.pw | Factor relating the tangential damping coefficient to the normal | Real | 0.5 | | | damping coefficient :: particle to wall collisions | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.implicit_drag | Apply fluid-particle drag force by | int | 0 | | implicit_drag | Apply fluid-particle drag force by | int | 0 | | | :ref:`implicit velocity update<InputsDEMImplicitDrag>`. | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.tan_history | Include tangential history force in the collision model. | Bool | False | | tan_history | Include tangential history force in the collision model. | Bool | False | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.tan_history.max_contacts | When tangential history is enabled, the maximum number of contacts | Int | 10 | | tan_history.max_contacts | When tangential history is enabled, the maximum number of contacts | Int | 10 | | | per particle that are tracked at any point | | | +-------------------------------+-------------------------------------------------------------------------+----------+-----------+ | dem.rolling_friction | When tangential history is enabled, the rolling friction model | String | None | | rolling_friction | When tangential history is enabled, the rolling friction model | String | None | | | to be used. :cite:p:`zhou1999,ai2011,wensrich2012,blais2019` | | | | | | | | | | * ``None`` | | | Loading
