postprocessing.utils
====================

.. py:module:: postprocessing.utils


Functions
---------

.. autoapisummary::

   postprocessing.utils.check_input_vector


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

.. py:function:: check_input_vector(var, name, check_norm=True)

   
   Function to check an input vector to ensure it is valid, and return the corresponding vector in numpy format.


   :Parameters:

       **var** : str or list
           Vector value either as a string (eg. X) or list [1 0 0].

       **name** : str
           Variable name.

       **check_norm: bool**
           Check the norm of the vector to ensure it is length one.



   :Returns:

       ndarray
           Vector of length three with the corresponding vector.











   ..
       !! processed by numpydoc !!