get Module Reference

Python wrapper module to get internal variables of a mHM model run. More...

Functions/Subroutines
constants
access constants of mHM
subroutine	number_of_horizons (n)
	Get the number of soil horizons in mHM.
parameter
access parameters of mHM
subroutine	parameter_length (length)
	Get the number of parameters in mHM.
subroutine	parameter_config (config, n)
	Get the parameter settings of mHM.
subroutine	parameter_name (para_name, n)
	Get the parameter names of mHM.
runoff
access generated runoff of mHM
subroutine	runoff_eval_length (gauge_id, length)
	Get the shape of mHM model runoff output for evaluation.
subroutine	runoff_eval (gauge_id, output, m)
	Get the mHM model runoff output.
subroutine	runoff_shape (shp)
	Get the shape of mHM model runoff output.
subroutine	runoff (output, m, n)
	Get the mHM model runoff output.
Level 0
alter Level 0 variables
subroutine	l0_domain_size (n, domain)
	Get number of unmasked celles on Level-0 of the mHM model.
subroutine	l0_domain_shape (shp, domain)
	Get the shape of Level-0 of the mHM model.
subroutine	l0_domain_mask (mask, n, m, domain)
	Get the mask of Level-0 of the mHM model.
subroutine	l0_domain_info (ncols, nrows, ncells, xll, yll, cell_size, no_data, domain)
	Get the information of Level-0 of the mHM model.
subroutine	l0_variable (output, name, idx, n)
	Get a variable on Level-0 of the mHM model.
Level 1
access Level 1 information and variables
subroutine	l1_domain_size (n, domain)
	Get number of unmasked celles on Level-1 of the mHM model.
subroutine	l1_domain_shape (shp, domain)
	Get the shape of Level-1 of the mHM model.
subroutine	l1_domain_mask (mask, n, m, domain)
	Get the mask of Level-1 of the mHM model.
subroutine	l1_domain_info (ncols, nrows, ncells, xll, yll, cell_size, no_data, domain)
	Get the information of Level-1 of the mHM model.
subroutine	l1_variable (output, name, idx, n)
	Get a variable on Level-1 of the mHM model.
Level 11
access Level 11 information and variables
subroutine	l11_domain_size (n, domain)
	Get number of unmasked celles on Level-11 of the mHM model.
subroutine	l11_domain_shape (shp, domain)
	Get the shape of Level-11 of the mHM model.
subroutine	l11_domain_mask (mask, n, m, domain)
	Get the mask of Level-11 of the mHM model.
subroutine	l11_domain_info (ncols, nrows, ncells, xll, yll, cell_size, no_data, domain)
	Get the information of Level-11 of the mHM model.
subroutine	l11_variable (output, name, idx, n)
	Get a variable on Level-11 of the mHM model.
Level 2
access Level 2 information
subroutine	l2_domain_size (n, domain)
	Get number of unmasked celles on Level-2 of the mHM model.
subroutine	l2_domain_shape (shp, domain)
	Get the shape of Level-2 of the mHM model.
subroutine	l2_domain_mask (mask, n, m, domain)
	Get the mask of Level-2 of the mHM model.
subroutine	l2_domain_info (ncols, nrows, ncells, xll, yll, cell_size, no_data, domain)
	Get the information of Level-2 of the mHM model.

Detailed Description

Python wrapper module to get internal variables of a mHM model run.

Date

Nov 2022

Copyright

Copyright 2005-2024, the mHM Developers, Luis Samaniego, Sabine Attinger: All rights reserved. mHM is released under the LGPLv3+ license

The UFZ(CHS) mesoscale hydrologic model mHM is free software. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the free Software Foundation either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You received a copy of the GNU Lesser General Public License along with the UFZ CHS mesoscale hydrologic model mHM. It can be found in the files COPYING and COPYING.LESSER provided with this software. The complete GNU license text can also be found at http://www.gnu.org/licenses/.

