pencil.visu.box3d
=================

.. py:module:: pencil.visu.box3d

.. autoapi-nested-parse::

   Contains the classes and methods to read the slice files,
   generate box plot and an animation with the simulation box.



Classes
-------

.. autoapisummary::

   pencil.visu.box3d.Box3d


Functions
---------

.. autoapisummary::

   pencil.visu.box3d.box3d


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

.. py:function:: box3d(slices=None)

   Plot the given slices as a 3d box.

   call signature:

   box3d()

   Keyword arguments:

   *slices*:
     A list of 3 or 4 slices, i.e. 2d arrays of shape [m, n].
     The first slices is the top, then left, right and bottom.


.. py:class:: Box3d

   Bases: :py:obj:`object`


   Box plotting class in 3d.

   Fill members with default values.


   .. py:attribute:: slices
      :value: None



   .. py:attribute:: axes
      :value: True



   .. py:attribute:: font_size
      :value: 24



   .. py:attribute:: font_family
      :value: 'arial'



   .. py:attribute:: title
      :value: ''



   .. py:attribute:: colorbar
      :value: True



   .. py:attribute:: colormap
      :value: 'binary'



   .. py:attribute:: colorbar_label
      :value: 'u_x'



   .. py:attribute:: xlabel
      :value: '$x$'



   .. py:attribute:: ylabel
      :value: '$y$'



   .. py:attribute:: zlabel
      :value: '$z$'



   .. py:attribute:: vmin
      :value: None



   .. py:attribute:: vmax
      :value: None



   .. py:method:: plot()

      Plot the 3d box.