MARRMOT_18
Implementation
MARRMoT v2.1.1 rev eeb7e15 m_18_simhyd_7p_3s; standardized continuous structure, not original model
Time step: daily
Backend: octave-cli + Octave optim
Calibrated parameters: 7
Temperature required: no
Parameters and initial configuration
Parameter |
Supported calibration range |
Default |
|---|---|---|
|
0 to 5 |
2.5 |
|
0 to 600 |
300.0 |
|
0 to 15 |
7.5 |
|
1 to 2000 |
1000.5 |
|
0 to 1 |
0.5 |
|
0 to 1 |
0.5 |
|
0 to 1 |
0.5 |
|
Fixed initial/configuration value |
0.0 |
|
Fixed initial/configuration value |
0.0 |
|
Fixed initial/configuration value |
0.0 |
Ranges/defaults are implementation contracts, not universal priors or a recommended basin calibration. Consult source comments for parameter units and coupling.
Governing equations
The following source is the exact model kernel used by this adapter. For MARRMoT it includes the state derivative and each referenced flux function; the solver and routing are described above. Original notices and source citations are retained in the files.
function [dS, fluxes] = model_fun(obj, S)
% parameters
theta = obj.theta;
insc = theta(1); % Maximum interception capacity, [mm]
coeff = theta(2); % Maximum infiltration loss parameter, [-]
sq = theta(3); % Infiltration loss exponent, [-]
smsc = theta(4); % Maximum soil moisture capacity, [mm]
sub = theta(5); % Proportionality constant, [-],
crak = theta(6); % Proportionality constant, [-]
k = theta(7); % Slow flow time scale, [d-1]
% delta_t
delta_t = obj.delta_t;
% stores
S1 = S(1);
S2 = S(2);
S3 = S(3);
% climate input
t = obj.t; % this time step
climate_in = obj.input_climate(t,:); % climate at this step
P = climate_in(1);
Ep = climate_in(2);
% fluxes functions
% Original formulation using MARRMoT fluxes is slow on simhyd,
% individual functions have been explicitly coded underneath.
flux_Ei = evap_1(S1,Ep,delta_t);
flux_EXC = interception_1(P,S1,insc);
flux_INF = infiltration_1(coeff,sq,S2,smsc,flux_EXC);
flux_INT = interflow_1(sub,S2,smsc,flux_INF);
flux_REC = recharge_1(crak,S2,smsc,(flux_INF-flux_INT));
flux_Et = evap_2(10,S2,smsc,Ep,delta_t);
flux_GWF = saturation_1((flux_INF-flux_INT-flux_REC),S2,smsc);
flux_BAS = baseflow_1(k,S3);
flux_SRUN = flux_EXC - flux_INF;
flux_Qt = flux_SRUN + flux_INT + flux_BAS;
% flux_SMF is not reported in old MARRMoT, it is not reported
% here either to keep results consistent
flux_SMF = flux_INF-flux_INT-flux_REC;
% stores ODEs
dS1 = P - flux_Ei - flux_EXC;
dS2 = flux_SMF - flux_Et - flux_GWF;
dS3 = flux_REC + flux_GWF - flux_BAS;
% outputs
dS = [dS1, dS2, dS3];
fluxes = [flux_Ei, flux_EXC, flux_INF, flux_INT, flux_REC,...
flux_Et, flux_GWF, flux_BAS, flux_SRUN, flux_Qt];
end
% STEP runs at the end of every timestep
function [out] = evap_1(S,Ep,dt)
%evap_1
% Copyright (C) 2019, 2021 Wouter J.M. Knoben, Luca Trotter
% This file is part of the Modular Assessment of Rainfall-Runoff Models
% Toolbox (MARRMoT).
% MARRMoT is a free software (GNU GPL v3) and distributed WITHOUT ANY
% WARRANTY. See <https://www.gnu.org/licenses/> for details.
% Flux function
% ------------------
% Description: Evaporation at the potential rate
% Constraints: f <= S/dt
% @(Inputs): S - current storage [mm]
% Ep - potential evaporation rate [mm/d]
% dt - time step size
out = min(S/dt,Ep);
end
function [out] = interception_1(In,S,Smax,varargin)
%interception_1
% Copyright (C) 2019, 2021 Wouter J.M. Knoben, Luca Trotter
% This file is part of the Modular Assessment of Rainfall-Runoff Models
% Toolbox (MARRMoT).
% MARRMoT is a free software (GNU GPL v3) and distributed WITHOUT ANY
% WARRANTY. See <https://www.gnu.org/licenses/> for details.
% Flux function
% ------------------
% Description: Interception excess when maximum capacity is reached
% Constraints: -
% @(Inputs): In - incoming flux [mm/d]
% S - current storage [mm]
% Smax - maximum storage [mm]
% varargin(1) - smoothing variable r (default 0.01)
% varargin(2) - smoothing variable e (default 5.00)
if size(varargin,2) == 0
out = In.*(1-smoothThreshold_storage_logistic(S,Smax));
elseif size(varargin,2) == 1
out = In.*(1-smoothThreshold_storage_logistic(S,Smax,varargin(1)));
elseif size(varargin,2) == 2
out = In.*(1-smoothThreshold_storage_logistic(S,Smax,varargin(1),varargin(2)));
end
end
function [out] = infiltration_1(p1,p2,S,Smax,fin)
%infiltration_1
% Copyright (C) 2019, 2021 Wouter J.M. Knoben, Luca Trotter
% This file is part of the Modular Assessment of Rainfall-Runoff Models
% Toolbox (MARRMoT).
% MARRMoT is a free software (GNU GPL v3) and distributed WITHOUT ANY
% WARRANTY. See <https://www.gnu.org/licenses/> for details.
% Flux function
% ------------------
% Description: Infiltration as exponentially declining based on relative storage
% Constraints: f <= fin
% @(Inputs): p1 - maximum infiltration rate [mm,/d]
% p2 - exponential scaling parameter [-]
% S - current storage [mm]
% Smax - maximum storage [mm]
% fin - size of incoming flux [mm/d]
out = min(p1.*exp((-1*p2*S)./Smax),fin);
end
function [out] = interflow_1(p1,S,Smax,flux)
%interflow_1 interflow based on incoming flux size
% Copyright (C) 2019, 2021 Wouter J.M. Knoben, Luca Trotter
% This file is part of the Modular Assessment of Rainfall-Runoff Models
% Toolbox (MARRMoT).
% MARRMoT is a free software (GNU GPL v3) and distributed WITHOUT ANY
% WARRANTY. See <https://www.gnu.org/licenses/> for details.
% Flux function
% ------------------
% Description: Interflow as a scaled fraction of an incoming flux
% Constraints: -
% @(Inputs): p1 - linear scaling parameter [-]
% S - current storage [mm]
% Smax - maximum storage [mm]
% flux - incoming flux [mm/d]
out = p1*S/Smax*flux;
end
function [out] = recharge_1(p1,S,Smax,flux)
%recharge_1
% Copyright (C) 2019, 2021 Wouter J.M. Knoben, Luca Trotter
% This file is part of the Modular Assessment of Rainfall-Runoff Models
% Toolbox (MARRMoT).
% MARRMoT is a free software (GNU GPL v3) and distributed WITHOUT ANY
% WARRANTY. See <https://www.gnu.org/licenses/> for details.
% Flux function
% ------------------
% Description: Recharge as scaled fraction of incoming flux
% Constraints: -
% @(Inputs): p1 - fraction of flux that is recharge [-]
% S - current storage [mm]
% Smax - maximum contributing storage [mm]
% flux - incoming flux [mm/d]
out = p1*S/Smax*flux;
end
function [out] = evap_2(p1,S,Smax,Ep,dt)
%evap_2
% Copyright (C) 2019, 2021 Wouter J.M. Knoben, Luca Trotter
% This file is part of the Modular Assessment of Rainfall-Runoff Models
% Toolbox (MARRMoT).
% MARRMoT is a free software (GNU GPL v3) and distributed WITHOUT ANY
% WARRANTY. See <https://www.gnu.org/licenses/> for details.
% Flux function
% ------------------
% Description: Evaporation at a scaled, plant-controlled rate
% Constraints: f <= Ep
% f <= S/dt
% @(Inputs): p1 - plant-controlled base evaporation rate [mm/d]
% S - current storage [mm]
% Smax - maximum storage [mm]
% Ep - potential evapotranspiration rate [mm/d]
% dt - time step size [d]
out = min([p1*S/Smax,Ep,S/dt]);
end
function [out] = saturation_1(In,S,Smax,varargin)
%saturation_1
% Copyright (C) 2019, 2021 Wouter J.M. Knoben, Luca Trotter
% This file is part of the Modular Assessment of Rainfall-Runoff Models
% Toolbox (MARRMoT).
% MARRMoT is a free software (GNU GPL v3) and distributed WITHOUT ANY
% WARRANTY. See <https://www.gnu.org/licenses/> for details.
% Flux function
% ------------------
% Description: Saturation excess from a store that has reached maximum capacity
% Constraints: -
% @(Inputs): In - incoming flux [mm/d]
% S - current storage [mm]
% Smax - maximum storage [mm]
% varargin(1) - smoothing variable r (default 0.01)
% varargin(2) - smoothing variable e (default 5.00)
if size(varargin,2) == 0
out = In.*(1-smoothThreshold_storage_logistic(S,Smax));
elseif size(varargin,2) == 1
out = In.*(1-smoothThreshold_storage_logistic(S,Smax,varargin(1)));
elseif size(varargin,2) == 2
out = In.*(1-smoothThreshold_storage_logistic(S,Smax,varargin(1),varargin(2)));
end
end
function [out] = baseflow_1(p1,S)
% baseflow_1
% Copyright (C) 2019, 2021 Wouter J.M. Knoben, Luca Trotter
% This file is part of the Modular Assessment of Rainfall-Runoff Models
% Toolbox (MARRMoT).
% MARRMoT is a free software (GNU GPL v3) and distributed WITHOUT ANY
% WARRANTY. See <https://www.gnu.org/licenses/> for details.
% Flux function
% ------------------
% Description: Outflow from a linear reservoir
% Constraints: -
% @(Inputs): p1 - time scale parameter [d-1]
% S - current storage [mm]
out = p1.*S;
end
function [out] = smoothThreshold_storage_logistic(S,Smax,r,e)
%smoothThreshold_storage_logistic Logisitic smoother for storage threshold functions.
% Copyright (C) 2018 Wouter J.M. Knoben
% This file is part of the Modular Assessment of Rainfall-Runoff Models
% Toolbox (MARRMoT).
% MARRMoT is a free software (GNU GPL v3) and distributed WITHOUT ANY
% WARRANTY. See <https://www.gnu.org/licenses/> for details.
% Smooths the transition of threshold functions of the form:
%
% Q = { P, if S = Smax
% { 0, if S < Smax
%
% By transforming the equation above to Q = f(P,S,Smax,e,r):
% Q = P * 1/ (1+exp((S-Smax+r*e*Smax)/(r*Smax)))
%
% Inputs:
% S : current storage
% Smax : maximum storage
% r : [optional] smoothing parameter rho, default = 0.01
% e : [optional] smoothing parameter e, default 5
%
% NOTE: this function only outputs the multiplier. This needs to be
% applied to the proper flux utside of this function.
%
% NOTE: can be applied for temperature thresholds as well (i.e. snow
% modules). This simply means that S becomes T, and Smax T0.
% Check for inputs and use defaults if not provided
% NOTE: this is not very elegant, but it is more than a factor 10 faster then:
% if ~exist('r','var'); r = 0.01; end
% if ~exist('e','var'); e = 5.00; end
if nargin == 2
r = 0.01;
e = 5.00;
elseif nargin == 3
r = r{1};
e = 5.00;
elseif nargin == 4
r = r{1};
e = e{1};
end
% Calculate multiplier
Smax = max(Smax,0); % this avoids numerical instabilities when Smax<0
if r*Smax == 0
out = 1 ./ (1+exp((S-Smax+r*e*Smax)/(r)));
else
out = 1 ./ (1+exp((S-Smax+r*e*Smax)/(r*Smax)));
end
end
Note
This standardized MARRMoT structure is not identical to the original named model. p01... follow exact source order; s01... are fixed initial stores, defaulting to zero. Octave + optim are required. Solver behavior can differ across runtime versions.
Simulation
from basinforge import Basin, get_model
basin = Basin.from_csv("basin.csv", basin_id="A", area_km2=1200,
q_unit="m3/s", timestep="daily")
q_mm = get_model("MARRMOT_18").simulate(basin)
q_m3s = basin.to_m3s(q_mm)
Supply your actual data and catchment area; temperature-dependent models require a temperature column. For non-daily models, choose an appropriate warmup in model steps.
See calibration, input requirements, sources and verification limitations.