Function/Subroutine Documentation

l0_domain_info()

subroutine get::l0_domain_info	(	integer(i4), intent(out)	ncols,
		integer(i4), intent(out)	nrows,
		integer(i4), intent(out)	ncells,
		real(dp), intent(out)	xll,
		real(dp), intent(out)	yll,
		real(dp), intent(out)	cell_size,
		real(dp), intent(out)	no_data,
		integer(i4), intent(in)	domain
	)

Get the information of Level-0 of the mHM model.

Parameters

[out]	ncols	number of columns
[out]	nrows	number of rows
[out]	ncells	number of cells
[out]	xll	x coordinate of lower left corner
[out]	yll	y coordinate of lower left corner
[out]	cell_size	cell-size
[out]	no_data	no data value
[in]	domain	selected domain (0 by default for current domain)

Definition at line 424 of file wrapper.f90.

References mo_common_variables::level0, mo_common_constants::nodata_dp, and mo_common_run_variables::run_cfg.

l0_domain_mask()

subroutine get::l0_domain_mask	(	logical, dimension(m, n), intent(out)	mask,
		integer(i4)	n,
		integer(i4)	m,
		integer(i4), intent(in)	domain
	)

Get the mask of Level-0 of the mHM model.

Parameters

	m	number of columns
	n	number of rows
[out]	mask	mask at Level-0
[in]	domain	selected domain (0 by default for current domain)

Definition at line 405 of file wrapper.f90.

References mo_common_variables::level0, and mo_common_run_variables::run_cfg.

l0_domain_shape()

subroutine get::l0_domain_shape	(	integer(i4), dimension(2), intent(out)	shp,
		integer(i4), intent(in)	domain
	)

Get the shape of Level-0 of the mHM model.

Parameters

[out]	shp	shape of Level-0
[in]	domain	selected domain (0 by default for current domain)

Definition at line 388 of file wrapper.f90.

References mo_common_variables::level0, and mo_common_run_variables::run_cfg.

l0_domain_size()

subroutine get::l0_domain_size	(	integer(i4), intent(out)	n,
		integer(i4), intent(in)	domain
	)

Get number of unmasked celles on Level-0 of the mHM model.

Parameters

[out]	n	number of unmasked celles
[in]	domain	selected domain (0 by default for current domain)

Definition at line 371 of file wrapper.f90.

References mo_common_variables::level0, and mo_common_run_variables::run_cfg.

l0_variable()

subroutine get::l0_variable	(	real(dp), dimension(n), intent(out)	output,
		character(*), intent(in)	name,
		integer(i4), intent(in)	idx,
		integer(i4)	n
	)

Get a variable on Level-0 of the mHM model.

Parameters

	n	size of the variable
[out]	output	the desired variable
[in]	name	name to select the variable
[in]	idx	optional index if the variable has multiple layer (1 by default)

Definition at line 456 of file wrapper.f90.

References mo_common_variables::domainmeta, mo_mpr_global_variables::l0_gridded_lai, mo_common_variables::level0, and mo_common_run_variables::run_cfg.

l11_domain_info()

subroutine get::l11_domain_info	(	integer(i4), intent(out)	ncols,
		integer(i4), intent(out)	nrows,
		integer(i4), intent(out)	ncells,
		real(dp), intent(out)	xll,
		real(dp), intent(out)	yll,
		real(dp), intent(out)	cell_size,
		real(dp), intent(out)	no_data,
		integer(i4), intent(in)	domain
	)

Get the information of Level-11 of the mHM model.

Parameters

[out]	ncols	number of columns
[out]	nrows	number of rows
[out]	ncells	number of cells
[out]	xll	x coordinate of lower left corner
[out]	yll	y coordinate of lower left corner
[out]	cell_size	cell-size
[out]	no_data	no data value
[in]	domain	selected domain (0 by default for current domain)

Definition at line 719 of file wrapper.f90.

