RtmHistFlds.F90

module RtmHistFlds

!-----------------------------------------------------------------------
! !DESCRIPTION:
! Module containing initialization of RTM history fields and files
! This is the module that the user must modify in order to add new
! history fields or modify defaults associated with existing history
! fields.
!
! !USES:
  use shr_kind_mod , only : r8 => shr_kind_r8
  use RunoffMod    , only : rtmCTL
  use RtmHistFile  , only : RtmHistAddfld, RtmHistPrintflds
  use RtmVar       , only : nt_rtm, rtm_tracers  

  implicit none
!
! !PUBLIC MEMBER FUNCTIONS:
  public :: RtmHistFldsInit 
  public :: RtmHistFldsSet
!
!------------------------------------------------------------------------

contains

!-----------------------------------------------------------------------

  subroutine RtmHistFldsInit()

    !-------------------------------------------------------
    ! DESCRIPTION:
    ! Build master field list of all possible fields in a history file.
    ! Each field has associated with it a ``long\_name'' netcdf attribute that
    ! describes what the field is, and a ``units'' attribute. A subroutine is
    ! called to add each field to the masterlist.
    !
    ! ARGUMENTS:
    implicit none
    !-------------------------------------------------------

    call RtmHistAddfld (fname='RIVER_DISCHARGE_OVER_LAND'//'_'//trim(rtm_tracers(1)), units='m3/s',  &
         avgflag='A', long_name='MOSART river basin flow: '//trim(rtm_tracers(1)), &
         ptr_rof=rtmCTL%runofflnd_nt1, default='active')

    call RtmHistAddfld (fname='RIVER_DISCHARGE_OVER_LAND'//'_'//trim(rtm_tracers(2)), units='m3/s',  &
         avgflag='A', long_name='MOSART river basin flow: '//trim(rtm_tracers(2)), &
         ptr_rof=rtmCTL%runofflnd_nt2, default='active')

    call RtmHistAddfld (fname='RIVER_DISCHARGE_TO_OCEAN'//'_'//trim(rtm_tracers(1)), units='m3/s',  &
         avgflag='A', long_name='MOSART river discharge into ocean: '//trim(rtm_tracers(1)), &
         ptr_rof=rtmCTL%runoffocn_nt1, default='inactive')

    call RtmHistAddfld (fname='RIVER_DISCHARGE_TO_OCEAN'//'_'//trim(rtm_tracers(2)), units='m3/s',  &
         avgflag='A', long_name='MOSART river discharge into ocean: '//trim(rtm_tracers(2)), &
         ptr_rof=rtmCTL%runoffocn_nt2, default='inactive')

    call RtmHistAddfld (fname='TOTAL_DISCHARGE_TO_OCEAN'//'_'//trim(rtm_tracers(1)), units='m3/s', &
         avgflag='A', long_name='MOSART total discharge into ocean: '//trim(rtm_tracers(1)), &
         ptr_rof=rtmCTL%runofftot_nt1, default='active')

    call RtmHistAddfld (fname='TOTAL_DISCHARGE_TO_OCEAN'//'_'//trim(rtm_tracers(2)), units='m3/s', &
         avgflag='A', long_name='MOSART total discharge into ocean: '//trim(rtm_tracers(2)), &
         ptr_rof=rtmCTL%runofftot_nt2, default='active')

    call RtmHistAddfld (fname='DIRECT_DISCHARGE_TO_OCEAN'//'_'//trim(rtm_tracers(1)), units='m3/s', &
         avgflag='A', long_name='MOSART direct discharge into ocean: '//trim(rtm_tracers(1)), &
         ptr_rof=rtmCTL%runoffdir_nt1, default='active')

    call RtmHistAddfld (fname='DIRECT_DISCHARGE_TO_OCEAN'//'_'//trim(rtm_tracers(2)), units='m3/s', &
         avgflag='A', long_name='MOSART direct discharge into ocean: '//trim(rtm_tracers(2)), &
         ptr_rof=rtmCTL%runoffdir_nt2, default='active')

    call RtmHistAddfld (fname='STORAGE'//'_'//trim(rtm_tracers(1)), units='m3',  &
         avgflag='A', long_name='MOSART storage: '//trim(rtm_tracers(1)), &
         ptr_rof=rtmCTL%volr_nt1, default='inactive')

    call RtmHistAddfld (fname='STORAGE'//'_'//trim(rtm_tracers(2)), units='m3',  &
         avgflag='A', long_name='MOSART storage: '//trim(rtm_tracers(2)), &
         ptr_rof=rtmCTL%volr_nt2, default='inactive')

    call RtmHistAddfld (fname='STORAGE_MCH', units='m3',  &
         avgflag='A', long_name='MOSART main channelstorage', &
         ptr_rof=rtmCTL%volr_mch, default='inactive')

    call RtmHistAddfld (fname='DVOLRDT_LND'//'_'//trim(rtm_tracers(1)), units='m3/s',  &
         avgflag='A', long_name='MOSART land change in storage: '//trim(rtm_tracers(1)), &
         ptr_rof=rtmCTL%dvolrdtlnd_nt1, default='inactive')

    call RtmHistAddfld (fname='DVOLRDT_LND'//'_'//trim(rtm_tracers(2)), units='m3/s',  &
         avgflag='A', long_name='MOSART land change in storage: '//trim(rtm_tracers(2)), &
         ptr_rof=rtmCTL%dvolrdtlnd_nt2, default='inactive')

    call RtmHistAddfld (fname='DVOLRDT_OCN'//'_'//trim(rtm_tracers(1)), units='m3/s',  &
         avgflag='A', long_name='MOSART ocean change of storage: '//trim(rtm_tracers(1)), &
         ptr_rof=rtmCTL%dvolrdtocn_nt1, default='inactive')

    call RtmHistAddfld (fname='DVOLRDT_OCN'//'_'//trim(rtm_tracers(2)), units='m3/s',  &
         avgflag='A', long_name='MOSART ocean change of storage: '//trim(rtm_tracers(2)), &
         ptr_rof=rtmCTL%dvolrdtocn_nt2, default='inactive')

    call RtmHistAddfld (fname='QSUR'//'_'//trim(rtm_tracers(1)), units='m3/s',  &
         avgflag='A', long_name='MOSART input surface runoff: '//trim(rtm_tracers(1)), &
         ptr_rof=rtmCTL%qsur_nt1, default='inactive')

    call RtmHistAddfld (fname='QSUR'//'_'//trim(rtm_tracers(2)), units='m3/s',  &
         avgflag='A', long_name='MOSART input surface runoff: '//trim(rtm_tracers(2)), &
         ptr_rof=rtmCTL%qsur_nt2, default='inactive')

    call RtmHistAddfld (fname='QSUB'//'_'//trim(rtm_tracers(1)), units='m3/s',  &
         avgflag='A', long_name='MOSART input subsurface runoff: '//trim(rtm_tracers(1)), &
         ptr_rof=rtmCTL%qsub_nt1, default='inactive')

    call RtmHistAddfld (fname='QSUB'//'_'//trim(rtm_tracers(2)), units='m3/s',  &
         avgflag='A', long_name='MOSART input subsurface runoff: '//trim(rtm_tracers(2)), &
         ptr_rof=rtmCTL%qsub_nt2, default='inactive')

    call RtmHistAddfld (fname='QGWL'//'_'//trim(rtm_tracers(1)), units='m3/s',  &
         avgflag='A', long_name='MOSART input GWL runoff: '//trim(rtm_tracers(1)), &
         ptr_rof=rtmCTL%qgwl_nt1, default='inactive')

    call RtmHistAddfld (fname='QGWL'//'_'//trim(rtm_tracers(2)), units='m3/s',  &
         avgflag='A', long_name='MOSART input GWL runoff: '//trim(rtm_tracers(2)), &
         ptr_rof=rtmCTL%qgwl_nt2, default='inactive')

    call RtmHistAddfld (fname='QIRRIG_FROM_COUPLER', units='m3/s',  &
         avgflag='A', long_name='Amount of water used for irrigation (total flux received from coupler)', &
         ptr_rof=rtmCTL%qirrig, default='inactive')

    call RtmHistAddfld (fname='QDOM_WITHD_FROM_COUPLER', units='m3/s',  &
          avgflag='A', long_name='Amount of water withdrew for domestic usage', &
          ptr_rof=rtmCTL%qdom_withd, default='inactive')
     
    call RtmHistAddfld (fname='QDOM_RF_FROM_COUPLER', units='m3/s',  &
          avgflag='A', long_name='Amount of water returned from domestic usage', &
          ptr_rof=rtmCTL%qdom_rf, default='inactive')
     
    call RtmHistAddfld (fname='QLIV_WITHD_FROM_COUPLER', units='m3/s',  &
          avgflag='A', long_name='Amount of water withdrew for livestock usage', &
          ptr_rof=rtmCTL%qliv_withd, default='inactive')
     
    call RtmHistAddfld (fname='QLIV_RF_FROM_COUPLER', units='m3/s',  &
          avgflag='A', long_name='Amount of water returned from livestock usage', &
          ptr_rof=rtmCTL%qliv_rf, default='inactive')
     
    call RtmHistAddfld (fname='QELEC_WITHD_FROM_COUPLER', units='m3/s',  &
          avgflag='A', long_name='Amount of water withdrew for thermoelectric usage', &
          ptr_rof=rtmCTL%qelec_withd, default='inactive')
     
    call RtmHistAddfld (fname='QELEC_RF_FROM_COUPLER', units='m3/s',  &
          avgflag='A', long_name='Amount of water returned from thermoelectric usage', &
          ptr_rof=rtmCTL%qelec_rf, default='inactive')
     
    call RtmHistAddfld (fname='QMFC_WITHD_FROM_COUPLER', units='m3/s',  &
          avgflag='A', long_name='Amount of water withdrew for manufacturing usage', &
          ptr_rof=rtmCTL%qmfc_withd, default='inactive')
     
    call RtmHistAddfld (fname='QMFC_RF_FROM_COUPLER', units='m3/s',  &
          avgflag='A', long_name='Amount of water returned from manufacturing usage', &
          ptr_rof=rtmCTL%qmfc_rf, default='inactive')
     
    call RtmHistAddfld (fname='QMIN_WITHD_FROM_COUPLER', units='m3/s',  &
          avgflag='A', long_name='Amount of water withdrew for mining usage', &
          ptr_rof=rtmCTL%qmin_withd, default='inactive')
     
    call RtmHistAddfld (fname='QMIN_RF_FROM_COUPLER', units='m3/s',  &
          avgflag='A', long_name='Amount of water returned from mining usage', &
          ptr_rof=rtmCTL%qmin_rf, default='inactive')
     
    call RtmHistAddfld (fname='QIRRIG_ACTUAL', units='m3/s',  &
         avgflag='A', long_name='Actual irrigation (if limited by river storage)', &
         ptr_rof=rtmCTL%qirrig_actual, default='inactive')

    call RtmHistAddfld (fname='QDOM_ACTUAL_WITHD', units='m3/s',  &
          avgflag='A', long_name='Actual domestic withdrawal (if limited by river storage)', &
          ptr_rof=rtmCTL%qdom_actual_withd, default='inactive')
     
    call RtmHistAddfld (fname='QELEC_ACTUAL_WITHD', units='m3/s',  &
          avgflag='A', long_name='Actual thermoelectric withdrawal (if limited by river storage)', &
          ptr_rof=rtmCTL%qelec_actual_withd, default='inactive')
     
    call RtmHistAddfld (fname='QLIV_ACTUAL_WITHD', units='m3/s',  &
          avgflag='A', long_name='Actual livestock withdrawal (if limited by river storage)', &
          ptr_rof=rtmCTL%qliv_actual_withd, default='inactive')
     
    call RtmHistAddfld (fname='QMFC_ACTUAL_WITHD', units='m3/s',  &
          avgflag='A', long_name='Actual manufacturing withdrawal (if limited by river storage)', &
          ptr_rof=rtmCTL%qmfc_actual_withd, default='inactive')
     
    call RtmHistAddfld (fname='QMIN_ACTUAL_WITHD', units='m3/s',  &
          avgflag='A', long_name='Actual mining withdrawal (if limited by river storage)', &
          ptr_rof=rtmCTL%qmin_actual_withd, default='inactive')

    call RtmHistAddfld (fname='QDOM_ACTUAL_RF', units='m3/s',  &
          avgflag='A', long_name='Actual domestic return flow (if limited by river storage)', &
          ptr_rof=rtmCTL%qdom_actual_rf, default='inactive')
     
    call RtmHistAddfld (fname='QELEC_ACTUAL_RF', units='m3/s',  &
          avgflag='A', long_name='Actual thermoelectric return flow (if limited by river storage)', &
          ptr_rof=rtmCTL%qelec_actual_rf, default='inactive')
     
    call RtmHistAddfld (fname='QLIV_ACTUAL_RF', units='m3/s',  &
          avgflag='A', long_name='Actual livestock return flow (if limited by river storage)', &
          ptr_rof=rtmCTL%qliv_actual_rf, default='inactive')
     
    call RtmHistAddfld (fname='QMFC_ACTUAL_RF', units='m3/s',  &
          avgflag='A', long_name='Actual manufacturing return flow (if limited by river storage)', &
          ptr_rof=rtmCTL%qmfc_actual_rf, default='inactive')
     
    call RtmHistAddfld (fname='QMIN_ACTUAL_RF', units='m3/s',  &
          avgflag='A', long_name='Actual mining return flow (if limited by river storage)', &
          ptr_rof=rtmCTL%qmin_actual_rf, default='inactive')

    ! Print masterlist of history fields

    call RtmHistPrintflds()

  end subroutine RtmHistFldsInit

!-----------------------------------------------------------------------

  subroutine RtmHistFldsSet()

    !-----------------------------------------------------------------------
    ! !DESCRIPTION:
    ! Set mosart history fields as 1d poitner arrays
    !
    implicit none
    !-----------------------------------------------------------------------

    ! Currently only have two tracers

    rtmCTL%runofflnd_nt1(:)  = rtmCTL%runofflnd(:,1)
    rtmCTL%runofflnd_nt2(:)  = rtmCTL%runofflnd(:,2)

    rtmCTL%runoffocn_nt1(:)  = rtmCTL%runoffocn(:,1)
    rtmCTL%runoffocn_nt2(:)  = rtmCTL%runoffocn(:,2)

    rtmCTL%runofftot_nt1(:)  = rtmCTL%runofftot(:,1)
    rtmCTL%runofftot_nt2(:)  = rtmCTL%runofftot(:,2)

    rtmCTL%runoffdir_nt1(:)  = rtmCTL%direct(:,1)
    rtmCTL%runoffdir_nt2(:)  = rtmCTL%direct(:,2)

    rtmCTL%dvolrdtlnd_nt1(:) = rtmCTL%dvolrdtlnd(:,1)
    rtmCTL%dvolrdtlnd_nt2(:) = rtmCTL%dvolrdtlnd(:,2)

    rtmCTL%dvolrdtocn_nt1(:) = rtmCTL%dvolrdtocn(:,1)
    rtmCTL%dvolrdtocn_nt2(:) = rtmCTL%dvolrdtocn(:,2)

    rtmCTL%volr_nt1(:)       = rtmCTL%volr(:,1)
    rtmCTL%volr_nt2(:)       = rtmCTL%volr(:,2)
    rtmCTL%volr_mch(:)       = rtmCTL%wr(:,1)

    rtmCTL%qsub_nt1(:)       = rtmCTL%qsub(:,1)
    rtmCTL%qsub_nt2(:)       = rtmCTL%qsub(:,2)

    rtmCTL%qsur_nt1(:)       = rtmCTL%qsur(:,1)
    rtmCTL%qsur_nt2(:)       = rtmCTL%qsur(:,2)

    rtmCTL%qgwl_nt1(:)       = rtmCTL%qgwl(:,1)
    rtmCTL%qgwl_nt2(:)       = rtmCTL%qgwl(:,2)

  end subroutine RtmHistFldsSet


end module RtmHistFlds