pencil.read.ogdims
==================

.. py:module:: pencil.read.ogdims

.. autoapi-nested-parse::

   Contains the classes and methods to read the simulation dimensions.



Classes
-------

.. autoapisummary::

   pencil.read.ogdims.ogDim


Functions
---------

.. autoapisummary::

   pencil.read.ogdims.ogdim


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

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

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

   Read the ogdim.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

   :rtype: Class containing the simulation dimensions.


.. py:class:: ogDim

   Bases: :py:obj:`pencil.read.dims.Dim`


   ogDim -- holds pencil code dimension data.