References mo_mrm_global_variables::level11, mo_common_constants::nodata_dp, and mo_common_run_variables::run_cfg.

l11_domain_mask()

subroutine get::l11_domain_mask	(	logical, dimension(m, n), intent(out)	mask,
		integer(i4)	n,
		integer(i4)	m,
		integer(i4), intent(in)	domain
	)

Get the mask of Level-11 of the mHM model.

Parameters

	m	number of columns
	n	number of rows
[out]	mask	mask at Level-11
[in]	domain	selected domain (0 by default for current domain)

Definition at line 700 of file wrapper.f90.

References mo_mrm_global_variables::level11, and mo_common_run_variables::run_cfg.

l11_domain_shape()

subroutine get::l11_domain_shape	(	integer(i4), dimension(2), intent(out)	shp,
		integer(i4), intent(in)	domain
	)

Get the shape of Level-11 of the mHM model.

Parameters

[out]	shp	shape of Level-11
[in]	domain	selected domain (0 by default for current domain)

Definition at line 683 of file wrapper.f90.

References mo_mrm_global_variables::level11, and mo_common_run_variables::run_cfg.

l11_domain_size()

subroutine get::l11_domain_size	(	integer(i4), intent(out)	n,
		integer(i4), intent(in)	domain
	)

Get number of unmasked celles on Level-11 of the mHM model.

Parameters

[out]	n	number of unmasked celles
[in]	domain	selected domain (0 by default for current domain)

Definition at line 666 of file wrapper.f90.

References mo_mrm_global_variables::level11, and mo_common_run_variables::run_cfg.

l11_variable()

subroutine get::l11_variable	(	real(dp), dimension(n), intent(out)	output,
		character(*), intent(in)	name,
		integer(i4), intent(in)	idx,
		integer(i4)	n
	)

Get a variable on Level-11 of the mHM model.

Parameters

	n	size of the variable
[out]	output	the desired variable
[in]	name	name to select the variable
[in]	idx	optional index if the variable has multiple layer (1 by default)

Definition at line 751 of file wrapper.f90.

References mo_mrm_global_variables::l11_qmod, mo_mrm_global_variables::l11_qout, mo_mrm_global_variables::l11_qtin, mo_mrm_global_variables::l11_qtr, and mo_common_run_variables::run_cfg.

l1_domain_info()

subroutine get::l1_domain_info	(	integer(i4), intent(out)	ncols,
		integer(i4), intent(out)	nrows,
		integer(i4), intent(out)	ncells,
		real(dp), intent(out)	xll,
		real(dp), intent(out)	yll,
		real(dp), intent(out)	cell_size,
		real(dp), intent(out)	no_data,
		integer(i4), intent(in)	domain
	)

Get the information of Level-1 of the mHM model.

Parameters

[out]	ncols	number of columns
[out]	nrows	number of rows
[out]	ncells	number of cells
[out]	xll	x coordinate of lower left corner
[out]	yll	y coordinate of lower left corner
[out]	cell_size	cell-size
[out]	no_data	no data value
[in]	domain	selected domain (0 by default for current domain)

Definition at line 537 of file wrapper.f90.

References mo_common_variables::level1, mo_common_constants::nodata_dp, and mo_common_run_variables::run_cfg.

l1_domain_mask()

subroutine get::l1_domain_mask	(	logical, dimension(m, n), intent(out)	mask,
		integer(i4)	n,
		integer(i4)	m,
		integer(i4), intent(in)	domain
	)

Get the mask of Level-1 of the mHM model.

Parameters

	m	number of columns
	n	number of rows
[out]	mask	mask at Level-1
[in]	domain	selected domain (0 by default for current domain)

Definition at line 517 of file wrapper.f90.

References mo_common_variables::level1, and mo_common_run_variables::run_cfg.

l1_domain_shape()

subroutine get::l1_domain_shape	(	integer(i4), dimension(2), intent(out)	shp,
		integer(i4), intent(in)	domain
	)

Get the shape of Level-1 of the mHM model.

Parameters

[out]	shp	shape of Level-1
[in]	domain	selected domain (0 by default for current domain)

Definition at line 500 of file wrapper.f90.

References mo_common_variables::level1, and mo_common_run_variables::run_cfg.

l1_domain_size()

subroutine get::l1_domain_size	(	integer(i4), intent(out)	n,
		integer(i4), intent(in)	domain
	)

Get number of unmasked celles on Level-1 of the mHM model.

Parameters

[out]	n	number of unmasked celles
[in]	domain	selected domain (0 by default for current domain)

Definition at line 483 of file wrapper.f90.

References mo_common_variables::level1, and mo_common_run_variables::run_cfg.

l1_variable()

subroutine get::l1_variable	(	real(dp), dimension(n), intent(out)	output,
		character(*), intent(in)	name,
		integer(i4), intent(in)	idx,
		integer(i4)	n
	)

Get a variable on Level-1 of the mHM model.

Parameters

	n	size of the variable
[out]	output	the desired variable
[in]	name	name to select the variable
[in]	idx	optional index if the variable has multiple layer (1 by default)

Definition at line 569 of file wrapper.f90.

References mo_global_variables::l1_aetcanopy, mo_global_variables::l1_aetsealed, mo_global_variables::l1_aetsoil, mo_global_variables::l1_baseflow, mo_global_variables::l1_fastrunoff, mo_mpr_global_variables::l1_fsealed, mo_global_variables::l1_infilsoil, mo_global_variables::l1_inter, mo_global_variables::l1_neutrons, mo_global_variables::l1_percol, mo_global_variables::l1_pet_calc, mo_global_variables::l1_prec_calc, mo_global_variables::l1_preeffect, mo_global_variables::l1_runoffseal, mo_global_variables::l1_satstw, mo_global_variables::l1_sealstw, mo_global_variables::l1_slowrunoff, mo_global_variables::l1_snowpack, mo_global_variables::l1_soilmoist, mo_mpr_global_variables::l1_soilmoistsat, mo_global_variables::l1_temp_calc, mo_global_variables::l1_total_runoff, mo_global_variables::l1_unsatstw, and mo_common_run_variables::run_cfg.

l2_domain_info()

subroutine get::l2_domain_info	(	integer(i4), intent(out)	ncols,
		integer(i4), intent(out)	nrows,
		integer(i4), intent(out)	ncells,
		real(dp), intent(out)	xll,
		real(dp), intent(out)	yll,
		real(dp), intent(out)	cell_size,
		real(dp), intent(out)	no_data,
		integer(i4), intent(in)	domain
	)

Get the information of Level-2 of the mHM model.

Parameters

[out]	ncols	number of columns
[out]	nrows	number of rows
[out]	ncells	number of cells
[out]	xll	x coordinate of lower left corner
[out]	yll	y coordinate of lower left corner
[out]	cell_size	cell-size
[out]	no_data	no data value
[in]	domain	selected domain (0 by default for current domain)

Definition at line 836 of file wrapper.f90.

References mo_global_variables::meteo_handler, mo_common_constants::nodata_dp, and mo_common_run_variables::run_cfg.

l2_domain_mask()

subroutine get::l2_domain_mask	(	logical, dimension(m, n), intent(out)	mask,
		integer(i4)	n,
		integer(i4)	m,
		integer(i4), intent(in)	domain
	)

Get the mask of Level-2 of the mHM model.

Parameters

	m	number of columns
	n	number of rows
[out]	mask	mask at Level-2
[in]	domain	selected domain (0 by default for current domain)

Definition at line 816 of file wrapper.f90.

References mo_global_variables::meteo_handler, and mo_common_run_variables::run_cfg.

l2_domain_shape()

subroutine get::l2_domain_shape	(	integer(i4), dimension(2), intent(out)	shp,
		integer(i4), intent(in)	domain
	)

