mo_common_mhm_mrm_variables Module Reference

Provides structures needed by mHM, mRM and/or mpr. More...

Variables
integer(i4)	mrm_coupling_mode
integer(i4), public	timestep
real(dp), public	c2tstu
real(dp), dimension(:), allocatable, public	resolutionrouting
logical, public	read_restart
logical, public	mrm_read_river_network
logical, public	read_old_style_restart_bounds
logical, public	restart_reset_fluxes_states
	flag to reset fluxes and states read from restart to default values
type(period), dimension(:), allocatable, public	warmper
type(period), dimension(:), allocatable, public	evalper
type(period), dimension(:), allocatable, public	simper
integer(i4), dimension(:), allocatable, public	warmingdays
integer(i4), dimension(:, :), allocatable, public	lcyearid
integer(i4), public	ntstepday
character(256), dimension(:), allocatable, public	mhmfilerestartin
character(256), dimension(:), allocatable, public	mrmfilerestartin
integer(i4), public	opti_method
integer(i4), public	opti_function
logical, public	optimize
logical, public	optimize_restart
integer(i8), public	seed
integer(i4), public	niterations
real(dp), public	dds_r
real(dp), public	sa_temp
integer(i4), public	sce_ngs
integer(i4), public	sce_npg
integer(i4), public	sce_nps
logical, public	mcmc_opti
integer(i4), parameter, public	nerror_model = 2
real(dp), dimension(nerror_model), public	mcmc_error_params

Detailed Description

Provides structures needed by mHM, mRM and/or mpr.

Provides the global structure period that is used by both mHM and mRM.

Changelog

• Stephan Thober Nov 2016
  • moved processdescription from mo_global_variables to here
• Robert Schweppe Dec 2017
  • merged more duplicated variables from mhm and mrm global variables
• Robert Schweppe Jun 2018
  • refactoring and reformatting

Authors

Stephan Thober

Date

Sep 2015

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

Variable Documentation

c2tstu

real(dp), public mo_common_mhm_mrm_variables::c2tstu

Definition at line 34 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_startup::constants_init(), and mo_mhm_interface_run::mhm_interface_run_do_time_step().

dds_r

real(dp), public mo_common_mhm_mrm_variables::dds_r

Definition at line 79 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::check_optimization_settings(), mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), and mo_optimization::optimization().

evalper

type(period), dimension(:), allocatable, public mo_common_mhm_mrm_variables::evalper

Definition at line 43 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_mhm_bfi::calculate_bfi(), mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_nc_output::createoutputfile(), mo_clean_up::deallocate_global_variables(), mo_mrm_objective_function_runoff::extract_runoff(), mo_mrm_read_data::mrm_read_discharge(), mo_mrm_write::mrm_write(), mo_mrm_objective_function_runoff::multi_objective_ae_fdc_lsv_nse_djf(), mo_objective_function::objective_kge_q_rmse_et(), mo_objective_function::objective_kge_q_rmse_tws(), mo_read_optional_data::readoptidataobs(), get::runoff_eval_length(), mo_write_ascii::write_configfile(), mo_mrm_write::write_configfile(), mo_mrm_write::write_daily_obs_sim_discharge(), and mo_mrm_write::write_subdaily_obs_sim_discharge().

lcyearid

integer(i4), dimension(:, :), allocatable, public mo_common_mhm_mrm_variables::lcyearid

Definition at line 46 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_common_datetime_type::datetimeinfo_init(), mo_clean_up::deallocate_global_variables(), mo_mhm_interface_run::mhm_interface_run_do_time_step(), mo_write_ascii::write_configfile(), and mo_mrm_write::write_configfile().

mcmc_error_params

real(dp), dimension(nerror_model), public mo_common_mhm_mrm_variables::mcmc_error_params

Definition at line 93 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), and mo_optimization::optimization().

mcmc_opti

logical, public mo_common_mhm_mrm_variables::mcmc_opti

Definition at line 89 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), and mo_optimization::optimization().

mhmfilerestartin

character(256), dimension(:), allocatable, public mo_common_mhm_mrm_variables::mhmfilerestartin

