tilupy.models.lave2D.read
=========================

.. py:module:: tilupy.models.lave2D.read


Attributes
----------

.. autoapisummary::

   tilupy.models.lave2D.read.AVAILABLE_OUTPUT



Classes
-------

.. autoapisummary::

   tilupy.models.lave2D.read.Results


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

Attributes
^^^^^^^^^^

.. py:data:: AVAILABLE_OUTPUT
   :value: ['h', 'hvert', 'u', 'hu', 'hu2']


   All output available for a shaltop simulation.

   Implemented states:

       - h : Flow thickness (normal to the surface)
       - u : Norm of the velocity (from ux and uy)

   Output computed from other output:

       - hvert : True vertical flow thickness
       - hu : Momentum flux (from h and u)
       - hu2 : Convective momentum flux (from h and u)



Classes
^^^^^^^

.. py:class:: Results(folder, name, raster, grid='edges')

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


   Results of lave2D simulations.

   This class is the results class for lave2D. Reading results from lave2D outputs
   are done in this class.

   This class has all the global and quick attributes of the parent class. The quick
   attributes are only computed if needed and can be deleted to clean memory.

   In addition to these attributes, there are those necessary for the operation of
   reading the lave2D results.

   :param folder: Path to the folder containing the simulation files.
   :type folder: str
   :param name: Simulation/Project name.
   :type name: str
   :param raster: Raster name.
   :type raster: str
   :param grid:
                - If grid=="cell", use cell, output nx and ny sizes are the size of topography raster, minus 1.
                - If grid=="edges" (default), use edges, output will have same dimension as topography raster.
   :type grid: str, optional

   .. attribute:: _name

      Name of the lave2D project.

      :type: str

   .. attribute:: _grid



      - If _grid=="cell", use cell, output nx and ny sizes are the size of topography raster, minus 1.
      - If _grid=="edges", use edges, output will have same dimension as topography raster.

      :type: str

   .. attribute:: _raster

      Path to the raster file.

      :type: str

   .. attribute:: _params

      Dictionary storing all simulation parameters.

      :type: dict