pencil.calc.Reynolds
====================

.. py:module:: pencil.calc.Reynolds

.. autoapi-nested-parse::

   Calculate the Reynolds number fields from the momentum and induction
   equations using the ratio of advective to diffusive expressions.



Functions
---------

.. autoapisummary::

   pencil.calc.Reynolds.fluid_reynolds
   pencil.calc.Reynolds.magnetic_reynolds


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

.. py:function:: fluid_reynolds(uu, param, grid, lnrho=list(), shock=list(), nghost=3, lmix=True, quiet=True)

   Computes the fluid Reynolds number from the advective and effective
   viscous expressions in the momentum equation.

   call signature:

   fluid_reynolds(uu, ivisc, grid, rho=None, shock=None, nghost=3)

   :keyword \*uu*: The velocity field [3,mz,my,mx] from the simulation data
   :keyword \*param*: The Param simulation object with viscosity data information
   :keyword \*grid*: The Grid simulation object
   :keyword \*lnrho*: The log density field if it is non-uniform
   :keyword \*shock*: The shock variable if shock viscosity is applied
   :keyword \*nghost*: The number of ghost zones appropriate to the order of accuracy
   :keyword \*lmix*: Option not to include hyper values when Laplacian values present


.. py:function:: magnetic_reynolds(uu, param, grid, aa=list(), bb=list(), jj=list(), nghost=3, lmix=True, quiet=True)

   Computes the magnetic Reynolds number from the advective and effective
   resistive expressions in the induction equation.

   call signature:

   magnetic_reynolds(uu, param, grid, aa=None, bb=None, jj=None, nghost=3):

   :keyword \*uu*: The velocity field [3,mz,my,mx] from the simulation data
   :keyword \*param*: The Param simulation object with resistivity data information
   :keyword \*grid*: The Grid simulation object
   :keyword \*aa*: The vector potential if bb is not present or hyper diffusion
   :keyword \*bb*: The magnetic field
   :keyword \*jj*: The current density field
   :keyword \*nghost*: The number of ghost zones appropriate to the order of accuracy
   :keyword \*lmix*: Option not to include hyper values when Laplacian values present