pencil.read.grids
=================

.. py:module:: pencil.read.grids

.. autoapi-nested-parse::

   Contains classes and methods to read the grid data.



Classes
-------

.. autoapisummary::

   pencil.read.grids.Grid


Functions
---------

.. autoapisummary::

   pencil.read.grids.grid


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

.. py:class:: Grid

   Bases: :py:obj:`object`


   Grid -- holds pencil code time grid data.

   Fill members with default values.


   .. py:attribute:: t
      :value: 0



   .. py:method:: keys()


   .. py:method:: read(datadir='data', proc=-1, quiet=True, precision='f', trim=False, param=None)

      read(datadir='data', proc=-1, quiet=True, trim=False)

      Read the grid data from the pencil code simulation.
      If proc < 0, then load all data and assemble.
      Otherwise, load grid from specified processor.

      :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'
                   grid. If proc is >=0, then read the grid.dat in the
                   corresponding processor directory.
      :type proc: int
      :param quiet: Flag for switching of output.
      :type quiet: bool
      :param trim: Cuts off the ghost points.
      :type trim: bool

      :rtype: Class containing the grid information.



   .. py:method:: restrict(irange_x, irange_y, irange_z)

      Restrict the grid arrays according to the index ranges irange_[xyz]



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

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