Definition at line 57 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_clean_up::deallocate_global_variables(), mo_startup::mhm_initialize(), and mo_mhm_interface_run::mhm_interface_run_prepare().

mrm_coupling_mode

integer(i4) mo_common_mhm_mrm_variables::mrm_coupling_mode

Definition at line 28 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_mhm_interface::mhm_interface_init(), mo_mrm_init::mrm_configuration(), mo_mrm_init::mrm_init(), mo_mrm_write::mrm_write(), and mo_mrm_write::write_configfile().

mrm_read_river_network

logical, public mo_common_mhm_mrm_variables::mrm_read_river_network

Definition at line 37 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), and mo_mrm_init::mrm_init().

mrmfilerestartin

character(256), dimension(:), allocatable, public mo_common_mhm_mrm_variables::mrmfilerestartin

Definition at line 58 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_clean_up::deallocate_global_variables(), mo_mhm_interface_run::mhm_interface_run_prepare_domain(), and mo_mrm_init::mrm_init().

nerror_model

integer(i4), parameter, public mo_common_mhm_mrm_variables::nerror_model = 2

Definition at line 91 of file mo_common_mHM_mRM_variables.f90.

niterations

integer(i4), public mo_common_mhm_mrm_variables::niterations

Definition at line 78 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::check_optimization_settings(), mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), and mo_optimization::optimization().

ntstepday

integer(i4), public mo_common_mhm_mrm_variables::ntstepday

Definition at line 51 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_mhm_bfi::calculate_bfi(), mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_common_datetime_type::datetimeinfo_init(), mo_mrm_objective_function_runoff::extract_runoff(), mo_mhm_messages::finish_message(), mo_write_fluxes_states::fluxesunit(), mo_mhm_interface_run::mhm_interface_run_do_time_step(), mo_mhm_interface_run::mhm_interface_run_update_optisim(), mo_mrm_read_data::mrm_read_discharge(), mo_mrm_write::mrm_write(), and get::runoff_eval_length().

opti_function

integer(i4), public mo_common_mhm_mrm_variables::opti_function

Definition at line 67 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_mhm_interface::mhm_interface_init(), mo_mhm_interface::mhm_interface_run_optimization(), mo_mhm_read_config::mhm_read_config(), mo_mrm_read_data::mrm_read_discharge(), mo_mrm_objective_function_runoff::multi_objective_runoff(), mo_objective_function::objective(), mo_optimization::optimization(), mo_mrm_objective_function_runoff::single_objective_runoff(), mo_mrm_objective_function_runoff::single_objective_runoff_master(), and mo_mrm_objective_function_runoff::single_objective_runoff_subprocess().

opti_method

integer(i4), public mo_common_mhm_mrm_variables::opti_method

Definition at line 63 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_optimization::optimization(), mo_mrm_objective_function_runoff::single_objective_runoff(), mo_mrm_objective_function_runoff::single_objective_runoff_master(), and mo_mrm_objective_function_runoff::single_objective_runoff_subprocess().

optimize

logical, public mo_common_mhm_mrm_variables::optimize

Definition at line 71 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mhm_driver(), mo_mhm_interface::mhm_interface_finalize(), mo_mhm_interface::mhm_interface_init(), mo_mhm_interface_run::mhm_interface_run_prepare(), mo_mhm_interface_run::mhm_interface_run_write_output(), mo_mhm_read_config::mhm_read_config(), mo_mrm_mpr::mrm_init_param(), mo_mrm_read_data::mrm_read_discharge(), mo_mrm_mpr::mrm_update_param(), and model::run_or_optimize().

optimize_restart

logical, public mo_common_mhm_mrm_variables::optimize_restart

Definition at line 73 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), and mo_optimization::optimization().

read_old_style_restart_bounds

logical, public mo_common_mhm_mrm_variables::read_old_style_restart_bounds

Definition at line 38 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), and mo_common_restart::read_nlai_and_check_dims().

read_restart

logical, public mo_common_mhm_mrm_variables::read_restart

Definition at line 36 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_startup::constants_init(), mo_startup::mhm_initialize(), mo_mhm_interface::mhm_interface_init(), mo_mhm_interface_run::mhm_interface_run_do_time_step(), mo_mhm_interface_run::mhm_interface_run_prepare(), mo_mhm_interface_run::mhm_interface_run_prepare_domain(), mo_write_ascii::write_configfile(), and mo_mrm_write::write_configfile().

resolutionrouting

real(dp), dimension(:), allocatable, public mo_common_mhm_mrm_variables::resolutionrouting

Definition at line 35 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_check_resolution(), mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_clean_up::deallocate_global_variables(), mo_mhm_interface_run::mhm_interface_run_do_time_step(), mo_mrm_init::mrm_init(), mo_mrm_mpr::mrm_init_param(), mo_mrm_mpr::mrm_update_param(), mo_write_ascii::write_configfile(), and mo_mrm_write::write_configfile().

restart_reset_fluxes_states

logical, public mo_common_mhm_mrm_variables::restart_reset_fluxes_states

flag to reset fluxes and states read from restart to default values

Definition at line 39 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_mhm_interface_run::mhm_interface_run_prepare(), and mo_mhm_interface_run::mhm_interface_run_prepare_domain().

sa_temp

real(dp), public mo_common_mhm_mrm_variables::sa_temp

Definition at line 81 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), and mo_optimization::optimization().

sce_ngs

integer(i4), public mo_common_mhm_mrm_variables::sce_ngs

Definition at line 83 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::check_optimization_settings(), mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), and mo_optimization::optimization().

sce_npg

integer(i4), public mo_common_mhm_mrm_variables::sce_npg

Definition at line 85 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::check_optimization_settings(), mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), and mo_optimization::optimization().

sce_nps

integer(i4), public mo_common_mhm_mrm_variables::sce_nps

Definition at line 87 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::check_optimization_settings(), mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), and mo_optimization::optimization().

seed

integer(i8), public mo_common_mhm_mrm_variables::seed

Definition at line 76 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), and mo_optimization::optimization().

simper

type(period), dimension(:), allocatable, public mo_common_mhm_mrm_variables::simper

Definition at line 44 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_common_datetime_type::datetimeinfo_init(), mo_clean_up::deallocate_global_variables(), mo_mhm_messages::finish_message(), mo_write_fluxes_states::fluxesunit(), mo_mhm_interface::mhm_interface_init(), mo_mhm_interface_run::mhm_interface_run_do_time_step(), mo_mrm_read_data::mrm_read_discharge(), mo_mrm_read_data::mrm_read_total_runoff(), mo_mrm_write::mrm_write(), mo_write_ascii::write_configfile(), and mo_mrm_write::write_configfile().

timestep

integer(i4), public mo_common_mhm_mrm_variables::timestep

Definition at line 33 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_startup::constants_init(), mo_nc_output::createoutputfile(), mo_common_datetime_type::datetimeinfo_increment(), mo_write_fluxes_states::fluxesunit(), mo_mhm_interface::mhm_interface_init(), mo_mhm_interface_run::mhm_interface_run_do_time_step(), mo_mhm_interface_run::mhm_interface_run_write_output(), mo_mrm_mpr::mrm_init_param(), mo_mrm_read_data::mrm_read_total_runoff(), mo_mrm_mpr::mrm_update_param(), mo_nc_output::newoutputdataset(), mo_write_ascii::write_configfile(), and mo_mrm_write::write_configfile().

warmingdays

integer(i4), dimension(:), allocatable, public mo_common_mhm_mrm_variables::warmingdays

Definition at line 45 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_mhm_bfi::calculate_bfi(), mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_clean_up::deallocate_global_variables(), mo_mrm_objective_function_runoff::extract_runoff(), mo_mhm_interface_run::mhm_interface_run_do_time_step(), mo_mhm_interface_run::mhm_interface_run_update_optisim(), mo_mrm_write::mrm_write(), and get::runoff_eval_length().

warmper

type(period), dimension(:), allocatable, public mo_common_mhm_mrm_variables::warmper

Definition at line 42 of file mo_common_mHM_mRM_variables.f90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_clean_up::deallocate_global_variables(), mo_write_ascii::write_configfile(), and mo_mrm_write::write_configfile().