.. _VASPPoscarFormat:

vasp/contcar format
===================

vasp/poscar format
==================

contcar format
==============

poscar format
=============

Class: :class:`VASPPoscarFormat <dpdata.plugins.vasp.VASPPoscarFormat>`

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

.. _VASPPoscarFormat_from_system:

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

.. py:function:: dpdata.System(file_name: 'FileType', fmt: Literal['vasp/contcar'] = None) -> dpdata.system.System
   :noindex:
.. py:function:: dpdata.System(file_name: 'FileType', fmt: Literal['vasp/poscar'] = None) -> dpdata.system.System
   :noindex:
.. py:function:: dpdata.System(file_name: 'FileType', fmt: Literal['contcar'] = None) -> dpdata.system.System
   :noindex:
.. py:function:: dpdata.System(file_name: 'FileType', fmt: Literal['poscar'] = None) -> dpdata.system.System
   :noindex:
.. py:function:: dpdata.System.from_vasp_contcar(file_name: 'FileType') -> dpdata.system.System
   :noindex:
.. py:function:: dpdata.System.from_vasp_poscar(file_name: 'FileType') -> dpdata.system.System
   :noindex:
.. py:function:: dpdata.System.from_contcar(file_name: 'FileType') -> dpdata.system.System
   :noindex:
.. py:function:: dpdata.System.from_poscar(file_name: 'FileType') -> dpdata.system.System
   :noindex:

   
Convert this format to :class:`System`.





:Returns:

    System
        converted system















.. _VASPPoscarFormat_to_system:

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

.. py:function:: dpdata.System.to(fmt: Literal['vasp/contcar'], file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.System.to(fmt: Literal['vasp/contcar'], file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.System.to(fmt: Literal['vasp/contcar'], file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.System.to(fmt: Literal['vasp/contcar'], file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.System.to_vasp_contcar(file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.System.to_vasp_poscar(file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.System.to_contcar(file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.System.to_poscar(file_name: 'FileType', frame_idx=0)
   :noindex:

   
Dump the system in vasp POSCAR format.


:Parameters:

    **file_name** : str
        The output file name

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


















.. _VASPPoscarFormat_to_labeled_system:

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

.. py:function:: dpdata.LabeledSystem.to(fmt: Literal['vasp/contcar'], file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.LabeledSystem.to(fmt: Literal['vasp/contcar'], file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.LabeledSystem.to(fmt: Literal['vasp/contcar'], file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.LabeledSystem.to(fmt: Literal['vasp/contcar'], file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.LabeledSystem.to_vasp_contcar(file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.LabeledSystem.to_vasp_poscar(file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.LabeledSystem.to_contcar(file_name: 'FileType', frame_idx=0)
   :noindex:
.. py:function:: dpdata.LabeledSystem.to_poscar(file_name: 'FileType', frame_idx=0)
   :noindex:

   
Dump the system in vasp POSCAR format.


:Parameters:

    **file_name** : str
        The output file name

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