:class:`DynaDEM`
================


.. py:class:: ansys.dyna.core.pre.dynadem.DynaDEM

   Bases: :py:obj:`ansys.dyna.core.pre.dynabase.DynaBase`


   
   Contains methods for creating a keyword related to a discrete element method.
















   ..
       !! processed by numpydoc !!


.. py:currentmodule:: DynaDEM

Overview
--------

.. tab-set::



   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~set_des`
            - Set global control parameters for discrete element spheres.
          * - :py:attr:`~create_define_de_mesh_surface`
            - Create discrete element sphere (DES) elements on the surface of shell elements.
          * - :py:attr:`~save_file`
            - Save keyword files.








Import detail
-------------

.. code-block:: python

    from ansys.dyna.core.pre.dynadem import DynaDEM



Method detail
-------------

.. py:method:: set_des(ndamp=0.0, tdamp=0.0, frics=0.0, fricr=0.0, normk=0.01, sheark=0.2857)

   
   Set global control parameters for discrete element spheres.


   :Parameters:

       **ndamp** : :class:`python:float`, :obj:`optional`
           Normal damping coefficient. The default is ``0.0``.

       **tdamp** : :class:`python:float`, :obj:`optional`
           Tangential damping coefficient. The default is ``0.0``.

       **frics** : :class:`python:float`, :obj:`optional`
           Static coefficient of friction. The default is ``0.0``.
           
           - EQ.0: 3 DOF
           - NE.0: 6 DOF

       **fricr** : :class:`python:float`, :obj:`optional`
           Rolling friction coefficient. The default is ``0.0``.

       **normk** : :class:`python:float`, :obj:`optional`
           Scale factor of the normal spring constant.  The default is ``0.01``.

       **sheark** : :class:`python:float`, :obj:`optional`
           Ratio between the sheark/normk. The default is ``0.2857``.



   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ``True`` when successful, ``False`` when failed.











   ..
       !! processed by numpydoc !!

.. py:method:: create_define_de_mesh_surface(sid, type, despid, desxid, nquad=1, nsid=0, rsf=1.0)

   
   Create discrete element sphere (DES) elements on the surface of shell elements.


   :Parameters:

       **sid** : :class:`python:int`
           Part or part set ID for the region of the mesh to place DES elements on.

       **type** : :class:`python:int`
           SID type:
           
           - type=0: Part set ID
           - type=1: Part ID

       **despid** : :class:`python:int`
           Part ID for the generated DES elements.

       **desxid** : :class:`python:int`
           Section ID for the generated DES elements.

       **nquad** : :class:`python:int`, :obj:`optional`
           Number of equally spaced DES elements created on a shell element in each
           local shell direction. The default is ``1``.

       **nsid** : :class:`python:int`, :obj:`optional`
           If defined, this card creates a node set with ID NSID for the nodes generated
           by this card. The default is ``0``.

       **rsf** : :class:`python:float`, :obj:`optional`
           Scale factor for determining the DES radius. The default is ``1.0``.



   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ``True`` when successful, ``False`` when failed.











   ..
       !! processed by numpydoc !!

.. py:method:: save_file()

   
   Save keyword files.





   :Returns:

       :ref:`bool <python:bltin-boolean-values>`
           ``True`` when successful, ``False`` when failed.











   ..
       !! processed by numpydoc !!