mo_clean_up.f90

Go to the documentation of this file.

!> \file    mo_clean_up.f90
!> \brief   \copybrief mo_clean_up
!> \details \copydetails mo_clean_up
 
!> \brief   Module to clean up after a mHM run.
!> \version 0.1
!> \authors Sebastian Mueller
!> \date    May 2022
!> \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_common
module mo_clean_up
 
  implicit none
  private
  public :: deallocate_global_variables
 
  contains
 
  !> \brief Deallocate all global variables.
  subroutine deallocate_global_variables()
    use mo_mhm_cli, only : set_verbosity_level
    use mo_common_run_variables, only : run_cfg
    use mo_global_variables, only : &
      couple_cfg, &
      meteo_handler, &
      l1_sm, &
      l1_sm_mask, &
      l1_neutronsdata, &
      l1_neutronsdata_mask, &
      l1_smobs, &
      l1_neutronsobs, &
      l1_etobs, &
      l1_twsaobs, &
      bfi_obs, &
      bfi_qbf_sum, &
      bfi_qt_sum, &
      l1_inter, &
      l1_snowpack, &
      l1_sealstw, &
      l1_soilmoist, &
      l1_unsatstw, &
      l1_satstw, &
      l1_neutrons, &
      l1_pet_calc, &
      l1_temp_calc, &
      l1_prec_calc, &
      l1_aetsoil, &
      l1_aetcanopy, &
      l1_aetsealed, &
      l1_baseflow, &
      l1_infilsoil, &
      l1_fastrunoff, &
      l1_melt, &
      l1_percol, &
      l1_preeffect, &
      l1_rain, &
      l1_runoffseal, &
      l1_slowrunoff, &
      l1_snow, &
      l1_throughfall, &
      l1_total_runoff, &
      neutron_integral_afast
 
    use mo_common_variables, only : &
      resolutionhydrology, &
      l0_domain, &
      mhmfilerestartout, &
      mrmfilerestartout, &
      dirmorpho, &
      dirlcover, &
      dirout, &
      filelatlon, &
      level0, &
      level1, &
      l0_l1_remap, &
      l0_elev, &
      l0_lcover, &
      lcfilename, &
      lc_year_start, &
      lc_year_end, &
      global_parameters, &
      global_parameters_name, &
      domainmeta
 
    use mo_mpr_global_variables, only : &
      horizondepth_mhm, &
      geounitlist, &
      geounitkar, &
      laiboundaries, &
      laiunitlist, &
      lailut, &
      laiper, &
      l0_slope_emp, &
      l0_gridded_lai, &
      l0_slope, &
      l0_asp, &
      l0_soilid, &
      l0_geounit, &
      dirgridded_lai, &
      l1_fsealed, &
      l1_alpha, &
      l1_degdayinc, &
      l1_degdaymax, &
      l1_degdaynopre, &
      l1_degday, &
      l1_karstloss, &
      l1_fasp, &
      l1_petlaicorfactor, &
      l1_harsamcoeff, &
      l1_prietayalpha, &
      l1_aeroresist, &
      l1_surfresist, &
      l1_froots, &
      l1_maxinter, &
      l1_kfastflow, &
      l1_kslowflow, &
      l1_kbaseflow, &
      l1_kperco, &
      l1_soilmoistfc, &
      l1_soilmoistsat, &
      l1_soilmoistexp, &
      l1_jarvis_thresh_c1, &
      l1_tempthresh, &
      l1_unsatthresh, &
      l1_sealedthresh, &
      l1_wiltingpoint, &
      soildb, &
      l1_no_count, &
      l1_bulkdens, &
      l1_latticewater, &
      l1_cosmicl3
    use mo_mrm_global_variables, only : &
      dirgauges, &
      dirtotalrunoff, &
      dirbankfullrunoff, &
      level11, &
      l0_l11_remap, &
      mrm_runoff, &
      domain_mrm, &
      l0_gaugeloc, &
      l0_inflowgaugeloc, &
      l0_facc, &
      l0_fdir, &
      l0_drasc, &
      l0_dracell, &
      l0_streamnet, &
      l0_floodplain, &
      l0_noutlet, &
      l0_celerity, &
      l11_l1_id, &
      l1_total_runoff_in, &
      l11_cellcoor, &
      l1_l11_id, &
      l11_areacell, &
      l11_facc, &
      l11_fdir, &
      l11_noutlets, &
      l11_celerity, &
      l11_meandering, &
      l11_linkin_facc, &
      l11_rowout, &
      l11_colout, &
      l11_qmod, &
      l11_qout, &
      l11_qtin, &
      l11_qtr, &
      l11_fromn, &
      l11_ton, &
      l11_netperm, &
      l11_frow, &
      l11_fcol, &
      l11_trow, &
      l11_tcol, &
      l11_rorder, &
      l11_label, &
      l11_sink, &
      l11_length, &
      l11_afloodplain, &
      l11_slope, &
      l11_nlinkfracfpimp, &
      l11_k, &
      l11_xi, &
      l11_tsrout, &
      l11_c1, &
      l11_c2, &
      l11_bankfull_runoff_in, &
      l0_channel_depth, &
      l0_channel_elevation, &
      l0_river_head_mon_sum, &
      gauge, &
      inflowgauge, &
      riv_temp_pcs, &
      mrm_l0_slope => l0_slope
 
    use mo_common_mhm_mrm_variables, only : &
      resolutionrouting, &
      warmper, &
      evalper, &
      simper, &
      warmingdays, &
      lcyearid, &
      mhmfilerestartin, &
      mrmfilerestartin
 
    ! mo_global_variables
    if ( allocated(l1_sm) ) deallocate(l1_sm)
    if ( allocated(l1_sm_mask) ) deallocate(l1_sm_mask)
    if ( allocated(l1_neutronsdata) ) deallocate(l1_neutronsdata)
    if ( allocated(l1_neutronsdata_mask) ) deallocate(l1_neutronsdata_mask)
    if ( allocated(l1_smobs) ) deallocate(l1_smobs)
    if ( allocated(l1_neutronsobs) ) deallocate(l1_neutronsobs)
    if ( allocated(l1_etobs) ) deallocate(l1_etobs)
    if ( allocated(l1_twsaobs) ) deallocate(l1_twsaobs)
    if ( allocated(bfi_obs) ) deallocate(bfi_obs)
    if ( allocated(bfi_qbf_sum) ) deallocate(bfi_qbf_sum)
    if ( allocated(bfi_qt_sum) ) deallocate(bfi_qt_sum)
    if ( allocated(l1_inter) ) deallocate(l1_inter)
    if ( allocated(l1_snowpack) ) deallocate(l1_snowpack)
    if ( allocated(l1_sealstw) ) deallocate(l1_sealstw)
    if ( allocated(l1_soilmoist) ) deallocate(l1_soilmoist)
    if ( allocated(l1_unsatstw) ) deallocate(l1_unsatstw)
    if ( allocated(l1_satstw) ) deallocate(l1_satstw)
    if ( allocated(l1_neutrons) ) deallocate(l1_neutrons)
    if ( allocated(l1_pet_calc) ) deallocate(l1_pet_calc)
    if ( allocated(l1_temp_calc) ) deallocate(l1_temp_calc)
    if ( allocated(l1_prec_calc) ) deallocate(l1_prec_calc)
    if ( allocated(l1_aetsoil) ) deallocate(l1_aetsoil)
    if ( allocated(l1_aetcanopy) ) deallocate(l1_aetcanopy)
    if ( allocated(l1_aetsealed) ) deallocate(l1_aetsealed)
    if ( allocated(l1_baseflow) ) deallocate(l1_baseflow)
    if ( allocated(l1_infilsoil) ) deallocate(l1_infilsoil)
    if ( allocated(l1_fastrunoff) ) deallocate(l1_fastrunoff)
    if ( allocated(l1_melt) ) deallocate(l1_melt)
    if ( allocated(l1_percol) ) deallocate(l1_percol)
    if ( allocated(l1_preeffect) ) deallocate(l1_preeffect)
    if ( allocated(l1_rain) ) deallocate(l1_rain)
    if ( allocated(l1_runoffseal) ) deallocate(l1_runoffseal)
    if ( allocated(l1_slowrunoff) ) deallocate(l1_slowrunoff)
    if ( allocated(l1_snow) ) deallocate(l1_snow)
    if ( allocated(l1_throughfall) ) deallocate(l1_throughfall)
    if ( allocated(l1_total_runoff) ) deallocate(l1_total_runoff)
    if ( allocated(neutron_integral_afast) ) deallocate(neutron_integral_afast)
 
    ! mo_common_variables
    if ( allocated(resolutionhydrology) ) deallocate(resolutionhydrology)
    if ( allocated(l0_domain) ) deallocate(l0_domain)
    if ( allocated(mhmfilerestartout) ) deallocate(mhmfilerestartout)
    if ( allocated(mrmfilerestartout) ) deallocate(mrmfilerestartout)
    if ( allocated(dirmorpho) ) deallocate(dirmorpho)
    if ( allocated(dirlcover) ) deallocate(dirlcover)
    if ( allocated(dirout) ) deallocate(dirout)
    if ( allocated(filelatlon) ) deallocate(filelatlon)
    if ( allocated(level0) ) deallocate(level0)
    if ( allocated(level1) ) deallocate(level1)
    if ( allocated(l0_l1_remap) ) deallocate(l0_l1_remap)
    if ( allocated(l0_elev) ) deallocate(l0_elev)
    if ( allocated(l0_lcover) ) deallocate(l0_lcover)
    if ( allocated(lcfilename) ) deallocate(lcfilename)
    if ( allocated(lc_year_start) ) deallocate(lc_year_start)
    if ( allocated(lc_year_end) ) deallocate(lc_year_end)
    if ( allocated(global_parameters) ) deallocate(global_parameters)
    if ( allocated(global_parameters_name) ) deallocate(global_parameters_name)
    if ( allocated(domainmeta%indices) ) deallocate(domainmeta%indices)
    if ( allocated(domainmeta%L0DataFrom) ) deallocate(domainmeta%L0DataFrom)
    if ( allocated(domainmeta%optidata) ) deallocate(domainmeta%optidata)
    if ( allocated(domainmeta%doRouting) ) deallocate(domainmeta%doRouting)
 
    ! mo_mpr_global_variables
    if ( allocated(horizondepth_mhm) ) deallocate(horizondepth_mhm)
    if ( allocated(geounitlist) ) deallocate(geounitlist)
    if ( allocated(geounitkar) ) deallocate(geounitkar)
    if ( allocated(laiboundaries) ) deallocate(laiboundaries)
    if ( allocated(laiunitlist) ) deallocate(laiunitlist)
    if ( allocated(lailut) ) deallocate(lailut)
    if ( allocated(laiper) ) deallocate(laiper)
    if ( allocated(l0_slope_emp) ) deallocate(l0_slope_emp)
    if ( allocated(l0_gridded_lai) ) deallocate(l0_gridded_lai)
    if ( allocated(l0_slope) ) deallocate(l0_slope)
    if ( allocated(l0_asp) ) deallocate(l0_asp)
    if ( allocated(l0_soilid) ) deallocate(l0_soilid)
    if ( allocated(l0_geounit) ) deallocate(l0_geounit)
    if ( allocated(dirgridded_lai) ) deallocate(dirgridded_lai)
    if ( allocated(l1_fsealed) ) deallocate(l1_fsealed)
    if ( allocated(l1_alpha) ) deallocate(l1_alpha)
    if ( allocated(l1_degdayinc) ) deallocate(l1_degdayinc)
    if ( allocated(l1_degdaymax) ) deallocate(l1_degdaymax)
    if ( allocated(l1_degdaynopre) ) deallocate(l1_degdaynopre)
    if ( allocated(l1_degday) ) deallocate(l1_degday)
    if ( allocated(l1_karstloss) ) deallocate(l1_karstloss)
    if ( allocated(l1_fasp) ) deallocate(l1_fasp)
    if ( allocated(l1_petlaicorfactor) ) deallocate(l1_petlaicorfactor)
    if ( allocated(l1_harsamcoeff) ) deallocate(l1_harsamcoeff)
    if ( allocated(l1_prietayalpha) ) deallocate(l1_prietayalpha)
    if ( allocated(l1_aeroresist) ) deallocate(l1_aeroresist)
    if ( allocated(l1_surfresist) ) deallocate(l1_surfresist)
    if ( allocated(l1_froots) ) deallocate(l1_froots)
    if ( allocated(l1_maxinter) ) deallocate(l1_maxinter)
    if ( allocated(l1_kfastflow) ) deallocate(l1_kfastflow)
    if ( allocated(l1_kslowflow) ) deallocate(l1_kslowflow)
    if ( allocated(l1_kbaseflow) ) deallocate(l1_kbaseflow)
    if ( allocated(l1_kperco) ) deallocate(l1_kperco)
    if ( allocated(l1_soilmoistfc) ) deallocate(l1_soilmoistfc)
    if ( allocated(l1_soilmoistsat) ) deallocate(l1_soilmoistsat)
    if ( allocated(l1_soilmoistexp) ) deallocate(l1_soilmoistexp)
    if ( allocated(l1_jarvis_thresh_c1) ) deallocate(l1_jarvis_thresh_c1)
    if ( allocated(l1_tempthresh) ) deallocate(l1_tempthresh)
    if ( allocated(l1_unsatthresh) ) deallocate(l1_unsatthresh)
    if ( allocated(l1_sealedthresh) ) deallocate(l1_sealedthresh)
    if ( allocated(l1_wiltingpoint) ) deallocate(l1_wiltingpoint)
    if ( allocated(soildb%id) ) deallocate(soildb%id)
    if ( allocated(soildb%nHorizons) ) deallocate(soildb%nHorizons)
    if ( allocated(soildb%is_present) ) deallocate(soildb%is_present)
    if ( allocated(soildb%UD) ) deallocate(soildb%UD)
    if ( allocated(soildb%LD) ) deallocate(soildb%LD)
    if ( allocated(soildb%clay) ) deallocate(soildb%clay)
    if ( allocated(soildb%sand) ) deallocate(soildb%sand)
    if ( allocated(soildb%DbM) ) deallocate(soildb%DbM)
    if ( allocated(soildb%depth) ) deallocate(soildb%depth)
    if ( allocated(soildb%RZdepth) ) deallocate(soildb%RZdepth)
    if ( allocated(soildb%Wd) ) deallocate(soildb%Wd)
    if ( allocated(soildb%nTillHorizons) ) deallocate(soildb%nTillHorizons)
    if ( allocated(soildb%thetaS_Till) ) deallocate(soildb%thetaS_Till)
    if ( allocated(soildb%thetaS) ) deallocate(soildb%thetaS)
    if ( allocated(soildb%Db) ) deallocate(soildb%Db)
    if ( allocated(soildb%thetaFC_Till) ) deallocate(soildb%thetaFC_Till)
    if ( allocated(soildb%thetaFC) ) deallocate(soildb%thetaFC)
    if ( allocated(soildb%thetaPW_Till) ) deallocate(soildb%thetaPW_Till)
    if ( allocated(soildb%thetaPW) ) deallocate(soildb%thetaPW)
    if ( allocated(soildb%Ks) ) deallocate(soildb%Ks)
    if ( allocated(l1_no_count) ) deallocate(l1_no_count)
    if ( allocated(l1_bulkdens) ) deallocate(l1_bulkdens)
    if ( allocated(l1_latticewater) ) deallocate(l1_latticewater)
    if ( allocated(l1_cosmicl3) ) deallocate(l1_cosmicl3)
 
    ! mo_mrm_global_variables
    if ( allocated(dirgauges) ) deallocate(dirgauges)
    if ( allocated(dirtotalrunoff) ) deallocate(dirtotalrunoff)
    if ( allocated(dirbankfullrunoff) ) deallocate(dirbankfullrunoff)
    if ( allocated(level11) ) deallocate(level11)
    if ( allocated(l0_l11_remap) ) deallocate(l0_l11_remap)
    if ( allocated(mrm_runoff) ) deallocate(mrm_runoff)
    if ( allocated(domain_mrm) ) deallocate(domain_mrm)
    if ( allocated(l0_gaugeloc) ) deallocate(l0_gaugeloc)
    if ( allocated(l0_inflowgaugeloc) ) deallocate(l0_inflowgaugeloc)
    if ( allocated(l0_facc) ) deallocate(l0_facc)
    if ( allocated(l0_fdir) ) deallocate(l0_fdir)
    if ( allocated(l0_drasc) ) deallocate(l0_drasc)
    if ( allocated(l0_dracell) ) deallocate(l0_dracell)
    if ( allocated(l0_streamnet) ) deallocate(l0_streamnet)
    if ( allocated(l0_floodplain) ) deallocate(l0_floodplain)
    if ( allocated(l0_noutlet) ) deallocate(l0_noutlet)
    if ( allocated(l0_celerity) ) deallocate(l0_celerity)
    if ( allocated(l11_l1_id) ) deallocate(l11_l1_id)
    if ( allocated(l1_total_runoff_in) ) deallocate(l1_total_runoff_in)
    if ( allocated(l11_cellcoor) ) deallocate(l11_cellcoor)
    if ( allocated(l1_l11_id) ) deallocate(l1_l11_id)
    if ( allocated(l11_areacell) ) deallocate(l11_areacell)
    if ( allocated(l11_facc) ) deallocate(l11_facc)
    if ( allocated(l11_fdir) ) deallocate(l11_fdir)
    if ( allocated(l11_noutlets) ) deallocate(l11_noutlets)
    if ( allocated(l11_celerity) ) deallocate(l11_celerity)
    if ( allocated(l11_meandering) ) deallocate(l11_meandering)
    if ( allocated(l11_linkin_facc) ) deallocate(l11_linkin_facc)
    if ( allocated(l11_rowout) ) deallocate(l11_rowout)
    if ( allocated(l11_colout) ) deallocate(l11_colout)
    if ( allocated(l11_qmod) ) deallocate(l11_qmod)
    if ( allocated(l11_qout) ) deallocate(l11_qout)
    if ( allocated(l11_qtin) ) deallocate(l11_qtin)
    if ( allocated(l11_qtr) ) deallocate(l11_qtr)
    if ( allocated(l11_fromn) ) deallocate(l11_fromn)
    if ( allocated(l11_ton) ) deallocate(l11_ton)
    if ( allocated(l11_netperm) ) deallocate(l11_netperm)
    if ( allocated(l11_frow) ) deallocate(l11_frow)
    if ( allocated(l11_fcol) ) deallocate(l11_fcol)
    if ( allocated(l11_trow) ) deallocate(l11_trow)
    if ( allocated(l11_tcol) ) deallocate(l11_tcol)
    if ( allocated(l11_rorder) ) deallocate(l11_rorder)
    if ( allocated(l11_label) ) deallocate(l11_label)
    if ( allocated(l11_sink) ) deallocate(l11_sink)
    if ( allocated(l11_length) ) deallocate(l11_length)
    if ( allocated(l11_afloodplain) ) deallocate(l11_afloodplain)
    if ( allocated(l11_slope) ) deallocate(l11_slope)
    if ( allocated(l11_nlinkfracfpimp) ) deallocate(l11_nlinkfracfpimp)
    if ( allocated(l11_k) ) deallocate(l11_k)
    if ( allocated(l11_xi) ) deallocate(l11_xi)
    if ( allocated(l11_tsrout) ) deallocate(l11_tsrout)
    if ( allocated(l11_c1) ) deallocate(l11_c1)
    if ( allocated(l11_c2) ) deallocate(l11_c2)
    if ( allocated(l11_bankfull_runoff_in) ) deallocate(l11_bankfull_runoff_in)
    if ( allocated(l0_channel_depth) ) deallocate(l0_channel_depth)
    if ( allocated(l0_channel_elevation) ) deallocate(l0_channel_elevation)
    if ( allocated(l0_river_head_mon_sum) ) deallocate(l0_river_head_mon_sum)
    if ( allocated(mrm_l0_slope) ) deallocate(mrm_l0_slope)
    if ( allocated(gauge%domainId) ) deallocate(gauge%domainId)
    if ( allocated(gauge%fname) ) deallocate(gauge%fname)
    if ( allocated(gauge%gaugeId) ) deallocate(gauge%gaugeId)
    if ( allocated(gauge%Q) ) deallocate(gauge%Q)
    if ( allocated(gauge%T) ) deallocate(gauge%T)
    if ( allocated(inflowgauge%domainId) ) deallocate(inflowgauge%domainId)
    if ( allocated(inflowgauge%fname) ) deallocate(inflowgauge%fname)
    if ( allocated(inflowgauge%gaugeId) ) deallocate(inflowgauge%gaugeId)
    if ( allocated(inflowgauge%Q) ) deallocate(inflowgauge%Q)
    if ( allocated(inflowgauge%T) ) deallocate(inflowgauge%T)
    call riv_temp_pcs%clean_up()
 
    ! mo_common_mHM_mRM_variables
    if ( allocated(resolutionrouting) ) deallocate(resolutionrouting)
    if ( allocated(warmper) ) deallocate(warmper)
    if ( allocated(evalper) ) deallocate(evalper)
    if ( allocated(simper) ) deallocate(simper)
    if ( allocated(warmingdays) ) deallocate(warmingdays)
    if ( allocated(lcyearid) ) deallocate(lcyearid)
    if ( allocated(mhmfilerestartin) ) deallocate(mhmfilerestartin)
    if ( allocated(mrmfilerestartin) ) deallocate(mrmfilerestartin)
 
    ! mo_common_run_variables
    call run_cfg%clean_up()
 
    ! meteo handler clean up
    call meteo_handler%clean_up()
 
    ! coupling config clean up
    call couple_cfg%clean_up()
 
    ! reset verbosity
    call set_verbosity_level()
 
  end subroutine deallocate_global_variables
 
end module mo_clean_up