tilupy.models.ravaflow.read

Created on Tue Jun 1 15:27:36 2021

@author: peruzzetto

Attributes

LOOKUP_NAMES

STATES_OUTPUT

forces

FORCES_OUTPUT

Functions

read_params(file)

Read simulation parameters from file.

read_ascii(file)

Read ascii grid file to numpy ndarray.

read_asciis(file_prefix[, folder, ind, nodigit])

Read mutiple ascii grid file matching prefix.

Classes

Results

Results of shaltop simulations.

Module Contents

Attributes

tilupy.models.ravaflow.read.LOOKUP_NAMES
tilupy.models.ravaflow.read.STATES_OUTPUT = ['h', 'ux', 'uy']
tilupy.models.ravaflow.read.forces = ['facc', 'fcurv', 'ffric', 'fgrav', 'fpression']
tilupy.models.ravaflow.read.FORCES_OUTPUT = []

Functions

tilupy.models.ravaflow.read.read_params(file)

Read simulation parameters from file.

Parameters:

file (str) – Parameters file.

Returns:

params – Dictionnary with parameters

Return type:

dict

tilupy.models.ravaflow.read.read_ascii(file)

Read ascii grid file to numpy ndarray.

Parameters:

file (TYPE) – DESCRIPTION.

Return type:

None.

tilupy.models.ravaflow.read.read_asciis(file_prefix, folder=None, ind=None, nodigit=False)

Read mutiple ascii grid file matching prefix.

Parameters:

  • file (TYPE) – DESCRIPTION.

  • ind (TYPE, optional) – DESCRIPTION. The default is None.

Return type:

None.

Classes

class tilupy.models.ravaflow.read.Results(text_rheol=None, folder_base=None, **varargs)

Bases: tilupy.read.Results

Results of shaltop simulations.

code = 'ravaflow'
prefix = None
folder_base = None
params
folder_ascii
folder_files
set_axes(x=None, y=None, **varargs)

Set x and y axes.

set_zinit(zinit=None)

Set zinit, initial topography.

get_temporal_output(name, d=None, t=None, **varargs)

Read 2D time dependent simulation results.

Parameters:

  • name (str) – Name of output.

  • d (ndarray, optional) – Data to be read. If None, will be computed. The default is None.

  • t (ndarray, optional) – Time of results snapshots (1D array), matching last dimension of d. If None, will be computed. The default is None.

  • **varargs (TYPE) – DESCRIPTION.

get_static_output(name, stat, d=None, from_file=False, **varargs)

Read 2D time dependent simulation results.

Parameters:

  • name (str) – Name of output.

  • d (ndarray, optional) – Data to be read. Last dimension is for time. If None, will be computed. The default is None.

  • **varargs (TYPE) – DESCRIPTION.