tilupy.models.lave2D.read
Attributes
All output available for a shaltop simulation. |
Classes
Results of lave2D simulations. |
Module Contents
Attributes
- tilupy.models.lave2D.read.AVAILABLE_OUTPUT = ['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
- class tilupy.models.lave2D.read.Results(folder, name, raster, grid='edges')
Bases:
tilupy.read.ResultsResults 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.
- Parameters:
folder (str) – Path to the folder containing the simulation files.
name (str) – Simulation/Project name.
raster (str) – Raster name.
grid (str, optional) –
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.
- _name
Name of the lave2D project.
- Type:
str
- _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
- _raster
Path to the raster file.
- Type:
str
- _params
Dictionary storing all simulation parameters.
- Type:
dict