pencil.math.vector_multiplication
=================================

.. py:module:: pencil.math.vector_multiplication

.. autoapi-nested-parse::

   Contains the methods for the dot products and cross product.



Functions
---------

.. autoapisummary::

   pencil.math.vector_multiplication.dot
   pencil.math.vector_multiplication.dot2
   pencil.math.vector_multiplication.cross


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

.. py:function:: dot(a, b)

   dot(a, b)

   Take dot product of two pencil-code vectors a and b.

   :param a: Pencil-code vectors with shape [3, mz, my, mx].
   :type a: ndarrays
   :param b: Pencil-code vectors with shape [3, mz, my, mx].
   :type b: ndarrays


.. py:function:: dot2(a)

   dot2(a)

   Take dot product of a pencil-code vector with itself.

   :param a: Pencil-code vector with shape [3, mz, my, mx].
   :type a: ndarray


.. py:function:: cross(a, b)

   cross(a, b)

   Take cross of two pencil-code vectors a and b.

   :param a: Pencil-code vectors with shape [3, mz, my, mx].
   :type a: ndarrays
   :param b: Pencil-code vectors with shape [3, mz, my, mx].
   :type b: ndarrays