Get the shape of Level-2 of the mHM model.

Parameters

[out]	shp	shape of Level-2
[in]	domain	selected domain (0 by default for current domain)

Definition at line 799 of file wrapper.f90.

References mo_global_variables::meteo_handler, and mo_common_run_variables::run_cfg.

l2_domain_size()

subroutine get::l2_domain_size	(	integer(i4), intent(out)	n,
		integer(i4), intent(in)	domain
	)

Get number of unmasked celles on Level-2 of the mHM model.

Parameters

[out]	n	number of unmasked celles
[in]	domain	selected domain (0 by default for current domain)

Definition at line 782 of file wrapper.f90.

References mo_global_variables::meteo_handler, and mo_common_run_variables::run_cfg.

number_of_horizons()

subroutine get::number_of_horizons

(

integer(i4), intent(out)

n

)

Get the number of soil horizons in mHM.

Parameters

[out]

n

number of soil horizons

Definition at line 264 of file wrapper.f90.

References mo_mpr_global_variables::nsoilhorizons_mhm.

parameter_config()

subroutine get::parameter_config	(	real(dp), dimension(n, 5), intent(out)	config,
		integer(i4)	n
	)

Get the parameter settings of mHM.

Parameters

	n	number of parameters
[out]	config	parameter configuration

Definition at line 284 of file wrapper.f90.

References mo_common_variables::global_parameters.

parameter_length()

subroutine get::parameter_length

(

integer(i4), intent(out)

length

)

Get the number of parameters in mHM.

Parameters

[out]

length

length of the parmeter array

Definition at line 274 of file wrapper.f90.

References mo_mhm_interface::mhm_interface_get_parameter_number().

Here is the call graph for this function:

parameter_name()

subroutine get::parameter_name	(	character(256), intent(out)	para_name,
		integer(i4), intent(in)	n
	)

Get the parameter names of mHM.

Parameters

[out]	para_name	parameter name
[in]	n	number of parameters

Definition at line 298 of file wrapper.f90.

References mo_common_variables::global_parameters_name.

runoff()

subroutine get::runoff	(	real(dp), dimension(m, n), intent(out)	output,
		integer(i4)	m,
		integer(i4)	n
	)

Get the mHM model runoff output.

Parameters

	m	number of time-steps
	n	number of gauges
[out]	output	runoff

Definition at line 359 of file wrapper.f90.

References mo_mrm_global_variables::mrm_runoff.

runoff_eval()

subroutine get::runoff_eval	(	integer(i4), intent(in)	gauge_id,
		real(dp), dimension(m, 2), intent(out)	output,
		integer(i4)	m
	)

Get the mHM model runoff output.

Parameters

	m	number of time-steps for evaluation
[out]	output	runoff
[in]	gauge_id	gauge id

Definition at line 328 of file wrapper.f90.

References mo_mrm_objective_function_runoff::extract_runoff(), and mo_mrm_global_variables::mrm_runoff.

Here is the call graph for this function:

runoff_eval_length()

subroutine get::runoff_eval_length	(	integer(i4), intent(in)	gauge_id,
		integer(i4), intent(out)	length
	)

Get the shape of mHM model runoff output for evaluation.

Parameters

[in]	gauge_id	gauge id
[out]	length	length of the runoff time series

Definition at line 312 of file wrapper.f90.

References mo_common_mhm_mrm_variables::evalper, mo_mrm_global_variables::gauge, mo_mrm_global_variables::nmeasperday, mo_common_mhm_mrm_variables::ntstepday, and mo_common_mhm_mrm_variables::warmingdays.

runoff_shape()

subroutine get::runoff_shape

(

integer(i4), dimension(2), intent(out)

shp

)

Get the shape of mHM model runoff output.

Parameters

[out]

shp

2D shape of the runoff

Definition at line 348 of file wrapper.f90.

References mo_mrm_global_variables::mrm_runoff.