pencil.read.pdims
=================

.. py:module:: pencil.read.pdims

.. autoapi-nested-parse::

   Contains the perticle dimension class and its reading routine.



Classes
-------

.. autoapisummary::

   pencil.read.pdims.PDim


Functions
---------

.. autoapisummary::

   pencil.read.pdims.pdim


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

.. py:class:: PDim

   Bases: :py:obj:`object`


   Class holding the data from pdim.dat and its methods.

   Fill members with default values.


   .. py:attribute:: npar
      :value: 0



   .. py:attribute:: mpvar
      :value: 0



   .. py:attribute:: npar_stalk
      :value: 0



   .. py:attribute:: mpaux
      :value: 0



   .. py:method:: keys()


   .. py:method:: read(datadir='data')

      read(sim=None, datadir='data')

      Read the pdim.dat file.

      :param sim: Specifies the simulation object from which to obtain the datadir.
      :type sim: obj
      :param datadir: Directory where the data is stored.
      :type datadir: string

      :rtype: Object containing the particle dimensions.



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

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