pencil.diag.fixed_points
========================

.. py:module:: pencil.diag.fixed_points

.. autoapi-nested-parse::

   Find the fixed points of a given field.



Classes
-------

.. autoapisummary::

   pencil.diag.fixed_points.FixedPoint


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

.. py:class:: FixedPoint

   Bases: :py:obj:`object`


   FixedPoint -- Holds the fixed points and additional integrated quantities.

   Fill members with default values.


   .. py:attribute:: params


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



   .. py:attribute:: fixed_index
      :value: None



   .. py:attribute:: fixed_points
      :value: None



   .. py:attribute:: fixed_tracers
      :value: None



   .. py:attribute:: fixed_sign
      :value: None



   .. py:attribute:: poincare
      :value: None



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



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

      Find the fixed points to a snapshot or existing tracer file.

      call signature::

        find_fixed(datadir='data', var_file='VAR0', trace_field='bb',
                   ti=-1, tf=-1, tracer_file_name=None):

      :keyword \*datadir*: Data directory.

       *var_file*:
         Varfile to be read.

       *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'.

       *tracer_file_name*
         Name of the tracer file to be read.
         If 'None' compute the tracers.



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

      Write the fixed points into a file.

      call signature::

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

      Keyword arguments:

      *datadir*:
        Directory where the data is stored.

      *destination*:
        Destination file.



   .. py:method:: read(datadir='data', file_name='fixed_points.hdf5', quiet=True)

      Read the fixed points from a file.

      call signature::

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

      Keyword arguments:

      *datadir*:
        Directory where the data is stored.

      *file_name*:
        File with the tracer data.

      *quiet*:
        Suppress warnings.