mo_mrm_global_variables.f90

Go to the documentation of this file.

!> \dir mRM
!> \brief \copybrief f_mrm
!> \details \copydetails f_mrm
 
!> \defgroup   f_mrm mRM - Fortran modules
!> \brief      Core modules of mRM.
!> \details    These modules provide the core components of mRM.
 
!> \file mo_mrm_global_variables.f90
!> \brief \copybrief mo_mrm_global_variables
!> \details \copydetails mo_mrm_global_variables
 
!> \brief Global variables for mRM only
!> \details Global variables used to run mRM for mHM.
!> \changelog
!! - Robert Schweppe Dec 2017
!!   - merged duplicated variables with mhm into common variables
!! - Robert Schweppe Jun 2018
!!   - refactoring and reformatting
!> \authors Luis Samaniego, Stephan Thober
!> \date Aug 2015
!> \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_mrm
module mo_mrm_global_variables
 
  use mo_kind, only : i4, i8, dp
  use mo_mrm_constants, only : noutflxstate
  use mo_common_types, only : grid, gridremapper
  use mo_mrm_riv_temp_class, only : riv_temp_type
 
  implicit none
 
  PUBLIC :: gaugingstation
 
  ! -------------------------------------------------------------------
  ! General variables
  ! -------------------------------------------------------------------
  logical :: is_start              ! flag for first timestep for mpr
 
  ! -------------------------------------------------------------------
  ! DEFINE OUTPUTS
  ! -------------------------------------------------------------------
  !
  integer(i4) :: output_deflate_level_mrm !< compression of output nc files
  integer(i4) :: output_time_reference_mrm !< time reference point location in output nc files
  logical :: output_double_precision_mrm !< float precision in output nc files
  integer(i4) :: timestep_model_outputs_mrm !< timestep for writing model outputs
  logical, dimension(nOutFlxState) :: outputflxstate_mrm         !< Define model outputs see "mhm_outputs.nml"
  !                                                            dim1 = number of output variables to be written
  logical :: readlatlon
 
  ! ------------------------------------------------------------------
  ! DIRECTORIES
  ! ------------------------------------------------------------------
  ! has the dimension of nDomains
  character(256), dimension(:), allocatable, public :: dirgauges ! Directory where discharge files are located
  character(256), dimension(:), allocatable, public :: dirtotalrunoff ! Directory where simulated total runoff files are located
  character(256), public :: filenametotalrunoff ! Filename of simulated total runoff file
  character(256), public :: varnametotalrunoff ! variable name of total runoff
  character(256), dimension(:), allocatable, public :: dirbankfullrunoff ! Dir. where simulated bankfull runoff files are located
 
  ! ------------------------------------------------------------------
  ! CONSTANT
  ! ------------------------------------------------------------------
  integer(i4), public :: ntstepday ! Number of time intervals per day
  !                                ! (was previously NAGG)
 
  ! -------------------------------------------------------------------
  ! GRID description
  ! -------------------------------------------------------------------
  type(grid), dimension(:), allocatable, target, public :: level11 ! Reference of the routing variables
  type(gridremapper), dimension(:), allocatable, public :: l0_l11_remap ! grid information at runoff level
 
 
  ! -----------------------------------------------------------------
  ! RUNOFF variable
  ! -----------------------------------------------------------------
  real(dp), dimension(:, :), allocatable, public :: mrm_runoff ! variable containing runoff for each domain and gauge
 
  ! -----------------------------------------------------------------
  ! GAUGED station data
  ! -----------------------------------------------------------------
  integer(i4), public :: ngaugestotal ! Number of evaluation gauges for all domains
  integer(i4), public :: ngaugeslocal ! Number of evaluation gauges for all domains on a subprocess
  integer(i4), public :: ninflowgaugestotal ! Number of evaluation gauges for all domains
  integer(i4), public :: nmeasperday ! Number of observations per day,
  !                                  ! e.g. 24 -> hourly discharge, 1 -> daily discharge
  type gaugingstation
    integer(i4), dimension(:), allocatable :: domainid ! domain Id
    integer(i4), dimension(:), allocatable :: gaugeid ! Gauge Id (e.g. 0000444)
    character(256), dimension(:), allocatable :: fname ! Name runoff file
    real(dp), dimension(:, :), allocatable :: q ! [m3 s-1] observed daily mean discharge (simPer)
    !                                          ! dim1=number observations, dim2=number of gauges
    real(dp), dimension(:, :), allocatable :: t ! [K] observed daily mean temperature (simPer)
  end type gaugingstation
  type(gaugingstation), public :: gauge ! Gauging station information
  type(gaugingstation), public :: inflowgauge ! inflow gauge information
 
  ! -------------------------------------------------------------------
  ! DOMAIN general description
  ! -------------------------------------------------------------------
  type domaininfo_mrm
    ! dim1 = maximum number of gauges in a given domain
    ! discharge measurement gauges
    integer(i4) :: ngauges        ! Number of gauges within a domain
    integer(i4), dimension(:), allocatable :: gaugeidlist    ! Gauge Id list (e.g. 0000444 0000445)
    integer(i4), dimension(:), allocatable :: gaugeindexlist ! Gauge index list (e.g. 1 for 00444, 2 for 00445)
    integer(i4), dimension(:), allocatable :: gaugenodelist  ! Gauge node list at L11
 
    ! discharge inflow gauges (e.g if headwar bsins are missing)
    integer(i4) :: ninflowgauges        ! Number of gauges within a domain
    integer(i4), dimension(:), allocatable :: inflowgaugeidlist    ! Gauge Id list (e.g. 0000444 0000445)
    integer(i4), dimension(:), allocatable :: inflowgaugeindexlist ! Gauge index list (e.g. 1 for 00444, 2 for 00445)
    integer(i4), dimension(:), allocatable :: inflowgaugenodelist  ! Gauge node list at L11
    logical, dimension(:), allocatable :: inflowgaugeheadwater ! if headwater cells of inflow gauge will be considered
 
    ! domain outlet
    ! TODO: move this out of here since it is mrm_net_startup relevant only for domain0
    integer(i4) :: l0_noutlet
    integer(i4), dimension(:), allocatable :: l0_rowoutlet   ! Outlet locations in L0
    integer(i4), dimension(:), allocatable :: l0_coloutlet   ! Outlet locations in L0
  end type domaininfo_mrm
 
  ! dim1 = domainId
  type(domaininfo_mrm), dimension(:), allocatable, public, target :: domain_mrm ! domain structure
 
  !> \class sink_cells_t
  !> \brief container to hold all sink cell ids for a domain
  type, public :: sink_cells_t
    integer(i4), dimension(:), allocatable :: ids   ! cell ids of sinks
  end type sink_cells_t
  type(sink_cells_t), dimension(:), allocatable :: sink_cells !< sink cell ids for each domain
 
  ! -------------------------------------------------------------------
  ! L0 DOMAIN description -> those are needed within the mrm_net_startup routines only
  ! TODO: deallocate when net_startup is done
  ! -------------------------------------------------------------------
  ! dim1 = number grid cells
  ! input data - morphological variables
  integer(i4), public, dimension(:), allocatable :: l0_gaugeloc ! Location of gauges within the catchment
  integer(i4), public, dimension(:), allocatable :: l0_inflowgaugeloc ! Location of inflow gauges within catchment
  integer(i4), public, dimension(:), allocatable :: l0_facc ! Flow accumulation
  integer(i4), public, dimension(:), allocatable :: l0_fdir ! Flow direction (standard ArcGIS)
  !
  ! mRM derived variables
  ! dim1 = number grid cells L0
  integer(i4), public, dimension(:), allocatable :: l0_drasc      ! Index of draining cell of each sub catchment
  !                                                               ! i.e. a routing cell L11
  integer(i4), public, dimension(:), allocatable :: l0_dracell    ! Draining cell id at L11 of ith cell of L0
  integer(i4), public, dimension(:), allocatable :: l0_streamnet  ! Stream network
  integer(i4), public, dimension(:), allocatable :: l0_floodplain ! Floodplains of stream i
  integer(i4), public, dimension(:), allocatable :: l0_noutlet    ! number of river outlets at level 0
  real(dp),    public, dimension(:), allocatable :: l0_celerity   ! celerity at level 0
 
  ! -------------------------------------------------------------------
  ! L1 DOMAIN description
  ! -------------------------------------------------------------------
  ! dim1 = number grid cells L1
  integer(i4), public, dimension(:), allocatable :: l11_l1_id  ! Mapping of L11 Id on L1
  ! -------------------------------------------------------------------
  ! L1 variables
  ! -------------------------------------------------------------------
  ! dim1 = number grid cells L1
  ! dim2 = number of timesteps
  real(dp), public, dimension(:, :), allocatable :: l1_total_runoff_in
 
  ! -------------------------------------------------------------------
  ! L11 DOMAIN description
  ! -------------------------------------------------------------------
  ! dim1 = number grid cells L11
  ! dim2 = 2
  integer(i4), public, dimension(:,:), allocatable :: l11_cellcoor ! Cell coordinates (row,col)
  !                                                                ! -> <only domain> Routing
  integer(i4), public, dimension(:), allocatable :: l1_l11_id  ! Mapping of L1 Id on L11
  real(dp),    public, dimension(:), allocatable :: l11_areacell ! [km2] Effective area of cell at this level
  real(dp),    public, dimension(:), allocatable :: l11_facc ! [km2] flow Accumulation of cell at this level
  integer(i4), public, dimension(:), allocatable :: l11_fdir ! Flow direction (standard notation)
  integer(i4), public, dimension(:), allocatable :: l11_noutlets
  real(dp),    public, dimension(:), allocatable :: l11_celerity ! [m/s] celerity per grid-cell, only for
                                                                 ! routing-case = 3
  real(dp),    public, dimension(:), allocatable :: l11_meandering ! Proxy: L11_length/Lopt
                                                                   ! Lopt := shortest possible way of stream
  real(dp),    public, dimension(:), allocatable :: l11_linkin_facc ! fAcc inflow per Link
 
  ! Constants
  ! dim1 = number grid cells L11
  integer(i4), public, dimension(:), allocatable :: l11_rowout ! Grid vertical location of the Outlet
  integer(i4), public, dimension(:), allocatable :: l11_colout ! Grid horizontal location  of the Outlet
 
  ! -------------------------------------------------------------------
  ! L11 NETWORK description
  ! -------------------------------------------------------------------
  ! Fluxes
  ! dim1 = number grid cells L11
  ! dim2 = 2
  real(dp), public, dimension(:), allocatable :: l11_qmod        ! [m3 s-1] Simulated discharge
  real(dp), public, dimension(:), allocatable :: l11_qout        ! [m3 s-1] Total outflow from cells L11 at time tt
  real(dp), public, dimension(:, :), allocatable :: l11_qtin        !          Total discharge inputs at t-1 and t
  real(dp), public, dimension(:, :), allocatable :: l11_qtr         !          Routed outflow leaving a node
 
  integer(i4), public, dimension(:), allocatable :: l11_fromn       !         From node (sinks are at the end)
  integer(i4), public, dimension(:), allocatable :: l11_ton         !         To node (sinks are at the end)
  integer(i4), public, dimension(:), allocatable :: l11_netperm     !         Routing sequence (permutation of L11_rOrder)
  integer(i4), public, dimension(:), allocatable :: l11_frow        !         From row in L0 grid
  integer(i4), public, dimension(:), allocatable :: l11_fcol        !         From col in L0 grid
  integer(i4), public, dimension(:), allocatable :: l11_trow        !         To row in L0 grid
  integer(i4), public, dimension(:), allocatable :: l11_tcol        !         To col in L0 grid
  integer(i4), public, dimension(:), allocatable :: l11_rorder      !         Network routing order
  integer(i4), public, dimension(:), allocatable :: l11_label       !         Label Id [0='', 1=HeadWater, 2=Sink]
  logical, public, dimension(:), allocatable :: l11_sink        !         .true. if sink node reached
  real(dp), public, dimension(:), allocatable :: l11_length      ! [m]     Total length of river link
  real(dp), public, dimension(:), allocatable, target :: l11_afloodplain ! [m2]    Area of the flood plain
  !                                                                  !         impervious cover
  real(dp), public, dimension(:), allocatable :: l11_slope       ! [1]     Average slope of river link
 
  ! Parameters
  ! dim1 = number grid cells L11
  real(dp), public, dimension(:, :), allocatable :: l11_nlinkfracfpimp  !     fraction of impervious lcover at the floodplain
  !         dims: nLink, LCYearID
 
  real(dp), public, dimension(:), allocatable :: l11_k           ! [d]     kappa: Muskingum travel time parameter.
  real(dp), public, dimension(:), allocatable :: l11_xi          ! [1]     xi:    Muskingum diffusion parameter
  !                                                                  !                (attenuation).
  real(dp), public, dimension(:), allocatable :: l11_tsrout      ! [s]     Routing timestep
  real(dp), public, dimension(:), allocatable :: l11_c1          ! [-]     Routing parameter C1=f(K,xi, DT) (Chow, 25-41)
  real(dp), public, dimension(:), allocatable :: l11_c2          ! [-]     Routing parameter C2 (")
 
  ! -------------------------------------------------------------------
  ! GROUNDWATER COUPLING VARIABLES
  ! -------------------------------------------------------------------
  ! TODO this must be read from nml
  logical :: gw_coupling
  ! dim1 = number grid cells L1
  real(dp), public, dimension(:), allocatable :: l11_bankfull_runoff_in
  ! dim2 = number grid cells L0
  real(dp), public, dimension(:), allocatable :: l0_channel_depth
  real(dp), public, dimension(:), allocatable :: l0_channel_elevation
  ! the cumulated river heads, for monthly average
  real(dp), public, dimension(:), allocatable :: l0_river_head_mon_sum
  real(dp), public, dimension(:), allocatable :: l0_slope
 
  ! -------------------------------------------------------------------
  ! RIVER TEMPERATURE VARIABLES
  ! -------------------------------------------------------------------
  !> This is a container for the river temperature routing process (pcs)
  type(riv_temp_type), public :: riv_temp_pcs
end module mo_mrm_global_variables