smash.Model.rr_parameters#

property Model.rr_parameters[source]#

Model rainfall-runoff parameters.

Returns:

rr_parametersRR_ParametersDT: It returns a Fortran derived type containing the variables relating to the rainfall-runoff parameters.

See also

Model.get_rr_parameters: Get the values of a Model rainfall-runoff parameter.
Model.set_rr_parameters: Set the values of a Model rainfall-runoff parameter.

Examples

>>> from smash.factory import load_dataset
>>> setup, mesh = load_dataset("cance")
>>> model = smash.Model(setup, mesh)

Access to Model rainfall-runoff parameters

>>> model.rr_parameters
RR_ParametersDT
    keys: array(['ci', 'cp', 'ct', 'kexc', 'llr'], dtype='<U4')
    values: array([[[1.0e-06, 2.0e+02, 5.0e+02, 0.0e+00, 5.0e+00],
        [1.0e-06, 2.0e+02, 5.0e+02, 0.0e+00, 5.0e+00],
        [1.0e-06, 2.0e+02, 5.0e+02, 0.0e+00, 5.0e+00],
        ...
        [1.0e-06, 2.0e+02, 5.0e+02, 0.0e+00, 5.0e+00]]], dtype=float32)

Access to a specific rainfall-runoff parameter grid with the getter method get_rr_parameters

>>> model.get_rr_parameters("cp")
array([[200., 200., 200., 200., 200., 200., 200., 200., 200., 200., 200.,
        200., 200., 200., 200., 200., 200., 200., 200., 200., 200., 200.,
        ...
        200., 200., 200., 200., 200., 200.]], dtype=float32)

Set a value to a specific rainfall-runoff parameter grid with the setter method set_rr_parameters

>>> model.set_rr_parameters("cp", 273)
>>> model.get_rr_parameters("cp")
array([[273., 273., 273., 273., 273., 273., 273., 273., 273., 273., 273.,
        273., 273., 273., 273., 273., 273., 273., 273., 273., 273., 273.,
        ...
        273., 273., 273., 273., 273., 273.]], dtype=float32)

If you are using IPython, tab completion allows you to visualize all the attributes and methods

>>> model.rr_parameters.<TAB>
model.rr_parameters.copy()        model.rr_parameters.keys
model.rr_parameters.from_handle(  model.rr_parameters.values