pencil.read.dims
================

.. py:module:: pencil.read.dims

.. autoapi-nested-parse::

   Contains the classes and methods to read the simulation dimensions.



Classes
-------

.. autoapisummary::

   pencil.read.dims.Dim


Functions
---------

.. autoapisummary::

   pencil.read.dims.dim


Module Contents
---------------

.. py:class:: Dim

   Bases: :py:obj:`object`


   Dim -- holds pencil code dimension data.

   Fill members with default values.


   .. py:attribute:: mvar
      :value: 0



   .. py:attribute:: maux
      :value: 0



   .. py:attribute:: mglobal
      :value: 0



   .. py:attribute:: precision
      :value: 'S'



   .. py:attribute:: iprocz_slowest
      :value: 0



   .. py:attribute:: mw
      :value: 0



   .. py:method:: keys()


   .. py:method:: read(datadir='data', proc=-1, ogrid=False, down=False, param=None)

      dim(datadir='data', proc=-1)

      Read the dim.dat file.

      :param datadir: Directory where the data is stored.
      :type datadir: string
      :param proc: Processor to be read. If proc is -1, then read the 'global'
                   dimensions. If proc is >=0, then read the dim.dat in the
                   corresponding processor directory.
      :type proc: int
      :param down: whether to read dim_down.dat
      :type down: bool

      :rtype: Class containing the domain dimension information.



.. py:function:: dim(*args, **kwargs)

   Wrapper for :py:meth:`Dim.read`