.. comflow documentation master file, created by
   sphinx-quickstart on Sun Oct 30 09:11:20 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

#################################################
Program documentation
#################################################

.. note::

    This documentation is fully based on the new XML input format.
    Important information about porting legacy input files ``comflow.in`` to the new XML-based input format ``comflow.cfi`` is given in :numref:`Chapter %s <fixed_form_input>`.

..  hint::

    The documentation is categorized by program functionality. In order to get more information about a specific XML key or
    attribute in the input file, use the search function of the documentation pages. For example, to learn more about the XML attribute ``numerical/linear_solver/@solver_choice``, search for ``solver_choice``.

**Table of contents**

.. toctree::
   :maxdepth: 2
   :numbered:

   intro
   mathnum
   installation
   commandline
   preprocessing
   moving_reference_frame
   localrefinement
   convection_diffusion
   volume_of_fluid
   waves
   boundary_conditions
   movingobject
   xmfmooring
   two_phase_flow
   initialization
   time_integration
   linear_solver
   parallelization
   postprocessing
   paraview
   rhino_plugins
   python
   restarts
   guidelines
   library
   specialsolutions
   xmldocumentation
   fixedforminput
   fileformats

..
   workflow
   coupling




Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`