mo_init_states.f90

Go to the documentation of this file.

!> \file mo_init_states.f90
!> \brief \copybrief mo_init_states
!> \details \copydetails mo_init_states
 
!> \brief Initialization of all state variables of mHM.
!> \details 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-\today, the mHM Developers, Luis Samaniego, Sabine Attinger: All rights reserved.
!! mHM is released under the LGPLv3+ license \license_note
!> \ingroup f_mhm
MODULE mo_init_states
 
  USE mo_kind, ONLY : i4, dp
 
  IMPLICIT NONE
 
  PRIVATE
 
  PUBLIC :: variables_alloc                 ! allocation of space for state variables/fluxes/effective parameters
  PUBLIC :: variables_default_init          ! initialization for state variables/fluxes/effective parameters
  PUBLIC :: fluxes_states_default_init      ! initialization for state/fluxes variables
 
CONTAINS
 
 
  !> \brief Allocation of space for mHM related L1 and L11 variables.
  !> \details 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
  subroutine variables_alloc(ncells1)
 
    use mo_append, only : append
    use mo_common_constants, only : p1_initstatefluxes
    use mo_global_variables, only : l1_throughfall, l1_aetcanopy, l1_aetsealed, l1_aetsoil, l1_baseflow, &
                                    l1_fastrunoff, l1_infilsoil, l1_inter, l1_melt, l1_neutrons, l1_percol, &
                                    l1_pet_calc, l1_temp_calc, l1_prec_calc, &
                                    l1_preeffect, l1_rain, l1_runoffseal, l1_satstw, l1_sealstw, &
                                    l1_slowrunoff, l1_snow, l1_snowpack, l1_soilmoist, l1_total_runoff, l1_unsatstw
    use mo_mpr_constants, only : c1_initstatesm, p2_initstatefluxes, p3_initstatefluxes, &
                                 p4_initstatefluxes, p5_initstatefluxes
    use mo_mpr_global_variables, only : horizondepth_mhm, nsoilhorizons_mhm
 
    implicit none
 
    integer(i4), intent(in) :: ncells1 !< number of level-1 cells
 
    integer(i4) :: i
 
    real(dp), dimension(:), allocatable :: dummy_1d
 
    real(dp), dimension(:, :), allocatable :: dummy_2d
 
 
    ! for appending and intialization
    allocate(dummy_1d(ncells1))
    allocate(dummy_2d(ncells1, nsoilhorizons_mhm))
 
    dummy_1d = p1_initstatefluxes
    dummy_2d = p1_initstatefluxes
 
    !-------------------------------------------
    ! FLUXES
    !-------------------------------------------
    ! calculated / corrected potential evapotranspiration
    call append(l1_pet_calc, dummy_1d)
    ! temperature for current time step
    call append(l1_temp_calc, dummy_1d)
    ! precipitation for current time step
    call append(l1_prec_calc, dummy_1d)
    !  soil actual ET
    call append(l1_aetsoil, dummy_2d)
    ! canopy actual ET
    call append(l1_aetcanopy, dummy_1d)
    ! sealed area actual ET
    call append(l1_aetsealed, dummy_1d)
    ! baseflow
    call append(l1_baseflow, dummy_1d)
    !  soil in-exfiltration
    call append(l1_infilsoil, dummy_2d)
    ! fast runoff
    call append(l1_fastrunoff, dummy_1d)
    ! snow melt
    call append(l1_melt, dummy_1d)
    ! percolation
    call append(l1_percol, dummy_1d)
    ! effective precip. depth (snow melt + rain)
    call append(l1_preeffect, dummy_1d)
    ! rain (liquid water)
    call append(l1_rain, dummy_1d)
    ! runoff from impervious area
    call append(l1_runoffseal, dummy_1d)
    ! slow runoff
    call append(l1_slowrunoff, dummy_1d)
    ! snow (solid water)
    call append(l1_snow, dummy_1d)
    ! throughfall
    call append(l1_throughfall, dummy_1d)
    ! throughfall
    call append(l1_total_runoff, dummy_1d)
 
    !-------------------------------------------
    ! STATE VARIABLES
    !-------------------------------------------
    ! Interception
    call append(l1_inter, dummy_1d)
    !Retention storage of impervious areas
    call append(l1_sealstw, dummy_1d)
    ! ground albedo neutrons
    call append(l1_neutrons, dummy_1d)
    !Snowpack
    dummy_1d = p2_initstatefluxes
    call append(l1_snowpack, dummy_1d)
    ! upper soil storage
    dummy_1d = p3_initstatefluxes
    call append(l1_unsatstw, dummy_1d)
    ! groundwater storage
    dummy_1d = p4_initstatefluxes
    call append(l1_satstw, dummy_1d)
    ! Soil moisture of each horizon
    do i = 1, nsoilhorizons_mhm - 1
      if (i == 1) then
        dummy_2d(:, i) = horizondepth_mhm(i) * c1_initstatesm
      else
        dummy_2d(:, i) = (horizondepth_mhm(i) - horizondepth_mhm(i - 1)) * c1_initstatesm
      end if
    end do
    dummy_2d(:, nsoilhorizons_mhm) = (p5_initstatefluxes - &
            horizondepth_mhm(nsoilhorizons_mhm - 1)) * c1_initstatesm
    call append(l1_soilmoist, dummy_2d)
 
    ! free space
    if (allocated(dummy_1d)) deallocate(dummy_1d)
    if (allocated(dummy_2d)) deallocate(dummy_2d)
 
  end subroutine variables_alloc
 
 
  !> \brief Default initalization mHM related L1 variables
  !> \details 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
  subroutine variables_default_init
 
    use mo_common_constants, only : p1_initstatefluxes
    use mo_mpr_global_variables, only : l1_harsamcoeff, l1_prietayalpha, &
                                        l1_aeroresist, l1_alpha, l1_degday, l1_degdayinc, l1_degdaymax,&
                                        l1_degdaynopre, l1_fasp, l1_froots, l1_fsealed, l1_jarvis_thresh_c1, &
                                        l1_kbaseflow, l1_kperco, l1_kslowflow, l1_karstloss, l1_kfastflow, &
                                        l1_maxinter, l1_petlaicorfactor, l1_sealedthresh, l1_soilmoistexp, &
                                        l1_soilmoistfc, l1_soilmoistsat, l1_surfresist, l1_tempthresh, &
                                        l1_unsatthresh, l1_wiltingpoint
 
    implicit none
 
    ! init fluxes and states
    call fluxes_states_default_init()
 
    !-------------------------------------------
    ! EFFECTIVE PARAMETERS
    !-------------------------------------------
 
    ! sealed fraction of LCover
    l1_fsealed = p1_initstatefluxes
    ! exponent for the upper reservoir
    l1_alpha = p1_initstatefluxes
    ! increase of the Degree-day factor per mm of increase in precipitation
    l1_degdayinc = p1_initstatefluxes
    ! maximum degree-day factor
    l1_degdaymax = p1_initstatefluxes
    ! degree-day factor with no precipitation
    l1_degdaynopre = p1_initstatefluxes
    ! degree-day factor
    l1_degday = p1_initstatefluxes
    ! Karstic percolation loss
    l1_karstloss = p1_initstatefluxes
    ! PET correction factor due to LAI
    l1_petlaicorfactor = p1_initstatefluxes
    ! PET correction factor due to terrain aspect
    l1_fasp = p1_initstatefluxes
    ! PET Hargreaves Samani Coefficient
    l1_harsamcoeff = p1_initstatefluxes
    ! PET Priestley Taylor coefficient
    l1_prietayalpha = p1_initstatefluxes
    ! PET aerodynamical resistance
    l1_aeroresist = p1_initstatefluxes
    ! PET bulk surface resistance
    l1_surfresist = p1_initstatefluxes
    ! Fraction of roots in soil horizons
    l1_froots = p1_initstatefluxes
    ! Maximum interception
    l1_maxinter = p1_initstatefluxes
    ! fast interflow recession coefficient
    l1_kfastflow = p1_initstatefluxes
    ! slow interflow recession coefficient
    l1_kslowflow = p1_initstatefluxes
    ! baseflow recession coefficient
    l1_kbaseflow = p1_initstatefluxes
    ! percolation coefficient
    l1_kperco = p1_initstatefluxes
    ! Soil moisture below which actual ET is reduced linearly till PWP
    l1_soilmoistfc = p1_initstatefluxes
    ! Saturation soil moisture for each horizon [mm]
    l1_soilmoistsat = p1_initstatefluxes
    ! Exponential parameter to how non-linear is the soil water retention
    l1_soilmoistexp = p1_initstatefluxes
    ! jarvis critical value for normalized soil water content
    l1_jarvis_thresh_c1 = p1_initstatefluxes
    ! Threshold temperature for snow/rain
    l1_tempthresh = p1_initstatefluxes
    ! Threshhold water depth controlling fast interflow
    l1_unsatthresh = p1_initstatefluxes
    ! Threshhold water depth for surface runoff in sealed surfaces
    l1_sealedthresh = p1_initstatefluxes
    ! Permanent wilting point
    l1_wiltingpoint = p1_initstatefluxes
 
  end subroutine variables_default_init
 
 
  !> \brief initialize fluxes and states with default values
  !> \authors Sebastian Müller
  !> \date Mar 2023
  subroutine fluxes_states_default_init
 
    use mo_common_constants, only : p1_initstatefluxes
    use mo_mpr_constants, only : c1_initstatesm, p2_initstatefluxes, p3_initstatefluxes, &
                                 p4_initstatefluxes, p5_initstatefluxes
    use mo_global_variables, only : l1_throughfall, l1_aetcanopy, l1_aetsealed, l1_aetsoil, l1_baseflow, &
                                    l1_fastrunoff, l1_infilsoil, &
                                    l1_inter, l1_melt, l1_neutrons, l1_percol, l1_pet_calc, l1_temp_calc, l1_prec_calc, &
                                    l1_preeffect, l1_rain, &
                                    l1_runoffseal, l1_satstw, l1_sealstw, l1_slowrunoff, l1_snow, l1_snowpack, &
                                    l1_soilmoist, l1_total_runoff, l1_unsatstw
    use mo_mpr_global_variables, only : horizondepth_mhm, nsoilhorizons_mhm
 
    implicit none
 
    integer(i4) :: i
 
    !-------------------------------------------
    ! STATE VARIABLES
    !-------------------------------------------
 
    ! Interception
    l1_inter = p1_initstatefluxes
    !Snowpack
    l1_snowpack = p2_initstatefluxes
    !Retention storage of impervious areas
    l1_sealstw = p1_initstatefluxes
 
    ! Soil moisture of each horizon
    do i = 1, nsoilhorizons_mhm - 1
      if (i .eq. 1) then
        l1_soilmoist(:, i) = horizondepth_mhm(i) * c1_initstatesm
      else
        l1_soilmoist(:, i) = (horizondepth_mhm(i) - horizondepth_mhm(i - 1)) * c1_initstatesm
      end if
    end do
    l1_soilmoist(:, nsoilhorizons_mhm) = (p5_initstatefluxes - &
            horizondepth_mhm(nsoilhorizons_mhm - 1)) * c1_initstatesm
 
    ! upper soil storage
    l1_unsatstw = p3_initstatefluxes
    ! groundwater storage
    l1_satstw = p4_initstatefluxes
    ! ground albedo neutrons, initially zero
    l1_neutrons = p1_initstatefluxes
 
    !-------------------------------------------
    ! FLUXES
    !-------------------------------------------
 
    ! corrected / calculated potential ET
    l1_pet_calc = p1_initstatefluxes
    ! temperature for current time step
    l1_temp_calc = p1_initstatefluxes
    ! precipitation for current time step
    l1_prec_calc = p1_initstatefluxes
    !  soil actual ET
    l1_aetsoil = p1_initstatefluxes
    ! canopy actual ET
    l1_aetcanopy = p1_initstatefluxes
    ! sealed area actual ET
    l1_aetsealed = p1_initstatefluxes
    ! baseflow
    l1_baseflow = p1_initstatefluxes
    !  soil in-exfiltration
    l1_infilsoil = p1_initstatefluxes
    ! fast runoff
    l1_fastrunoff = p1_initstatefluxes
    ! snow melt
    l1_melt = p1_initstatefluxes
    ! percolation
    l1_percol = p1_initstatefluxes
    ! effective precip. depth (snow melt + rain)
    l1_preeffect = p1_initstatefluxes
    ! rain (liquid water)
    l1_rain = p1_initstatefluxes
    ! runoff from impervious area
    l1_runoffseal = p1_initstatefluxes
    ! slow runoff
    l1_slowrunoff = p1_initstatefluxes
    ! snow (solid water)
    l1_snow = p1_initstatefluxes
    ! throughfall
    l1_throughfall = p1_initstatefluxes
    ! total runoff
    l1_total_runoff = p1_initstatefluxes
 
  end subroutine fluxes_states_default_init
 
END MODULE mo_init_states