mo_common_variables Module Reference

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

Variables
integer(i4)	itimer
character(1024), public	project_details
	project including funding instituion., PI, etc.
character(1024), public	setup_description
	any specific description of simulation
character(1024), public	simulation_type
	e.g.
character(256), public	conventions
	convention used for dataset
character(1024), public	contact
	contact details, incl.
character(1024), public	mhm_details
	developing institution, specific mHM revision
character(1024), public	history
	details on version/creation date
integer(i4), public	iflag_cordinate_sys
real(dp), dimension(:), allocatable, public	resolutionhydrology
integer(i4), dimension(:), allocatable, public	l0_domain
logical, public	write_restart
character(256), dimension(:), allocatable, public	mhmfilerestartout
character(256), dimension(:), allocatable, public	mrmfilerestartout
character(256), public	dirconfigout
character(256), public	dircommonfiles
character(256), dimension(:), allocatable, public	dirmorpho
character(256), dimension(:), allocatable, public	dirlcover
character(256), dimension(:), allocatable, public	dirout
character(256), dimension(:), allocatable, public	filelatlon
type(grid), dimension(:), allocatable, target, public	level0
type(grid), dimension(:), allocatable, target, public	level1
type(gridremapper), dimension(:), allocatable, public	l0_l1_remap
real(dp), dimension(:), allocatable, public	l0_elev
integer(i4), dimension(:, :), allocatable, public	l0_lcover
type(domain_meta), public	domainmeta
integer(i4), public	nuniquel0domains
integer(i4), public	nlcoverscene
character(256), dimension(:), allocatable, public	lcfilename
integer(i4), dimension(:), allocatable, public	lc_year_start
integer(i4), dimension(:), allocatable, public	lc_year_end
integer(i4), parameter, public	nprocesses = 11
integer(i4), dimension(nprocesses, 3), public	processmatrix
real(dp), dimension(:, :), allocatable, target, public	global_parameters
character(256), dimension(:), allocatable, public	global_parameters_name
logical	alma_convention

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

Variable Documentation

alma_convention

logical mo_common_variables::alma_convention

Definition at line 147 of file mo_common_variables.F90.

Referenced by mo_mrm_read_config::mrm_read_config(), and mo_mrm_read_data::mrm_read_total_runoff().

contact

character(1024), public mo_common_variables::contact

contact details, incl.

PI name

Definition at line 45 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), and mo_nc_output::createoutputfile().

conventions

character(256), public mo_common_variables::conventions

convention used for dataset

Definition at line 44 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), and mo_nc_output::createoutputfile().

dircommonfiles

character(256), public mo_common_variables::dircommonfiles

Definition at line 64 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), and mo_read_wrapper::read_data().

dirconfigout

character(256), public mo_common_variables::dirconfigout

Definition at line 63 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), mo_mhm_interface::mhm_interface_run_optimization(), mo_mrm_write::mrm_write_optifile(), mo_mrm_write::mrm_write_optinamelist(), mo_optimization::optimization(), mo_mrm_write::write_configfile(), mo_write_ascii::write_configfile(), mo_write_ascii::write_optifile(), and mo_write_ascii::write_optinamelist().

dirlcover

character(256), dimension(:), allocatable, public mo_common_variables::dirlcover

Definition at line 66 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), mo_mrm_init::config_output(), mo_clean_up::deallocate_global_variables(), mo_mhm_messages::domain_dir_check_message(), mo_common_read_data::read_lcover(), mo_mrm_write::write_configfile(), and mo_write_ascii::write_configfile().

dirmorpho

character(256), dimension(:), allocatable, public mo_common_variables::dirmorpho

Definition at line 65 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), mo_mrm_init::config_output(), mo_clean_up::deallocate_global_variables(), mo_mhm_messages::domain_dir_check_message(), mo_mrm_read_data::mrm_read_l0_data(), mo_read_wrapper::read_data(), mo_common_read_data::read_dem(), mo_mrm_write::write_configfile(), and mo_write_ascii::write_configfile().

dirout

character(256), dimension(:), allocatable, public mo_common_variables::dirout

Definition at line 67 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), mo_mrm_init::config_output(), mo_nc_output::createoutputfile(), mo_clean_up::deallocate_global_variables(), mo_mhm_messages::domain_dir_check_message(), mo_mrm_write::write_configfile(), mo_write_ascii::write_configfile(), mo_mrm_write::write_daily_obs_sim_discharge(), and mo_mrm_write::write_subdaily_obs_sim_discharge().

domainmeta

type(domain_meta), public mo_common_variables::domainmeta

Definition at line 99 of file mo_common_variables.F90.

Referenced by mo_mrm_river_head::calc_channel_elevation(), mo_mhm_bfi::calculate_bfi(), mo_mrm_net_startup::celllength(), mo_common_mhm_mrm_read_config::common_check_resolution(), mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_common_read_config::common_read_config(), mo_mrm_riv_temp_class::config(), mo_mrm_init::config_output(), mo_clean_up::deallocate_global_variables(), mo_mhm_messages::domain_dir_check_message(), mo_mhm_messages::finish_message(), get::l0_variable(), set::l0_variable(), mo_mrm_net_startup::l11_calc_celerity(), mo_mrm_net_startup::l11_flow_direction(), mo_mrm_net_startup::l11_fraction_sealed_floodplain(), mo_mrm_net_startup::l11_link_location(), mo_mrm_net_startup::l11_set_drain_outlet_gauges(), mo_mrm_net_startup::l11_stream_features(), set::meteo(), mo_startup::mhm_initialize(), mo_mhm_interface::mhm_interface_finalize(), mo_mhm_interface::mhm_interface_init(), mo_mhm_interface::mhm_interface_run(), mo_mhm_interface_run::mhm_interface_run_do_time_step(), mo_mhm_interface_run::mhm_interface_run_finalize_domain(), mo_mhm_interface::mhm_interface_run_optimization(), mo_mhm_interface_run::mhm_interface_run_prepare(), mo_mhm_interface_run::mhm_interface_run_prepare_domain(), mo_mhm_interface_run::mhm_interface_run_write_output(), mo_mhm_read_config::mhm_read_config(), mo_mpr_eval::mpr_eval(), mo_mpr_startup::mpr_initialize(), mo_mpr_read_config::mpr_read_config(), mo_mrm_init::mrm_init(), mo_mrm_mpr::mrm_init_param(), mo_mrm_read_config::mrm_read_config(), mo_mrm_read_data::mrm_read_discharge(), mo_mrm_read_data::mrm_read_l0_data(), mo_mrm_restart::mrm_read_restart_config(), mo_mrm_write::mrm_write(), mo_mrm_restart::mrm_write_restart(), mo_objective_function::objective(), mo_objective_function::objective_et_kge_catchment_avg(), mo_objective_function::objective_kge_q_bfi(), mo_objective_function::objective_kge_q_et(), mo_objective_function::objective_kge_q_rmse_et(), mo_objective_function::objective_kge_q_rmse_tws(), mo_objective_function::objective_kge_q_sm_corr(), mo_objective_function::objective_neutrons_kge_catchment_avg(), mo_objective_function::objective_q_et_tws_kge_catchment_avg(), mo_objective_function::objective_sm_corr(), mo_objective_function::objective_sm_kge_catchment_avg(), mo_objective_function::objective_sm_pd(), mo_objective_function::objective_sm_sse_standard_score(), mo_optimization::optimization(), mo_read_wrapper::read_data(), mo_common_read_data::read_dem(), mo_common_read_data::read_lcover(), mo_common_read_config::set_land_cover_scenes_id(), mo_mrm_objective_function_runoff::single_objective_runoff_master(), mo_mrm_objective_function_runoff::single_objective_runoff_subprocess(), mo_mrm_init::variables_alloc_routing(), mo_mrm_write::write_configfile(), mo_write_ascii::write_configfile(), mo_mrm_write::write_daily_obs_sim_discharge(), mo_mpr_restart::write_mpr_restart_files(), mo_restart::write_restart_files(), and mo_mrm_write::write_subdaily_obs_sim_discharge().

filelatlon

character(256), dimension(:), allocatable, public mo_common_variables::filelatlon

Definition at line 68 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), mo_clean_up::deallocate_global_variables(), and mo_read_latlon::read_latlon().

global_parameters

real(dp), dimension(:, :), allocatable, target, public mo_common_variables::global_parameters

Definition at line 135 of file mo_common_variables.F90.

Referenced by mo_common_mhm_mrm_read_config::check_optimization_settings(), mo_clean_up::deallocate_global_variables(), mo_mrm_objective_function_runoff::loglikelihood_evin2013_2(), mo_mhm_interface::mhm_interface_get_parameter(), mo_mhm_interface::mhm_interface_get_parameter_number(), mo_mhm_interface::mhm_interface_run(), mo_mhm_interface::mhm_interface_run_optimization(), mo_mhm_interface_run::mhm_interface_run_prepare(), mo_multi_param_reg::mpr(), mo_mpr_read_config::mpr_read_config(), mo_mrm_init::mrm_init(), mo_optimization::optimization(), get::parameter_config(), mo_read_wrapper::read_data(), mo_mrm_read_config::read_mrm_routing_params(), mo_mrm_write::write_configfile(), and mo_write_ascii::write_configfile().

global_parameters_name

character(256), dimension(:), allocatable, public mo_common_variables::global_parameters_name

Definition at line 139 of file mo_common_variables.F90.

Referenced by mo_clean_up::deallocate_global_variables(), mo_mhm_interface::mhm_interface_run_optimization(), mo_mpr_read_config::mpr_read_config(), get::parameter_name(), mo_mrm_read_config::read_mrm_routing_params(), mo_mrm_write::write_configfile(), and mo_write_ascii::write_configfile().

history

character(1024), public mo_common_variables::history

details on version/creation date

Definition at line 47 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), and mo_nc_output::createoutputfile().

iflag_cordinate_sys

integer(i4), public mo_common_variables::iflag_cordinate_sys

Definition at line 52 of file mo_common_variables.F90.

Referenced by mo_mrm_river_head::calc_slope(), mo_common_read_config::common_read_config(), mo_nc_output::createoutputfile(), mo_nc_output::data_dims(), mo_common_grid::l0_grid_setup(), mo_mrm_net_startup::l11_stream_features(), mo_mrm_mpr::mrm_init_param(), mo_mrm_mpr::mrm_update_param(), and mo_write_ascii::write_configfile().

itimer

integer(i4) mo_common_variables::itimer

Definition at line 36 of file mo_common_variables.F90.

Referenced by mo_mhm_interface::mhm_interface_finalize(), mo_mhm_interface::mhm_interface_init(), mo_mhm_interface::mhm_interface_run(), mo_mhm_interface::mhm_interface_run_optimization(), mo_mpr_eval::mpr_eval(), mo_optimization::optimization(), and mo_read_wrapper::read_data().

l0_domain

integer(i4), dimension(:), allocatable, public mo_common_variables::l0_domain

Definition at line 54 of file mo_common_variables.F90.

Referenced by mo_clean_up::deallocate_global_variables().

l0_elev

real(dp), dimension(:), allocatable, public mo_common_variables::l0_elev

Definition at line 83 of file mo_common_variables.F90.

Referenced by mo_mrm_river_head::calc_channel_elevation(), mo_clean_up::deallocate_global_variables(), mo_mpr_startup::l0_check_input(), mo_mrm_net_startup::l11_stream_features(), and mo_common_read_data::read_dem().

l0_l1_remap

type(gridremapper), dimension(:), allocatable, public mo_common_variables::l0_l1_remap

Definition at line 76 of file mo_common_variables.F90.

Referenced by mo_clean_up::deallocate_global_variables(), mo_mpr_eval::mpr_eval(), mo_mpr_startup::mpr_initialize(), and mo_mrm_init::mrm_init().

l0_lcover

integer(i4), dimension(:, :), allocatable, public mo_common_variables::l0_lcover

Definition at line 85 of file mo_common_variables.F90.

Referenced by mo_clean_up::deallocate_global_variables(), mo_mpr_startup::l0_check_input(), mo_mrm_net_startup::l11_fraction_sealed_floodplain(), mo_mpr_eval::mpr_eval(), mo_mrm_read_data::mrm_read_l0_data(), and mo_common_read_data::read_lcover().

lc_year_end

integer(i4), dimension(:), allocatable, public mo_common_variables::lc_year_end

Definition at line 109 of file mo_common_variables.F90.

Referenced by mo_common_restart::check_dimension_consistency(), mo_common_read_config::common_read_config(), mo_clean_up::deallocate_global_variables(), mo_mrm_restart::mrm_write_restart(), mo_restart::read_restart_states(), mo_common_read_config::set_land_cover_scenes_id(), mo_mrm_write::write_configfile(), mo_write_ascii::write_configfile(), mo_mpr_restart::write_eff_params(), mo_mpr_restart::write_mpr_restart_files(), and mo_restart::write_restart_files().

lc_year_start

integer(i4), dimension(:), allocatable, public mo_common_variables::lc_year_start

Definition at line 108 of file mo_common_variables.F90.

Referenced by mo_common_restart::check_dimension_consistency(), mo_common_read_config::common_read_config(), mo_clean_up::deallocate_global_variables(), mo_mrm_restart::mrm_write_restart(), mo_restart::read_restart_states(), mo_common_read_config::set_land_cover_scenes_id(), mo_mrm_write::write_configfile(), mo_write_ascii::write_configfile(), mo_mpr_restart::write_eff_params(), mo_mpr_restart::write_mpr_restart_files(), and mo_restart::write_restart_files().

lcfilename

character(256), dimension(:), allocatable, public mo_common_variables::lcfilename

Definition at line 107 of file mo_common_variables.F90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_common_read_config::common_read_config(), mo_clean_up::deallocate_global_variables(), mo_common_read_data::read_lcover(), mo_mrm_write::write_configfile(), and mo_write_ascii::write_configfile().

level0

type(grid), dimension(:), allocatable, target, public mo_common_variables::level0

Definition at line 73 of file mo_common_variables.F90.

Referenced by mo_mrm_river_head::calc_channel_elevation(), mo_mrm_net_startup::celllength(), mo_clean_up::deallocate_global_variables(), mo_mrm_write_fluxes_states::gw_outputdataset(), mo_mrm_river_head::init_masked_zeros_l0(), mo_mpr_startup::l0_check_input(), mo_mrm_init::l0_check_input_routing(), get::l0_domain_info(), get::l0_domain_mask(), get::l0_domain_shape(), get::l0_domain_size(), get::l0_variable(), set::l0_variable(), mo_mpr_startup::l0_variable_init(), mo_mrm_net_startup::l11_calc_celerity(), mo_mrm_net_startup::l11_flow_direction(), mo_mrm_net_startup::l11_fraction_sealed_floodplain(), mo_mrm_net_startup::l11_link_location(), mo_mrm_net_startup::l11_set_drain_outlet_gauges(), mo_mrm_net_startup::l11_stream_features(), mo_startup::mhm_initialize(), mo_mhm_interface::mhm_interface_init(), mo_mhm_interface_run::mhm_interface_run_write_output(), mo_mpr_eval::mpr_eval(), mo_mpr_startup::mpr_initialize(), mo_mrm_init::mrm_init(), mo_mrm_read_data::mrm_read_l0_data(), mo_mrm_restart::mrm_read_restart_config(), mo_mrm_restart::mrm_write_restart(), mo_read_wrapper::read_data(), mo_common_read_data::read_dem(), mo_common_read_data::read_lcover(), mo_mrm_init::variables_alloc_routing(), mo_mrm_write::write_configfile(), mo_write_ascii::write_configfile(), and mo_restart::write_restart_files().

level1

type(grid), dimension(:), allocatable, target, public mo_common_variables::level1

Definition at line 74 of file mo_common_variables.F90.

Referenced by mo_clean_up::deallocate_global_variables(), mo_mrm_net_startup::l11_l1_mapping(), get::l1_domain_info(), get::l1_domain_mask(), get::l1_domain_shape(), get::l1_domain_size(), set::meteo(), 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_domain(), mo_write_fluxes_states::mhm_outputdataset(), mo_mpr_eval::mpr_eval(), mo_mpr_startup::mpr_initialize(), mo_mrm_init::mrm_init(), mo_mrm_restart::mrm_read_restart_config(), mo_mrm_read_data::mrm_read_total_runoff(), mo_mrm_restart::mrm_write_restart(), mo_objective_function::objective_kge_q_bfi(), mo_objective_function::objective_kge_q_et(), mo_objective_function::objective_kge_q_sm_corr(), mo_objective_function::objective_sm_corr(), mo_objective_function::objective_sm_kge_catchment_avg(), mo_objective_function::objective_sm_pd(), mo_objective_function::objective_sm_sse_standard_score(), mo_restart::read_restart_states(), mo_read_optional_data::readoptidataobs(), mo_mrm_write::write_configfile(), mo_write_ascii::write_configfile(), mo_mpr_restart::write_mpr_restart_files(), and mo_restart::write_restart_files().

mhm_details

character(1024), public mo_common_variables::mhm_details

developing institution, specific mHM revision

Definition at line 46 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), and mo_nc_output::createoutputfile().

mhmfilerestartout

character(256), dimension(:), allocatable, public mo_common_variables::mhmfilerestartout

Definition at line 61 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), mo_clean_up::deallocate_global_variables(), mo_mhm_interface::mhm_interface_finalize(), and mo_write_ascii::write_configfile().

mrmfilerestartout

character(256), dimension(:), allocatable, public mo_common_variables::mrmfilerestartout

Definition at line 62 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), mo_clean_up::deallocate_global_variables(), mo_mrm_write::mrm_write(), and mo_mrm_write::write_configfile().

nlcoverscene

integer(i4), public mo_common_variables::nlcoverscene

Definition at line 106 of file mo_common_variables.F90.

Referenced by mo_common_restart::check_dimension_consistency(), mo_common_read_config::common_read_config(), mo_mpr_startup::init_eff_params(), mo_mpr_startup::l0_check_input(), mo_mrm_net_startup::l11_fraction_sealed_floodplain(), mo_mrm_restart::mrm_read_restart_states(), mo_mrm_restart::mrm_write_restart(), mo_common_read_data::read_lcover(), mo_restart::read_restart_states(), mo_common_read_config::set_land_cover_scenes_id(), mo_mrm_write::write_configfile(), mo_write_ascii::write_configfile(), mo_mpr_restart::write_mpr_restart_files(), and mo_restart::write_restart_files().

nprocesses

integer(i4), parameter, public mo_common_variables::nprocesses = 11

Definition at line 114 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), mo_meteo_handler::config(), and mo_write_ascii::write_optinamelist().

nuniquel0domains

integer(i4), public mo_common_variables::nuniquel0domains

Definition at line 100 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config().

processmatrix

integer(i4), dimension(nprocesses, 3), public mo_common_variables::processmatrix

Definition at line 126 of file mo_common_variables.F90.

Referenced by mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_common_read_config::common_read_config(), mo_startup::constants_init(), mo_mhm_messages::domain_dir_check_message(), mo_mrm_net_startup::l11_stream_features(), mo_mhm_interface::mhm_interface_finalize(), mo_mhm_interface::mhm_interface_init(), mo_mhm_interface_run::mhm_interface_run_do_time_step(), mo_mhm_interface_run::mhm_interface_run_finalize(), mo_mhm_interface::mhm_interface_run_optimization(), mo_mhm_interface_run::mhm_interface_run_prepare(), mo_mhm_interface_run::mhm_interface_run_prepare_domain(), mo_mhm_read_config::mhm_read_config(), mo_multi_param_reg::mpr(), mo_mpr_read_config::mpr_read_config(), mo_mrm_init::mrm_configuration(), mo_mrm_init::mrm_init(), mo_mrm_mpr::mrm_init_param(), mo_mrm_read_config::mrm_read_config(), mo_mrm_read_data::mrm_read_l0_data(), mo_mrm_restart::mrm_read_restart_config(), mo_mrm_mpr::mrm_update_param(), mo_mrm_write::mrm_write_optinamelist(), mo_mrm_restart::mrm_write_restart(), mo_read_wrapper::read_data(), mo_mrm_read_config::read_mrm_routing_params(), mo_restart::read_restart_states(), mo_mrm_write::write_configfile(), mo_write_ascii::write_configfile(), mo_mpr_restart::write_eff_params(), and mo_write_ascii::write_optinamelist().

project_details

character(1024), public mo_common_variables::project_details

project including funding instituion., PI, etc.

Definition at line 41 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), and mo_nc_output::createoutputfile().

resolutionhydrology

real(dp), dimension(:), allocatable, public mo_common_variables::resolutionhydrology

Definition at line 53 of file mo_common_variables.F90.

Referenced by mo_common_mhm_mrm_read_config::common_check_resolution(), mo_common_read_config::common_read_config(), mo_clean_up::deallocate_global_variables(), mo_mhm_interface_run::mhm_interface_run_do_time_step(), mo_mpr_startup::mpr_initialize(), mo_mrm_init::mrm_init(), mo_common_read_data::read_dem(), mo_mrm_write::write_configfile(), and mo_write_ascii::write_configfile().

setup_description

character(1024), public mo_common_variables::setup_description

any specific description of simulation

Definition at line 42 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), and mo_nc_output::createoutputfile().

simulation_type

character(1024), public mo_common_variables::simulation_type

e.g.

seasonal forecast, climate projection, ...

Definition at line 43 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), and mo_nc_output::createoutputfile().

write_restart

logical, public mo_common_variables::write_restart

Definition at line 55 of file mo_common_variables.F90.

Referenced by mo_common_read_config::common_read_config(), mo_mhm_interface::mhm_interface_finalize(), mo_mrm_write::mrm_write(), mo_mrm_write::write_configfile(), and mo_write_ascii::write_configfile().