actual_et__gridded_values.F90

Go to the documentation of this file.

!> @file
!>  Contains a single module, actual_et__gridded_values, which
!>  populates the reference et by applying the monthly value obtained from a reference grid.
 
 
!>  Populate actual evapotranspiration by substituting in
!>  the daily average actual ET from a gridded data source.
 
module actual_et__gridded_values
 
  use iso_c_binding, only             : c_short, c_int, c_float, c_double
  use constants_and_conversions
  use data_catalog
  use data_catalog_entry
  use datetime, only                  : datetime_t
  use exceptions
  use simulation_datetime, only       : sim_dt
  use fstring
  use fstring_list
 
  implicit none
 
  private
 
  public :: actual_et_gridded_values_initialize,                               &
            actual_et_gridded_values_calculate,                                &
            actual_et
 
  type (data_catalog_entry_t), pointer :: paet_grid
 
  real ( c_float), allocatable    :: actual_et(:)
 
  type ( datetime_t )                  :: date_of_last_retrieval
 
contains
 
  subroutine actual_et_gridded_values_initialize( is_cell_active )
 
    logical (c_bool), intent(in)     :: is_cell_active(:,:)
 
    ! [ LOCALS ]
    integer (c_int)                 :: istat
    type (fstring_list_t)                 :: slstring
    integer (c_int)                 :: iindex
 
    ! locate the data structure associated with the gridded actual_et entries
    paet_grid => dat%find("ACTUAL_ET")
    if (.not. associated(paet_grid) ) &
      call die("A set of ACTUAL_ET grids must be supplied in order to make"   &
               //" use of this option.", __file__, __line__)
 
    allocate( actual_et( count( is_cell_active ) ), stat=istat )
    call assert( istat==0, "Problem allocating memory for ACTUAL_ET vector.",  &
      __file__, __line__)
 
  end subroutine actual_et_gridded_values_initialize
 
!--------------------------------------------------------------------------------------------------
 
  subroutine actual_et_gridded_values_calculate( is_cell_active )
 
    logical (c_bool), intent(in)     :: is_cell_active(:,:)
 
    if ( .not. date_of_last_retrieval == sim_dt%curr ) then
 
      call paet_grid%getvalues( sim_dt%curr )
      date_of_last_retrieval = sim_dt%curr
      actual_et = pack( paet_grid%pGrdBase%rData, is_cell_active)
 
    endif
 
  end subroutine actual_et_gridded_values_calculate
 
end module actual_et__gridded_values