.. _LAMMPSDumpFormat:

lammps/dump format
==================

dump format
===========

Class: :class:`LAMMPSDumpFormat <dpdata.plugins.lammps.LAMMPSDumpFormat>`

Conversions
-----------

.. _LAMMPSDumpFormat_from_system:

Convert from this format to System
``````````````````````````````````

.. py:function:: dpdata.System(file_name: 'str', type_map: 'list[str]' = None, begin: 'int' = 0, step: 'int' = 1, unwrap: 'bool' = False, input_file: 'str' = None, fmt: Literal['lammps/dump'] = None) -> dpdata.system.System
   :noindex:
.. py:function:: dpdata.System(file_name: 'str', type_map: 'list[str]' = None, begin: 'int' = 0, step: 'int' = 1, unwrap: 'bool' = False, input_file: 'str' = None, fmt: Literal['dump'] = None) -> dpdata.system.System
   :noindex:
.. py:function:: dpdata.System.from_lammps_dump(file_name: 'str', type_map: 'list[str]' = None, begin: 'int' = 0, step: 'int' = 1, unwrap: 'bool' = False, input_file: 'str' = None) -> dpdata.system.System
   :noindex:
.. py:function:: dpdata.System.from_dump(file_name: 'str', type_map: 'list[str]' = None, begin: 'int' = 0, step: 'int' = 1, unwrap: 'bool' = False, input_file: 'str' = None) -> dpdata.system.System
   :noindex:

   
Read the data from a lammps dump file.


:Parameters:

    **file_name** : str
        The dump file name

    **type_map** : List[str], optional
        The atom type list

    **begin** : int, optional
        The begin step

    **step** : int, optional
        The step

    **unwrap** : bool, optional
        Whether to unwrap the coordinates

    **input_file** : str, optional
        The input file name



:Returns:

    System
        converted system















.. _LAMMPSDumpFormat_to_system:

Convert from System to this format
``````````````````````````````````

.. py:function:: dpdata.System.to(fmt: Literal['lammps/dump'], file_name: 'FileType', frame_idx=0, timestep=0)
   :noindex:
.. py:function:: dpdata.System.to(fmt: Literal['lammps/dump'], file_name: 'FileType', frame_idx=0, timestep=0)
   :noindex:
.. py:function:: dpdata.System.to_lammps_dump(file_name: 'FileType', frame_idx=0, timestep=0)
   :noindex:
.. py:function:: dpdata.System.to_dump(file_name: 'FileType', frame_idx=0, timestep=0)
   :noindex:

   
Dump the system in LAMMPS dump format.


:Parameters:

    **file_name** : str
        The output file name

    **frame_idx** : int
        The index of the frame to dump

    **timestep** : int
        The timestep number for the dump


















.. _LAMMPSDumpFormat_to_labeled_system:

Convert from LabeledSystem to this format
`````````````````````````````````````````

.. py:function:: dpdata.LabeledSystem.to(fmt: Literal['lammps/dump'], file_name: 'FileType', frame_idx=0, timestep=0)
   :noindex:
.. py:function:: dpdata.LabeledSystem.to(fmt: Literal['lammps/dump'], file_name: 'FileType', frame_idx=0, timestep=0)
   :noindex:
.. py:function:: dpdata.LabeledSystem.to_lammps_dump(file_name: 'FileType', frame_idx=0, timestep=0)
   :noindex:
.. py:function:: dpdata.LabeledSystem.to_dump(file_name: 'FileType', frame_idx=0, timestep=0)
   :noindex:

   
Dump the system in LAMMPS dump format.


:Parameters:

    **file_name** : str
        The output file name

    **frame_idx** : int
        The index of the frame to dump

    **timestep** : int
        The timestep number for the dump