pencil.diag.tracers
===================

.. py:module:: pencil.diag.tracers

.. autoapi-nested-parse::

   Reads the tracer files, composes a color map.



Classes
-------

.. autoapisummary::

   pencil.diag.tracers.Tracers
   pencil.diag.tracers.TracersParameterClass


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

.. py:class:: Tracers

   Bases: :py:obj:`object`


   Tracers -- Holds the traced tracer object with the field line integrated
   quantities and the mapping.

   Fill members with default values.


   .. py:attribute:: params


   .. py:attribute:: x0
      :value: None



   .. py:attribute:: y0
      :value: None



   .. py:attribute:: x1
      :value: None



   .. py:attribute:: y1
      :value: None



   .. py:attribute:: z1
      :value: None



   .. py:attribute:: l
      :value: None



   .. py:attribute:: tracers
      :value: None



   .. py:attribute:: mapping
      :value: None



   .. py:attribute:: t
      :value: None



   .. py:attribute:: aa
      :value: None



   .. py:attribute:: ee
      :value: None



   .. py:attribute:: curly_A
      :value: None



   .. py:attribute:: splines
      :value: None



   .. py:method:: find_tracers(var_file='VAR0', datadir='data', trace_field='bb', ti=-1, tf=-1)

      Trace streamlines of the vectofield 'field' from z = z0 to z = z1
      and integrate quantities 'int_q' along the lines. Creates a 2d
      mapping as in 'streamlines.f90'.

      call signature:

      find_tracers(var_file='VAR0', datadir='data', trace_field='bb',
                   ti=-1, tf=-1)

      Keyword arguments:

      *var_file*:
        Varfile to be read.

      *datadir*:
        Directory where the data is stored.

      *trace_field*:
        Vector field used for the streamline tracing.

      *ti*:
        Initial VAR file index for tracer time sequences. Overrides 'var_file'.

      *tf*:
        Final VAR file index for tracer time sequences. Overrides 'var_file'.



   .. py:method:: write(datadir='data', destination='tracers.hdf5')

      Write the tracers into a file.

      call signature::

      write(self, datadir='data', destination='tracers.hdf5')

      Keyword arguments:

      *datadir*:
        Directory where the data is stored.

      *destination*:
        Destination file.



   .. py:method:: read(datadir='data', file_name='tracers.hdf5')

      Read the tracers from a file.

      call signature:

      read(self, datadir='data', file_name='tracers.hdf5')

      Keyword arguments:

      *datadir*:
        Directory where the data is stored.

      *file_name*:
        File with the tracer data.



.. py:class:: TracersParameterClass

   Bases: :py:obj:`object`


   __TracersParameterClass -- Holds the simulation and tracing parameters.

   Initialize the parameters.


   .. py:attribute:: dx
      :value: 0



   .. py:attribute:: dy
      :value: 0



   .. py:attribute:: dz
      :value: 0



   .. py:attribute:: Ox
      :value: 0



   .. py:attribute:: Oy
      :value: 0



   .. py:attribute:: Oz
      :value: 0



   .. py:attribute:: Lx
      :value: 0



   .. py:attribute:: Ly
      :value: 0



   .. py:attribute:: Lz
      :value: 0



   .. py:attribute:: nx
      :value: 0



   .. py:attribute:: ny
      :value: 0



   .. py:attribute:: nz
      :value: 0



   .. py:attribute:: trace_field
      :value: ''



   .. py:attribute:: rtol
      :value: 1e-08



   .. py:attribute:: atol
      :value: 1e-08



   .. py:attribute:: periodic_x
      :value: False



   .. py:attribute:: periodic_y
      :value: False



   .. py:attribute:: periodic_z
      :value: False



   .. py:attribute:: interpolation
      :value: 'trilinear'



   .. py:attribute:: method
      :value: 'RK45'



   .. py:attribute:: trace_sub
      :value: 1



   .. py:attribute:: int_q
      :value: ''



   .. py:attribute:: var_file
      :value: 'VAR0'



   .. py:attribute:: ti
      :value: -1



   .. py:attribute:: tf
      :value: -1



   .. py:attribute:: datadir
      :value: 'data'



   .. py:attribute:: destination
      :value: 'tracers.hdf5'



   .. py:attribute:: n_proc
      :value: 1