.. ############################################################################
.. manual/packages/vertex-cfd/restart.rst
.. ############################################################################

.. _sec_restart:

***********************
Write Restart block
***********************
      
.. literalinclude:: ../xml-blocks/restart.xml
   :language: xml
   :lines: 1-5
   :caption: `Write Restart` block in XML input file.

.. py:data:: Write Restart

  :type: bool
  :value: true or false
  :usage: Required
  :description: Controls whether or not restart files are being written while running the simulation..
      
.. py:data:: Restart File Prefix

  :type: string
  :value: Prefix of the restart file
  :usage: Required
  :description: Set the prefix to use for file names of restart files (prefix_xxx.data and prefix_xxx.dofmap).

.. py:data:: Restart Write Frequency

  :type: integer
  :value: :math:`[0;\infty]`
  :usage: Required
  :description: Write frequency of the restart files.  

.. literalinclude:: ../../../../examples/inputs/incompressible/incompressible_2d_k_tau_channel.xml
   :language: xml
   :linenos:
   :lines: 34-36

***********************
Read Restart block
***********************
      
.. literalinclude:: ../xml-blocks/restart.xml
   :language: xml
   :lines: 7-11
   :caption: `Read Restart` block in XML input file.

.. py:data:: Read Restart

  :type: bool
  :value: true or false
  :usage: Required
  :description: Controls whether or not to read restart files to start the simulation.

.. py:data:: Restart Data File Name

  :type: string
  :value: data file name
  :usage: Required
  :description: data file to use to restart the numerical solution.

.. py:data:: Restart DOF Map File Name

  :type: string
  :value: dofmap file name
  :usage: Required
  :description: dofmap file to use to restart the numerical solution.

.. literalinclude:: ../../../../examples/inputs/incompressible/incompressible_2d_k_tau_channel.xml
   :language: xml
   :linenos:
   :lines: 40-42