mo_common_restart Module Reference

common restart tools More...

Data Types
interface	check_consistency_element
	check consistency of two given items More...

Functions/Subroutines
subroutine, public	write_grid_info (grid_in, level_name, nc)
	write restart files for each domain
subroutine, public	read_grid_info (infile, level_name, new_grid)
	reads configuration apart from Level 11 configuration from a restart directory
subroutine, public	read_nlai_and_check_dims (idomain, infile)
	read nubmer of LAI time steps and check dimension configurations read from restart file
subroutine	check_dimension_consistency (idomain, nsoilhorizons_temp, soilhorizonboundaries_temp, nlais_temp, laiboundaries_temp, nlandcoverperiods_temp, landcoverperiodboundaries_temp)
	checks dimension configurations read from restart file
subroutine	check_consistency_element_dp (item1, item2, name, idomain)
	check consistency of two given items
subroutine	check_consistency_element_i4 (item1, item2, name, idomain)
	check consistency of two given items

Detailed Description

common restart tools

Routines to deal with grid infos for restart files

Authors

Robert Schweppe

Date

Jun 2018

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

check_consistency_element_dp()

subroutine mo_common_restart::check_consistency_element_dp ( real(dp), intent(in)  item1, real(dp), intent(in)  item2, character(*), intent(in)  name, integer(i4), intent(in)  idomain  )

private

check consistency of two given items

Definition at line 378 of file mo_common_restart.f90.

check_consistency_element_i4()

subroutine mo_common_restart::check_consistency_element_i4 ( integer(i4), intent(in)  item1, integer(i4), intent(in)  item2, character(*), intent(in)  name, integer(i4), intent(in)  idomain  )

private

check consistency of two given items

Definition at line 397 of file mo_common_restart.f90.

check_dimension_consistency()

subroutine mo_common_restart::check_dimension_consistency ( integer(i4), intent(in)  idomain, integer(i4), intent(in)  nsoilhorizons_temp, real(dp), dimension(:), intent(inout)  soilhorizonboundaries_temp, integer(i4), intent(in)  nlais_temp, real(dp), dimension(:), intent(inout)  laiboundaries_temp, integer(i4), intent(in)  nlandcoverperiods_temp, real(dp), dimension(:), intent(inout)  landcoverperiodboundaries_temp  )

private

checks dimension configurations read from restart file

Authors

Robert Schweppe

Date

Aug 2019

Definition at line 333 of file mo_common_restart.f90.

References mo_mpr_global_variables::horizondepth_mhm, mo_mpr_global_variables::laiboundaries, mo_common_variables::lc_year_end, mo_common_variables::lc_year_start, mo_mpr_global_variables::nlai, mo_common_variables::nlcoverscene, and mo_mpr_global_variables::nsoilhorizons_mhm.

Referenced by read_nlai_and_check_dims().

Here is the caller graph for this function:

read_grid_info()

subroutine, public mo_common_restart::read_grid_info	(	character(256), intent(in)	infile,
		character(*), intent(in)	level_name,
		type(grid), intent(inout)	new_grid
	)

reads configuration apart from Level 11 configuration from a restart directory

read configuration variables from a given restart directory and initializes all configuration variables, that are initialized in the subroutine initialise, contained in module mo_startup.

Changelog

• David Schaefer Nov 2015
  • mo_netcdf
• Zink M. Demirel C. Mar 2017
  • Added Jarvis soil water stress function at SM process(3)
• Robert Schweppe Feb 2018
  • Removed all L0 references
• Robert Schweppe Jun 2018
  • refactoring and reformatting
• Stephan Thober May 2019
  • added allocation check for mask and cellArea because cellArea needs to be read by mRM, but mask is created before by mHM

Authors

Stephan Thober

Date

Apr 2013

Parameters

[in]	infile	Input Path including trailing slash
[in]	level_name	level_name (id)
[in,out]	new_grid	grid to save information to

Definition at line 141 of file mo_common_restart.f90.

Referenced by mo_startup::mhm_initialize(), and mo_mrm_init::mrm_init().

Here is the caller graph for this function:

read_nlai_and_check_dims()

subroutine, public mo_common_restart::read_nlai_and_check_dims	(	integer(i4), intent(in)	idomain,
		character(256), intent(in)	infile
	)

read nubmer of LAI time steps and check dimension configurations read from restart file

Author

Robert Schweppe

Date

Aug 2019

Author

Sebastian Mueller

Date

Feb 2023

Parameters

[in]	idomain	domain counter (not ID)
[in]	infile	Input Path including trailing slash

Definition at line 222 of file mo_common_restart.f90.

References check_dimension_consistency(), mo_mpr_global_variables::laiboundaries, mo_common_constants::laivarname, mo_common_constants::landcoverperiodsvarname, mo_mpr_global_variables::nlai, mo_common_mhm_mrm_variables::read_old_style_restart_bounds, and mo_common_constants::soilhorizonsvarname.

Referenced by mo_startup::mhm_initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

write_grid_info()

subroutine, public mo_common_restart::write_grid_info	(	type(grid), intent(in)	grid_in,
		character(*), intent(in)	level_name,
		type(ncdataset), intent(inout)	nc
	)

write restart files for each domain

write restart files for each domain. For each domain three restart files are written. These are xxx_states.nc, xxx_L11_config.nc, and xxx_config.nc (xxx being the three digit domain index). If a variable is added here, it should also be added in the read restart routines below.

Changelog

• Stephan Thober Aug 2015
  • moved write of routing states to mRM
• David Schaefer Nov 2015
  • mo_netcdf
• Stephan Thober Nov 2016
  • moved processMatrix to common variables
• Zink M. Demirel C. Mar 2017
  • Added Jarvis soil water stress function at SM process(3)
• Robert Schweppe Feb 2018
  • Removed all L0 references
• Robert Schweppe Jun 2018
  • refactoring and reformatting
• Stephan Thober May 2019
  • where statement for gnu73 to translate level0 mask

Authors

Stephan Thober

Date

Jun 2014

Parameters

[in]	grid_in	level to be written
[in]	level_name	level_id
[in,out]	nc	NcDataset to write information to

Definition at line 58 of file mo_common_restart.f90.

References mo_common_constants::nodata_dp, and mo_common_constants::nodata_i4.

Referenced by mo_mrm_restart::mrm_write_restart(), mo_mpr_restart::write_mpr_restart_files(), and mo_restart::write_restart_files().

Here is the caller graph for this function: