wrapper.f90 File Reference

Module to wrap mHM with f2py to control it with Python. More...

Go to the source code of this file.

Modules
module	model
	Python wrapper module to control a mHM model.
module	run
	Python wrapper module to control a mHM model run per time step.
module	get
	Python wrapper module to get internal variables of a mHM model run.
module	set
	Python wrapper module to set internal variables of a mHM model run.

Functions/Subroutines
subroutine	model::config_coupling (couple_case, meteo_timestep, meteo_time_ref_endpoint, meteo_expect_pre, meteo_expect_temp, meteo_expect_pet, meteo_expect_tmin, meteo_expect_tmax, meteo_expect_netrad, meteo_expect_absvappress, meteo_expect_windspeed, meteo_expect_ssrd, meteo_expect_strd, meteo_expect_tann)
	Configure coupling mode of mHM.
subroutine	model::init (namelist_mhm, namelist_mhm_param, namelist_mhm_output, namelist_mrm_output, cwd)
	Initialize a mHM model.
subroutine	model::run ()
	Execute a mHM model.
subroutine	model::disable_output ()
	disable all mHM/mRM outputs during runtime.
subroutine	model::run_with_parameter (parameter, n)
	Execute a mHM model with given parameters.
subroutine	model::run_or_optimize ()
	Execute a mHM model or an optimization depending on the configuration.
subroutine	model::version (ver_string)
	Get the mHM version.
subroutine	model::finalize ()
	Finalize a mHM model.
subroutine	model::set_verbosity (level)
	Set verbosity level of mHM.
subroutine	run::prepare ()
	Prepare a mHM model run.
subroutine	run::get_ndomains (n)
	Get the number of domains of the current mHM model run.
subroutine	run::prepare_domain (domain)
	Prepare a certain domain of the current mHM model run.
subroutine	run::finished (output)
	Check if the current mHM model time loop is finished.
subroutine	run::do_time_step ()
	Do one time-step on the current domain of the current mHM model run.
subroutine	run::write_output ()
	Write output for the current domain of the current mHM model run.
subroutine	run::finalize_domain ()
	Finalize the current domain of the current mHM model run.
subroutine	run::finalize ()
	Finalize the current mHM model run.
subroutine	run::current_time (year, month, day, hour)
	Get the current time the current domain of the current mHM model run.
constants
access constants of mHM
subroutine	get::number_of_horizons (n)
	Get the number of soil horizons in mHM.
parameter
access parameters of mHM
subroutine	get::parameter_length (length)
	Get the number of parameters in mHM.
subroutine	get::parameter_config (config, n)
	Get the parameter settings of mHM.
subroutine	get::parameter_name (para_name, n)
	Get the parameter names of mHM.
runoff
access generated runoff of mHM
subroutine	get::runoff_eval_length (gauge_id, length)
	Get the shape of mHM model runoff output for evaluation.
subroutine	get::runoff_eval (gauge_id, output, m)
	Get the mHM model runoff output.
subroutine	get::runoff_shape (shp)
	Get the shape of mHM model runoff output.
subroutine	get::runoff (output, m, n)
	Get the mHM model runoff output.
Level 0
alter Level 0 variables
subroutine	get::l0_domain_size (n, domain)
	Get number of unmasked celles on Level-0 of the mHM model.
subroutine	get::l0_domain_shape (shp, domain)
	Get the shape of Level-0 of the mHM model.
subroutine	get::l0_domain_mask (mask, n, m, domain)
	Get the mask of Level-0 of the mHM model.
subroutine	get::l0_domain_info (ncols, nrows, ncells, xll, yll, cell_size, no_data, domain)
	Get the information of Level-0 of the mHM model.
subroutine	get::l0_variable (output, name, idx, n)
	Get a variable on Level-0 of the mHM model.
subroutine	set::l0_variable (input, name, idx, n)
	Set a variable on Level-0 of the mHM model.
Level 1
access Level 1 information and variables
subroutine	get::l1_domain_size (n, domain)
	Get number of unmasked celles on Level-1 of the mHM model.
subroutine	get::l1_domain_shape (shp, domain)
	Get the shape of Level-1 of the mHM model.
subroutine	get::l1_domain_mask (mask, n, m, domain)
	Get the mask of Level-1 of the mHM model.
subroutine	get::l1_domain_info (ncols, nrows, ncells, xll, yll, cell_size, no_data, domain)
	Get the information of Level-1 of the mHM model.
subroutine	get::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	get::l11_domain_size (n, domain)
	Get number of unmasked celles on Level-11 of the mHM model.
subroutine	get::l11_domain_shape (shp, domain)
	Get the shape of Level-11 of the mHM model.
subroutine	get::l11_domain_mask (mask, n, m, domain)
	Get the mask of Level-11 of the mHM model.
subroutine	get::l11_domain_info (ncols, nrows, ncells, xll, yll, cell_size, no_data, domain)
	Get the information of Level-11 of the mHM model.
subroutine	get::l11_variable (output, name, idx, n)
	Get a variable on Level-11 of the mHM model.
Level 2
access Level 2 information
subroutine	get::l2_domain_size (n, domain)
	Get number of unmasked celles on Level-2 of the mHM model.
subroutine	get::l2_domain_shape (shp, domain)
	Get the shape of Level-2 of the mHM model.
subroutine	get::l2_domain_mask (mask, n, m, domain)
	Get the mask of Level-2 of the mHM model.
subroutine	get::l2_domain_info (ncols, nrows, ncells, xll, yll, cell_size, no_data, domain)
	Get the information of Level-2 of the mHM model.
Meteo
set meteo values
subroutine	set::meteo (input, name, year, month, day, hour, n)
	Set a meteo variable on Level-1 of the mHM model.

Detailed Description

Module to wrap mHM with f2py to control it with Python.

Authors

Sebastian Mueller

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/.

Definition in file wrapper.f90.