pencil.diag.particle.dispersion_and_drift
=========================================

.. py:module:: pencil.diag.particle.dispersion_and_drift


Functions
---------

.. autoapisummary::

   pencil.diag.particle.dispersion_and_drift.dispersion_and_drift


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

.. py:function:: dispersion_and_drift(sim=False, OVERWRITE=False, GLOBAL=True, LOCAL=True, use_IDL=False, recalculate_gas_velo_at_particle_pos=False)

   This calculates the dispersion (sigma) and drift (zeta) locally and globally
   by using the gas_velo_at_particle_pos script and dataset for all particles.

   With sigma = sqrt( 1/N_par * sum_i^N_par( (v_par(i) - <v_par>)^2 ) ) and
   zeta = sqrt( 1/N_par * sum_i^N_par( (v_par(i) - u(xp_i))^2 ) )

   Arg:
         OVERWRITE:            set to True to overwrite already calculated results
     GLOBAL:         Calculate drift and dispersion globally, i.e. whole simulation domain
     LOCAL:          Calculate drift and dispersion locally, i.e. grid cell wise
     recalculate_gas_velo_at_particle_pos:
                   if the dataset shall be recalcualted
     use_IDL:  use backup solution of IDL script and sav files

     returns True if successfull