mo_init_states Module Reference

Initialization of all state variables of mHM. More...

Functions/Subroutines
subroutine, public	variables_alloc (ncells1)
	Allocation of space for mHM related L1 and L11 variables.
subroutine, public	variables_default_init
	Default initalization mHM related L1 variables.
subroutine, public	fluxes_states_default_init
	initialize fluxes and states with default values

Detailed Description

Initialization of all state variables of mHM.

This module initializes all state variables required to run mHM.

  Two options are provided:
  - (1) default values
  - (2) from nc file

Authors

Luis Samaniego & Rohini Kumar

Date

Dec 2012

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

Function/Subroutine Documentation

fluxes_states_default_init()

subroutine, public mo_init_states::fluxes_states_default_init

initialize fluxes and states with default values

Authors

Sebastian Müller

Date

Mar 2023

Definition at line 258 of file mo_init_states.f90.

References mo_mpr_constants::c1_initstatesm, mo_mpr_global_variables::horizondepth_mhm, mo_global_variables::l1_aetcanopy, mo_global_variables::l1_aetsealed, mo_global_variables::l1_aetsoil, mo_global_variables::l1_baseflow, mo_global_variables::l1_fastrunoff, mo_global_variables::l1_infilsoil, mo_global_variables::l1_inter, mo_global_variables::l1_melt, mo_global_variables::l1_neutrons, mo_global_variables::l1_percol, mo_global_variables::l1_pet_calc, mo_global_variables::l1_prec_calc, mo_global_variables::l1_preeffect, mo_global_variables::l1_rain, mo_global_variables::l1_runoffseal, mo_global_variables::l1_satstw, mo_global_variables::l1_sealstw, mo_global_variables::l1_slowrunoff, mo_global_variables::l1_snow, mo_global_variables::l1_snowpack, mo_global_variables::l1_soilmoist, mo_global_variables::l1_temp_calc, mo_global_variables::l1_throughfall, mo_global_variables::l1_total_runoff, mo_global_variables::l1_unsatstw, mo_mpr_global_variables::nsoilhorizons_mhm, mo_common_constants::p1_initstatefluxes, mo_mpr_constants::p2_initstatefluxes, mo_mpr_constants::p3_initstatefluxes, mo_mpr_constants::p4_initstatefluxes, and mo_mpr_constants::p5_initstatefluxes.

Referenced by mo_mhm_interface_run::mhm_interface_run_prepare(), and variables_default_init().

Here is the caller graph for this function:

variables_alloc()

subroutine, public mo_init_states::variables_alloc

(

integer(i4), intent(in)

ncells1

)

Allocation of space for mHM related L1 and L11 variables.

Allocation of space for mHM related L1 and L11 variables (e.g., states, fluxes, and parameters) for a given domain. Variables allocated here is defined in them mo_global_variables.f90 file. After allocating any variable in this routine, initalize them in the following variables_default_init subroutine.

Changelog

• R. Kumar Sep 2013
  • documentation added according to the template
• S. Thober Aug 2015
  • removed routing related variables
• Zink M. Demirel C. Mar 2017
  • Init Jarvis soil water stress variable at SM process(3)
• Robert Schweppe Dec 2017
  • restructured allocation in variables_alloc, expanded dimensions of effective parameters
• Robert Schweppe Jun 2018
  • refactoring and reformatting

Authors

Rohini Kumar

Date

Jan 2013

Parameters

[in]

ncells1

number of level-1 cells

Definition at line 49 of file mo_init_states.f90.

References mo_mpr_constants::c1_initstatesm, mo_mpr_global_variables::horizondepth_mhm, mo_global_variables::l1_aetcanopy, mo_global_variables::l1_aetsealed, mo_global_variables::l1_aetsoil, mo_global_variables::l1_baseflow, mo_global_variables::l1_fastrunoff, mo_global_variables::l1_infilsoil, mo_global_variables::l1_inter, mo_global_variables::l1_melt, mo_global_variables::l1_neutrons, mo_global_variables::l1_percol, mo_global_variables::l1_pet_calc, mo_global_variables::l1_prec_calc, mo_global_variables::l1_preeffect, mo_global_variables::l1_rain, mo_global_variables::l1_runoffseal, mo_global_variables::l1_satstw, mo_global_variables::l1_sealstw, mo_global_variables::l1_slowrunoff, mo_global_variables::l1_snow, mo_global_variables::l1_snowpack, mo_global_variables::l1_soilmoist, mo_global_variables::l1_temp_calc, mo_global_variables::l1_throughfall, mo_global_variables::l1_total_runoff, mo_global_variables::l1_unsatstw, mo_mpr_global_variables::nsoilhorizons_mhm, mo_common_constants::p1_initstatefluxes, mo_mpr_constants::p2_initstatefluxes, mo_mpr_constants::p3_initstatefluxes, mo_mpr_constants::p4_initstatefluxes, and mo_mpr_constants::p5_initstatefluxes.

Referenced by mo_startup::mhm_initialize().

Here is the caller graph for this function:

variables_default_init()

subroutine, public mo_init_states::variables_default_init

Default initalization mHM related L1 variables.

Default initalization of mHM related L1 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.

Changelog

• R. Kumar Sep 2013
  • documentation added according to the template
• Stephan Thober Aug 2015
  • moved routing variables to mRM
• Robert Schweppe Jun 2018
  • refactoring and reformatting
• Sebastian Müller Mar 2023
  • added separate fluxes_states_default_init

Authors

R. Kumar & J. Mai

Date

Sep 2013

Definition at line 177 of file mo_init_states.f90.

References fluxes_states_default_init(), mo_mpr_global_variables::l1_aeroresist, mo_mpr_global_variables::l1_alpha, mo_mpr_global_variables::l1_degday, mo_mpr_global_variables::l1_degdayinc, mo_mpr_global_variables::l1_degdaymax, mo_mpr_global_variables::l1_degdaynopre, mo_mpr_global_variables::l1_fasp, mo_mpr_global_variables::l1_froots, mo_mpr_global_variables::l1_fsealed, mo_mpr_global_variables::l1_harsamcoeff, mo_mpr_global_variables::l1_jarvis_thresh_c1, mo_mpr_global_variables::l1_karstloss, mo_mpr_global_variables::l1_kbaseflow, mo_mpr_global_variables::l1_kfastflow, mo_mpr_global_variables::l1_kperco, mo_mpr_global_variables::l1_kslowflow, mo_mpr_global_variables::l1_maxinter, mo_mpr_global_variables::l1_petlaicorfactor, mo_mpr_global_variables::l1_prietayalpha, mo_mpr_global_variables::l1_sealedthresh, mo_mpr_global_variables::l1_soilmoistexp, mo_mpr_global_variables::l1_soilmoistfc, mo_mpr_global_variables::l1_soilmoistsat, mo_mpr_global_variables::l1_surfresist, mo_mpr_global_variables::l1_tempthresh, mo_mpr_global_variables::l1_unsatthresh, mo_mpr_global_variables::l1_wiltingpoint, 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: