Python wrapper module to control a mHM model. More...

Functions/Subroutines
subroutine	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	init (namelist_mhm, namelist_mhm_param, namelist_mhm_output, namelist_mrm_output, cwd)
	Initialize a mHM model.

subroutine	run ()
	Execute a mHM model.

subroutine	disable_output ()
	disable all mHM/mRM outputs during runtime.

subroutine	run_with_parameter (parameter, n)
	Execute a mHM model with given parameters.

subroutine	run_or_optimize ()
	Execute a mHM model or an optimization depending on the configuration.

subroutine	version (ver_string)
	Get the mHM version.

subroutine	finalize ()
	Finalize a mHM model.

subroutine	set_verbosity (level)
	Set verbosity level of mHM.

Detailed Description

Python wrapper module to control a mHM model.

Date: Nov 2022

Copyright: Copyright 2005-2025 , 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

◆ config_coupling()

subroutine model::config_coupling	(	integer(i4), intent(in)	couple_case,
		integer(i4), intent(in)	meteo_timestep,
		logical, intent(in)	meteo_time_ref_endpoint,
		logical, intent(in)	meteo_expect_pre,
		logical, intent(in)	meteo_expect_temp,
		logical, intent(in)	meteo_expect_pet,
		logical, intent(in)	meteo_expect_tmin,
		logical, intent(in)	meteo_expect_tmax,
		logical, intent(in)	meteo_expect_netrad,
		logical, intent(in)	meteo_expect_absvappress,
		logical, intent(in)	meteo_expect_windspeed,
		logical, intent(in)	meteo_expect_ssrd,
		logical, intent(in)	meteo_expect_strd,
		logical, intent(in)	meteo_expect_tann )

Configure coupling mode of mHM.

This will prevent reading the "coupling" namelist.

Parameters

[in]	couple_case	coupling case
[in]	meteo_timestep	timestep for meteo-data from coupling
[in]	meteo_time_ref_endpoint	expect meteo has time reference point at end of time interval
[in]	meteo_expect_pre	expect meteo from coupling: [mm] Precipitation
[in]	meteo_expect_temp	expect meteo from coupling: [degC] Air temperature
[in]	meteo_expect_pet	expect meteo from coupling: [mm TS-1] Potential evapotranspiration
[in]	meteo_expect_tmin	expect meteo from coupling: [degC] minimum daily air temperature
[in]	meteo_expect_tmax	expect meteo from coupling: [degC] maximum daily air temperature
[in]	meteo_expect_netrad	expect meteo from coupling: [W m2] net radiation
[in]	meteo_expect_absvappress	expect meteo from coupling: [Pa] absolute vapour pressure
[in]	meteo_expect_windspeed	expect meteo from coupling: [m s-1] windspeed
[in]	meteo_expect_ssrd	expect meteo from coupling: [W m2] short wave radiation
[in]	meteo_expect_strd	expect meteo from coupling: [W m2] long wave radiation
[in]	meteo_expect_tann	expect meteo from coupling: [degC] annual mean air temperature

Definition at line 20 of file wrapper.f90.

References mo_global_variables::couple_cfg.

◆ disable_output()

subroutine model::disable_output

disable all mHM/mRM outputs during runtime.

Definition at line 109 of file wrapper.f90.

References mo_global_variables::outputflxstate, and mo_mrm_global_variables::outputflxstate_mrm.

◆ finalize()

subroutine model::finalize

Finalize a mHM model.

Definition at line 151 of file wrapper.f90.

References mo_mhm_interface::mhm_interface_finalize().

Here is the call graph for this function:

◆ init()

subroutine model::init	(	character(*), intent(in)	namelist_mhm,
		character(*), intent(in)	namelist_mhm_param,
		character(*), intent(in)	namelist_mhm_output,
		character(*), intent(in)	namelist_mrm_output,
		character(*), intent(in)	cwd )

Initialize a mHM model.

Parameters

[in]	namelist_mhm	path to mHM configuration namelist
[in]	namelist_mhm_param	path to mHM parameter namelist
[in]	namelist_mhm_output	path to mHM output namelist
[in]	namelist_mrm_output	path to mRM output namelist
[in]	cwd	desired working directory

Definition at line 85 of file wrapper.f90.

References mo_mhm_interface::mhm_interface_init().

Here is the call graph for this function:

◆ run()

subroutine model::run

Execute a mHM model.

Definition at line 102 of file wrapper.f90.

References mo_mhm_interface::mhm_interface_run().

Here is the call graph for this function:

◆ run_or_optimize()

subroutine model::run_or_optimize

Execute a mHM model or an optimization depending on the configuration.

Definition at line 127 of file wrapper.f90.

References mo_mhm_interface::mhm_interface_run(), mo_mhm_interface::mhm_interface_run_optimization(), and mo_common_mhm_mrm_variables::optimize.

Here is the call graph for this function:

◆ run_with_parameter()

subroutine model::run_with_parameter	(	real(dp), dimension(n), intent(in)	parameter,
		integer(i4)	n )

Execute a mHM model with given parameters.

Parameters

n	number of parameters

Definition at line 118 of file wrapper.f90.

References mo_mhm_eval::mhm_eval().

Here is the call graph for this function:

◆ set_verbosity()

subroutine model::set_verbosity ( integer(i4), intent(in) level )

Set verbosity level of mHM.

Parameters

[in] level verbosity level (0, 1, 2)

Definition at line 158 of file wrapper.f90.

References mo_mhm_cli::set_verbosity_level().

Here is the call graph for this function:

◆ version()

subroutine model::version ( character(64), intent(out) ver_string )

Get the mHM version.

Definition at line 143 of file wrapper.f90.

References mo_file::version.

Referenced by mhm::__getattr__().

Here is the caller graph for this function:

Functions/Subroutines

Detailed Description

Function/Subroutine Documentation

◆ config_coupling()

◆ disable_output()

◆ finalize()

◆ init()

◆ run()

◆ run_or_optimize()

◆ run_with_parameter()

◆ set_verbosity()

◆ version()