run Module Reference

Python wrapper module to control a mHM model run per time step. More...

Functions/Subroutines
subroutine	prepare ()
	Prepare a mHM model run.
subroutine	get_ndomains (n)
	Get the number of domains of the current mHM model run.
subroutine	prepare_domain (domain)
	Prepare a certain domain of the current mHM model run.
subroutine	finished (output)
	Check if the current mHM model time loop is finished.
subroutine	do_time_step ()
	Do one time-step on the current domain of the current mHM model run.
subroutine	write_output ()
	Write output for the current domain of the current mHM model run.
subroutine	finalize_domain ()
	Finalize the current domain of the current mHM model run.
subroutine	finalize ()
	Finalize the current mHM model run.
subroutine	current_time (year, month, day, hour)
	Get the current time the current domain of the current mHM model run.

Detailed Description

Python wrapper module to control a mHM model run per time step.

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

current_time()

subroutine run::current_time	(	integer(i4), intent(out)	year,
		integer(i4), intent(out)	month,
		integer(i4), intent(out)	day,
		integer(i4), intent(out)	hour
	)

Get the current time the current domain of the current mHM model run.

Parameters

[out]	year	current year
[out]	month	current month
[out]	day	current day
[out]	hour	current hour

Definition at line 236 of file wrapper.f90.

References mo_common_run_variables::run_cfg.

do_time_step()

subroutine run::do_time_step

Do one time-step on the current domain of the current mHM model run.

Definition at line 208 of file wrapper.f90.

References mo_mhm_interface_run::mhm_interface_run_do_time_step().

Here is the call graph for this function:

finalize()

subroutine run::finalize

Finalize the current mHM model run.

Definition at line 229 of file wrapper.f90.

References mo_mhm_interface_run::mhm_interface_run_finalize().

Here is the call graph for this function:

finalize_domain()

subroutine run::finalize_domain

Finalize the current domain of the current mHM model run.

Definition at line 222 of file wrapper.f90.

References mo_mhm_interface_run::mhm_interface_run_finalize_domain().

Here is the call graph for this function:

finished()

subroutine run::finished

(

logical, intent(out)

output

)

Check if the current mHM model time loop is finished.

Parameters

[out]

output

whether the current time loop finished

Definition at line 200 of file wrapper.f90.

References mo_mhm_interface_run::mhm_interface_run_finished().

Here is the call graph for this function:

get_ndomains()

subroutine run::get_ndomains

(

integer(i4), intent(out)

n

)

Get the number of domains of the current mHM model run.

Parameters

[out]

n

number of domains

Definition at line 183 of file wrapper.f90.

References mo_mhm_interface_run::mhm_interface_run_get_ndomains().

Here is the call graph for this function:

prepare()

subroutine run::prepare

Prepare a mHM model run.

Definition at line 176 of file wrapper.f90.

References mo_mhm_interface_run::mhm_interface_run_prepare().

Here is the call graph for this function:

prepare_domain()

subroutine run::prepare_domain

(

integer(i4), intent(in)

domain

)

Prepare a certain domain of the current mHM model run.

Parameters

[in]

domain

domain index (1 based and 1 by default)

Definition at line 191 of file wrapper.f90.

References mo_mhm_interface_run::mhm_interface_run_prepare_domain().

Here is the call graph for this function:

write_output()

subroutine run::write_output

Write output for the current domain of the current mHM model run.

Definition at line 215 of file wrapper.f90.

References mo_mhm_interface_run::mhm_interface_run_write_output().

Here is the call graph for this function: