mo_mrm_init Module Reference

Wrapper for initializing Routing. More...

Functions/Subroutines
subroutine, public	mrm_configuration (file_namelist, unamelist, file_namelist_param, unamelist_param)
	read mRM configuration from namelists
subroutine, public	mrm_init (file_namelist, unamelist, file_namelist_param, unamelist_param)
	Initialize all mRM variables at all levels (i.e., L0, L1, and L11).
subroutine	print_startup_message (file_namelist, file_namelist_param)
	Print mRM startup message.
subroutine	config_output
	print mRM configuration
subroutine, public	variables_default_init_routing
	Default initalization mRM related L11 variables.
subroutine, public	fluxes_states_default_init_routing (idomain)
	initialize fluxes and states with default values for mRM
subroutine	l0_check_input_routing (l0domain_idomain)
	check routing input on level-0
subroutine	variables_alloc_routing (idomain)
	allocated routing related variables

Detailed Description

Wrapper for initializing Routing.

Calling all routines to initialize all mRM variables

Authors

Luis Samaniego, Rohini Kumar and Stephan Thober

Date

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

Function/Subroutine Documentation

config_output()

subroutine mo_mrm_init::config_output

private

print mRM configuration

Authors

Robert Schweppe

Date

Jun 2018

Definition at line 362 of file mo_mrm_init.f90.

References mo_mrm_global_variables::dirgauges, mo_common_variables::dirlcover, mo_common_variables::dirmorpho, mo_common_variables::dirout, mo_mrm_global_variables::domain_mrm, mo_common_variables::domainmeta, mo_mrm_file::file_defoutput, mo_mrm_file::file_namelist_mrm, and mo_mrm_file::file_namelist_param_mrm.

Referenced by mrm_configuration().

Here is the caller graph for this function:

fluxes_states_default_init_routing()

subroutine, public mo_mrm_init::fluxes_states_default_init_routing

(

integer(i4), intent(in), optional

idomain

)

initialize fluxes and states with default values for mRM

Parameters

[in]

idomain

number of Domain (if not present, set for all)

Definition at line 453 of file mo_mrm_init.f90.

References mo_mrm_global_variables::l11_qmod, mo_mrm_global_variables::l11_qout, mo_mrm_global_variables::l11_qtin, mo_mrm_global_variables::l11_qtr, mo_mrm_global_variables::level11, and mo_common_constants::p1_initstatefluxes.

Referenced by mo_mhm_interface_run::mhm_interface_run_prepare_domain(), and variables_default_init_routing().

Here is the caller graph for this function:

l0_check_input_routing()

subroutine mo_mrm_init::l0_check_input_routing ( integer(i4), intent(in)  l0domain_idomain )

private

check routing input on level-0

Authors

Robert Schweppe

Date

Jun 2018

Parameters

[in]

l0domain_idomain

domain index for associated level-0 data

Definition at line 500 of file mo_mrm_init.f90.

References mo_mrm_global_variables::l0_facc, mo_mrm_global_variables::l0_fdir, mo_common_variables::level0, and mo_common_constants::nodata_i4.

Referenced by mrm_init().

Here is the caller graph for this function:

mrm_configuration()

subroutine, public mo_mrm_init::mrm_configuration	(	character(*), intent(in)	file_namelist,
		integer, intent(in)	unamelist,
		character(*), intent(in)	file_namelist_param,
		integer, intent(in)	unamelist_param
	)

read mRM configuration from namelists

Parameters

[in]	file_namelist	namelist file name
[in]	unamelist	unit to open namelist
[in]	file_namelist_param	parameter namelist file name
[in]	unamelist_param	unit to open parameter namelist

Definition at line 32 of file mo_mrm_init.f90.

References mo_common_mhm_mrm_read_config::check_optimization_settings(), mo_common_mhm_mrm_read_config::common_mhm_mrm_read_config(), mo_common_read_config::common_read_config(), config_output(), mo_common_mhm_mrm_variables::mrm_coupling_mode, mo_mrm_read_config::mrm_read_config(), print_startup_message(), mo_common_variables::processmatrix, and mo_mrm_global_variables::riv_temp_pcs.

Referenced by mo_mhm_interface::mhm_interface_init().

Here is the call graph for this function:

Here is the caller graph for this function:

mrm_init()

subroutine, public mo_mrm_init::mrm_init	(	character(*), intent(in)	file_namelist,
		integer, intent(in)	unamelist,
		character(*), intent(in)	file_namelist_param,
		integer, intent(in)	unamelist_param
	)

Initialize all mRM variables at all levels (i.e., L0, L1, and L11).

Initialize all mRM variables at all levels (i.e., L0, L1, and L11) either with default values or with values from restart file. The L0 mask (L0_mask), L0 elevation (L0_elev), and L0 land cover (L0_LCover) can be provided as optional variables to save memory because these variable will then not be read in again.

Changelog

• Stephan Thober Sep 2015
  • added L0_mask, L0_elev, and L0_LCover
• Stephan Thober May 2016
  • added warning message in case no gauge is found in modelling domain
• Matthias Kelbling Aug 2017
  • added L11_flow_accumulation to Initialize Stream Netwo
• Lennart Schueler May 2018
  • added initialization for groundwater coupling
• Stephan Thober Jun 2018
  • refactored for mpr_extract version
• Stephan Thober May 2019
  • added init of level0 in case of read restart

Authors

Stephan Thober

Date

Aug 2015

Parameters

[in]	file_namelist	namelist file name
[in]	unamelist	unit to open namelist
[in]	file_namelist_param	parameter namelist file name
[in]	unamelist_param	unit to open parameter namelist

Definition at line 101 of file mo_mrm_init.f90.

References mo_mrm_river_head::calc_channel_elevation(), mo_mrm_global_variables::domain_mrm, mo_common_variables::domainmeta, mo_common_variables::global_parameters, mo_mrm_global_variables::gw_coupling, mo_grid::init_lowres_level(), mo_mrm_river_head::init_masked_zeros_l0(), l0_check_input_routing(), mo_grid::l0_grid_setup(), mo_mrm_global_variables::l0_l11_remap, mo_common_variables::l0_l1_remap, mo_mrm_global_variables::l0_river_head_mon_sum, mo_mrm_net_startup::l11_flow_accumulation(), mo_mrm_net_startup::l11_flow_direction(), mo_mrm_net_startup::l11_fraction_sealed_floodplain(), mo_mrm_global_variables::l11_fromn, mo_mrm_net_startup::l11_l1_mapping(), mo_mrm_global_variables::l11_length, mo_mrm_net_startup::l11_link_location(), mo_mrm_global_variables::l11_netperm, mo_mrm_global_variables::l11_noutlets, mo_mrm_net_startup::l11_routing_order(), mo_mrm_net_startup::l11_set_drain_outlet_gauges(), mo_mrm_net_startup::l11_set_network_topology(), mo_mrm_net_startup::l11_stream_features(), mo_common_variables::level0, mo_common_variables::level1, mo_mrm_global_variables::level11, mo_common_mhm_mrm_variables::mrm_coupling_mode, mo_mrm_mpr::mrm_init_param(), mo_mrm_read_data::mrm_read_bankfull_runoff(), mo_mrm_read_data::mrm_read_discharge(), mo_mrm_read_data::mrm_read_l0_data(), mo_mrm_restart::mrm_read_restart_config(), mo_common_mhm_mrm_variables::mrm_read_river_network, mo_mrm_read_data::mrm_read_total_runoff(), mo_common_mhm_mrm_variables::mrmfilerestartin, mo_common_constants::nodata_dp, mo_common_constants::nodata_i4, mo_common_variables::processmatrix, mo_common_restart::read_grid_info(), mo_read_latlon::read_latlon(), mo_mrm_global_variables::readlatlon, mo_common_variables::resolutionhydrology, mo_common_mhm_mrm_variables::resolutionrouting, mo_mrm_global_variables::riv_temp_pcs, mo_grid::set_domain_indices(), and variables_alloc_routing().

Referenced by mo_mhm_interface::mhm_interface_init().

Here is the call graph for this function:

Here is the caller graph for this function:

print_startup_message()

subroutine mo_mrm_init::print_startup_message ( character(*), intent(in)  file_namelist, character(*), intent(in)  file_namelist_param  )

private

Print mRM startup message.

Authors

Robert Schweppe

Date

Jun 2018

Parameters

[in]	file_namelist	namelist file name
[in]	file_namelist_param	parameter namelist file name

Definition at line 315 of file mo_mrm_init.f90.

References mo_mrm_file::file_defoutput, mo_mrm_file::file_main, mo_mrm_file::version, and mo_mrm_file::version_date.

Referenced by mrm_configuration().

Here is the caller graph for this function:

variables_alloc_routing()

subroutine mo_mrm_init::variables_alloc_routing ( integer(i4), intent(in)  idomain )

private

allocated routing related variables

Authors

Robert Schweppe

Date

Jun 2018

Parameters

[in]

idomain

domain index

Definition at line 537 of file mo_mrm_init.f90.

References mo_common_variables::domainmeta, mo_mrm_global_variables::l0_celerity, mo_mrm_global_variables::l11_c1, mo_mrm_global_variables::l11_c2, mo_mrm_global_variables::l11_celerity, mo_mrm_global_variables::l11_k, mo_mrm_global_variables::l11_qmod, mo_mrm_global_variables::l11_qout, mo_mrm_global_variables::l11_qtin, mo_mrm_global_variables::l11_qtr, mo_mrm_global_variables::l11_xi, mo_common_variables::level0, mo_mrm_global_variables::level11, and mo_mrm_constants::nroutingstates.

Referenced by mrm_init().

Here is the caller graph for this function:

variables_default_init_routing()

subroutine, public mo_mrm_init::variables_default_init_routing

Default initalization mRM related L11 variables.

Default initalization of mHM related L11 variables (e.g., states, fluxes, and parameters) as per given constant values given in mo_mhm_constants. Variables initalized here is defined in the mo_global_variables.f90 file. Only Variables that are defined in the variables_alloc subroutine are intialized here. If a variable is added or removed here, then it also has to be added or removed in the subroutine state_variables_set in the module mo_restart and in the subroutine set_state in the module mo_set_netcdf_restart.

Authors

Stephan Thober, Rohini Kumar, and Juliane Mai

Date

Aug 2015

Authors

Robert Schweppe

Date

Jun 2018

Definition at line 426 of file mo_mrm_init.f90.

References fluxes_states_default_init_routing(), mo_mrm_global_variables::l11_c1, mo_mrm_global_variables::l11_c2, mo_mrm_global_variables::l11_k, mo_mrm_global_variables::l11_xi, and mo_common_constants::p1_initstatefluxes.

Referenced by mo_mhm_interface_run::mhm_interface_run_prepare().

Here is the call graph for this function:

Here is the caller graph for this function: