tilupy.models.ravaflow.read
===========================

.. py:module:: tilupy.models.ravaflow.read

.. autoapi-nested-parse::

   Created on Tue Jun  1 15:27:36 2021

   @author: peruzzetto



Attributes
----------

.. autoapisummary::

   tilupy.models.ravaflow.read.LOOKUP_NAMES
   tilupy.models.ravaflow.read.STATES_OUTPUT
   tilupy.models.ravaflow.read.forces
   tilupy.models.ravaflow.read.FORCES_OUTPUT


Functions
---------

.. autoapisummary::

   tilupy.models.ravaflow.read.read_params
   tilupy.models.ravaflow.read.read_ascii
   tilupy.models.ravaflow.read.read_asciis


Classes
-------

.. autoapisummary::

   tilupy.models.ravaflow.read.Results


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

Attributes
^^^^^^^^^^

.. py:data:: LOOKUP_NAMES

.. py:data:: STATES_OUTPUT
   :value: ['h', 'ux', 'uy']


.. py:data:: forces
   :value: ['facc', 'fcurv', 'ffric', 'fgrav', 'fpression']


.. py:data:: FORCES_OUTPUT
   :value: []



Functions
^^^^^^^^^

.. py:function:: read_params(file)

   Read simulation parameters from file.

   :param file: Parameters file.
   :type file: str

   :returns: **params** -- Dictionnary with parameters
   :rtype: dict


.. py:function:: read_ascii(file)

   Read ascii grid file to numpy ndarray.

   :param file: DESCRIPTION.
   :type file: TYPE

   :rtype: None.


.. py:function:: read_asciis(file_prefix, folder=None, ind=None, nodigit=False)

   Read mutiple ascii grid file matching prefix.

   :param file: DESCRIPTION.
   :type file: TYPE
   :param ind: DESCRIPTION. The default is None.
   :type ind: TYPE, optional

   :rtype: None.



Classes
^^^^^^^

.. py:class:: Results(text_rheol=None, folder_base=None, **varargs)

   Bases: :py:obj:`tilupy.read.Results`


   Results of shaltop simulations.


   .. py:attribute:: code
      :value: 'ravaflow'



   .. py:attribute:: prefix
      :value: None



   .. py:attribute:: folder_base
      :value: None



   .. py:attribute:: params


   .. py:attribute:: folder_ascii


   .. py:attribute:: folder_files


   .. py:method:: set_axes(x=None, y=None, **varargs)

      Set x and y axes.



   .. py:method:: set_zinit(zinit=None)

      Set zinit, initial topography.



   .. py:method:: get_temporal_output(name, d=None, t=None, **varargs)

      Read 2D time dependent simulation results.

      :param name: Name of output.
      :type name: str
      :param d: Data to be read. If None, will be computed.
                The default is None.
      :type d: ndarray, optional
      :param t: Time of results snapshots (1D array), matching last dimension of d.
                If None, will be computed. The default is None.
      :type t: ndarray, optional
      :param \*\*varargs: DESCRIPTION.
      :type \*\*varargs: TYPE



   .. py:method:: get_static_output(name, stat, d=None, from_file=False, **varargs)

      Read 2D time dependent simulation results.

      :param name: Name of output.
      :type name: str
      :param d: Data to be read. Last dimension is for time.
                If None, will be computed.
                The default is None.
      :type d: ndarray, optional
      :param \*\*varargs: DESCRIPTION.
      :type \*\*varargs: TYPE