prism.F90

Go to the documentation of this file.

! --------------------  PRISM module file prism.F90 -------------------- 
!
! $Id: prism.F90 2773 2010-11-25 14:48:32Z hanke $
! $Author: hanke $
!
!-----------------------------------------------------------------------
! Copyright 2006-2010, CERFACS, Toulouse, France.
! Copyright 2006-2010, SGI Germany, Munich, Germany.
! Copyright 2006-2010, NEC Europe Ltd., London, UK.
! All rights reserved. Use is subject to OASIS4 license terms.
!-----------------------------------------------------------------------
!BOP
!
! !MODULE: PRISM
!
module PRISM
!
! !USES:
!
  use PRISM_Constants
  use psmile_user_data, only : prism_remove_mask => psmile_store_data_rm_mask

  implicit none
!
! !DESCRIPTION:
!
! The main purpose of the PRISM module is to provide an interface description of
! all PRISM routines, excluding PRISM_Put and PRISM_Get.
!
! !REVISION HISTORY:
!
!   Date      Programmer   Description
! ----------  ----------   -----------
! 01.12.03    H. Ritzdorf  created
! 06.02.09    S. Valcke    split prism.F90 and prism_constants.F90
!
!EOP
!
! ----------------------------------------------------------------------------
! Overloading routines used for specifications of Grid Definitions
! ----------------------------------------------------------------------------

! Fortran 90 is the dead of library programmers ! 
! (C might have been a better option)

  Interface prism_set_corners

     subroutine prism_set_corners_3d_double_333(grid_id, nbr_corners, corners_actual_shape, &
            corners_1st_array, corners_2nd_array, corners_3rd_array, ierror)

       Integer, Intent (In)                :: grid_id
       Integer, Intent (In)                :: nbr_corners
       Double Precision, Intent (In)       :: corners_1st_array (:, :, :, :)
       Double Precision, Intent (In)       :: corners_2nd_array (:, :, :, :)
       Double Precision, Intent (In)       :: corners_3rd_array (:, :, :, :)
       Integer, Intent (In)                :: corners_actual_shape (1:2, *)
       Integer, Intent(Out)                :: ierror
     end subroutine prism_set_corners_3d_double_333

     subroutine prism_set_corners_3d_double_221(grid_id, nbr_corners, corners_actual_shape, &
            corners_1st_array, corners_2nd_array, corners_3rd_array, ierror)

       Integer, Intent (In)                :: grid_id
       Integer, Intent (In)                :: nbr_corners
       Double Precision, Intent (In)       :: corners_1st_array (:, :, :)
       Double Precision, Intent (In)       :: corners_2nd_array (:, :, :)
       Double Precision, Intent (In)       :: corners_3rd_array (:, :)
       Integer, Intent (In)                :: corners_actual_shape (1:2, *)
       Integer, Intent(Out)                :: ierror
     end subroutine prism_set_corners_3d_double_221

     subroutine prism_set_corners_3d_double_223(grid_id, nbr_corners, corners_actual_shape, &
            corners_1st_array, corners_2nd_array, corners_3rd_array, ierror)

       Integer, Intent (In)                :: grid_id
       Integer, Intent (In)                :: nbr_corners
       Double Precision, Intent (In)       :: corners_1st_array (:, :, :)
       Double Precision, Intent (In)       :: corners_2nd_array (:, :, :)
       Double Precision, Intent (In)       :: corners_3rd_array (:, :, :, :)
       Integer, Intent (In)                :: corners_actual_shape (1:2, *)
       Integer, Intent(Out)                :: ierror
     end subroutine prism_set_corners_3d_double_223

     subroutine prism_set_corners_3d_double_112(grid_id, nbr_corners, corners_actual_shape, &
            corners_1st_array, corners_2nd_array, corners_3rd_array, ierror)

       Integer, Intent (In)                :: grid_id
       Integer, Intent (In)                :: nbr_corners
       Double Precision, Intent (In)       :: corners_1st_array (:, :)
       Double Precision, Intent (In)       :: corners_2nd_array (:, :)
       Double Precision, Intent (In)       :: corners_3rd_array (:, :, :)
       Integer, Intent (In)                :: corners_actual_shape (1:2, *)
       Integer, Intent(Out)                :: ierror
     end subroutine prism_set_corners_3d_double_112

     subroutine prism_set_corners_3d_double_113(grid_id, nbr_corners, corners_actual_shape, &
            corners_1st_array, corners_2nd_array, corners_3rd_array, ierror)

       Integer, Intent (In)                :: grid_id
       Integer, Intent (In)                :: nbr_corners
       Double Precision, Intent (In)       :: corners_1st_array (:, :)
       Double Precision, Intent (In)       :: corners_2nd_array (:, :)
       Double Precision, Intent (In)       :: corners_3rd_array (:, :, :, :)
       Integer, Intent (In)                :: corners_actual_shape (1:2, *)
       Integer, Intent(Out)                :: ierror
     end subroutine prism_set_corners_3d_double_113

     subroutine prism_set_corners_3d_double_111(grid_id, nbr_corners, corners_actual_shape, &
            corners_1st_array, corners_2nd_array, corners_3rd_array, ierror)

       Integer, Intent (In)                :: grid_id
       Integer, Intent (In)                :: nbr_corners
       Double Precision, Intent (In)       :: corners_1st_array (:, :)
       Double Precision, Intent (In)       :: corners_2nd_array (:, :)
       Double Precision, Intent (In)       :: corners_3rd_array (:, :)
       Integer, Intent (In)                :: corners_actual_shape (1:2, *)
       Integer, Intent(Out)                :: ierror
     end subroutine prism_set_corners_3d_double_111

#ifndef PRISM_EXTENDED_WIDTH

     subroutine prism_set_corners_3d_real_333(grid_id, nbr_corners, corners_actual_shape, &
            corners_1st_array, corners_2nd_array, corners_3rd_array, ierror)

       Integer, Intent (In)                :: grid_id
       Integer, Intent (In)                :: nbr_corners
       Real, Intent (In)                   :: corners_1st_array (:, :, :, :)
       Real, Intent (In)                   :: corners_2nd_array (:, :, :, :)
       Real, Intent (In)                   :: corners_3rd_array (:, :, :, :)
       Integer, Intent (In)                :: corners_actual_shape (1:2, *)
       Integer, Intent(Out)                            :: ierror
     end subroutine prism_set_corners_3d_real_333

     subroutine prism_set_corners_3d_real_223(grid_id, nbr_corners, corners_actual_shape, &
            corners_1st_array, corners_2nd_array, corners_3rd_array, ierror)

       Integer, Intent (In)                :: grid_id
       Integer, Intent (In)                :: nbr_corners
       Real, Intent (In)                   :: corners_1st_array (:, :, :)
       Real, Intent (In)                   :: corners_2nd_array (:, :, :)
       Real, Intent (In)                   :: corners_3rd_array (:, :, :, :)
       Integer, Intent (In)                :: corners_actual_shape (1:2, *)
       Integer, Intent(Out)                :: ierror
     end subroutine prism_set_corners_3d_real_223

     subroutine prism_set_corners_3d_real_221(grid_id, nbr_corners, corners_actual_shape, &
            corners_1st_array, corners_2nd_array, corners_3rd_array, ierror)

       Integer, Intent (In)                :: grid_id
       Integer, Intent (In)                :: nbr_corners
       Real, Intent (In)                   :: corners_1st_array (:, :, :)
       Real, Intent (In)                   :: corners_2nd_array (:, :, :)
       Real, Intent (In)                   :: corners_3rd_array (:, :)
       Integer, Intent (In)                :: corners_actual_shape (1:2, *)
       Integer, Intent(Out)                :: ierror
     end subroutine prism_set_corners_3d_real_221

     subroutine prism_set_corners_3d_real_111(grid_id, nbr_corners, corners_actual_shape, &
            corners_1st_array, corners_2nd_array, corners_3rd_array, ierror)

       Integer, Intent (In)                :: grid_id
       Integer, Intent (In)                :: nbr_corners
       Real, Intent (In)                   :: corners_1st_array (:, :)
       Real, Intent (In)                   :: corners_2nd_array (:, :)
       Real, Intent (In)                   :: corners_3rd_array (:, :)
       Integer, Intent (In)                :: corners_actual_shape (1:2, *)
       Integer, Intent(Out)                :: ierror
     end subroutine prism_set_corners_3d_real_111

     subroutine prism_set_corners_3d_real_112(grid_id, nbr_corners, corners_actual_shape, &
            corners_1st_array, corners_2nd_array, corners_3rd_array, ierror)

       Integer, Intent (In)                :: grid_id
       Integer, Intent (In)                :: nbr_corners
       Real, Intent (In)                   :: corners_1st_array (:, :)
       Real, Intent (In)                   :: corners_2nd_array (:, :)
       Real, Intent (In)                   :: corners_3rd_array (:, :, :)
       Integer, Intent (In)                :: corners_actual_shape (1:2, *)
       Integer, Intent(Out)                :: ierror
     end subroutine prism_set_corners_3d_real_112

     subroutine prism_set_corners_3d_real_113(grid_id, nbr_corners, corners_actual_shape, &
            corners_1st_array, corners_2nd_array, corners_3rd_array, ierror)

       Integer, Intent (In)                :: grid_id
       Integer, Intent (In)                :: nbr_corners
       Real, Intent (In)                   :: corners_1st_array (:, :)
       Real, Intent (In)                   :: corners_2nd_array (:, :)
       Real, Intent (In)                   :: corners_3rd_array (:, :, :, :)
       Integer, Intent (In)                :: corners_actual_shape (1:2, *)
       Integer, Intent(Out)                :: ierror
     end subroutine prism_set_corners_3d_real_113
#endif

  End Interface prism_set_corners

  Interface prism_set_points

     subroutine prism_set_points_3d_double_333 (method_id, point_name, grid_id, points_actual_shape, &
                          points_1st_array, points_2nd_array, points_3rd_array, new_points, ierror)
       Character (len=*), Intent(In)                   :: point_name
       Integer, Intent(In)                             :: grid_id
       Integer, Intent(InOut)                          :: method_id
       Double Precision, Intent(In), dimension (:,:,:) :: points_1st_array, points_2nd_array, points_3rd_array
       Integer, Intent(In)                             :: points_actual_shape (2, *)
       Logical, Intent(In)                             :: new_points
       Integer, Intent(Out)                            :: ierror 
     end subroutine prism_set_points_3d_double_333

     subroutine prism_set_points_3d_double_223 (method_id, point_name, grid_id, points_actual_shape, &
                          points_1st_array, points_2nd_array, points_3rd_array, new_points, ierror)
       Character (len=*), Intent(In)                   :: point_name
       Integer, Intent(In)                             :: grid_id
       Integer, Intent(InOut)                          :: method_id
       Double Precision, Intent(In), dimension (:,:)   :: points_1st_array, points_2nd_array
       Double Precision, Intent(In), dimension (:,:,:) :: points_3rd_array
       Integer, Intent(In)                             :: points_actual_shape (2, *)
       Logical, Intent(In)                             :: new_points
       Integer, Intent(Out)                            :: ierror 
     end subroutine prism_set_points_3d_double_223

     subroutine prism_set_points_3d_double_221 (method_id, point_name, grid_id, points_actual_shape, &
                          points_1st_array, points_2nd_array, points_3rd_array, new_points, ierror)
       Character (len=*), Intent(In)                   :: point_name
       Integer, Intent(In)                             :: grid_id
       Integer, Intent(InOut)                          :: method_id
       Double Precision, Intent(In), dimension (:,:)   :: points_1st_array, points_2nd_array
       Double Precision, Intent(In), dimension (:)     :: points_3rd_array
       Integer, Intent(In)                             :: points_actual_shape (2, *)
       Logical, Intent(In)                             :: new_points
       Integer, Intent(Out)                            :: ierror 
     end subroutine prism_set_points_3d_double_221

     subroutine prism_set_points_3d_double_113 (method_id, point_name, grid_id, points_actual_shape, &
                          points_1st_array, points_2nd_array, points_3rd_array, new_points, ierror)
       Character (len=*), Intent(In)                   :: point_name
       Integer, Intent(In)                             :: grid_id
       Integer, Intent(InOut)                          :: method_id
       Double Precision, Intent(In), dimension (:)     :: points_1st_array, points_2nd_array
       Double Precision, Intent(In), dimension (:,:,:) :: points_3rd_array
       Integer, Intent(In)                             :: points_actual_shape (2, *)
       Logical, Intent(In)                             :: new_points
       Integer, Intent(Out)                            :: ierror 
     end subroutine prism_set_points_3d_double_113

     subroutine prism_set_points_3d_double_112 (method_id, point_name, grid_id, points_actual_shape, &
                          points_1st_array, points_2nd_array, points_3rd_array, new_points, ierror)
       Character (len=*), Intent(In)                 :: point_name
       Integer, Intent(In)                           :: grid_id
       Integer, Intent(InOut)                        :: method_id
       Double Precision, Intent(In), dimension (:)   :: points_1st_array, points_2nd_array
       Double Precision, Intent(In), dimension (:,:) :: points_3rd_array
       Integer, Intent(In)                           :: points_actual_shape (2, *)
       Logical, Intent(In)                           :: new_points
       Integer, Intent(Out)                          :: ierror 
     end subroutine prism_set_points_3d_double_112

     subroutine prism_set_points_3d_double_111 (method_id, point_name, grid_id, points_actual_shape, &
                          points_1st_array, points_2nd_array, points_3rd_array, new_points, ierror)
       Character (len=*), Intent(In)                 :: point_name
       Integer, Intent(In)                           :: grid_id
       Integer, Intent(InOut)                        :: method_id
       Double Precision, Intent(In), dimension (:)   :: points_1st_array, points_2nd_array
       Double Precision, Intent(In), dimension (:)   :: points_3rd_array
       Integer, Intent(In)                           :: points_actual_shape (2, *)
       Logical, Intent(In)                           :: new_points
       Integer, Intent(Out)                          :: ierror
     end subroutine prism_set_points_3d_double_111


#ifndef PRISM_EXTENDED_WIDTH

     subroutine prism_set_points_3d_real_333 (method_id, point_name, grid_id, points_actual_shape, &
                          points_1st_array, points_2nd_array, points_3rd_array, new_points, ierror)
       Character (len=*), Intent(In)                 :: point_name
       Integer, Intent(In)                           :: grid_id
       Integer, Intent(InOut)                        :: method_id
       Real,    Intent(In), dimension (:,:,:)        :: points_1st_array, points_2nd_array, points_3rd_array
       Integer, Intent(In)                           :: points_actual_shape (2, *)
       Logical, Intent(In)                           :: new_points
       Integer, Intent(Out)                          :: ierror 
     end subroutine prism_set_points_3d_real_333

     subroutine prism_set_points_3d_real_223 (method_id, point_name, grid_id, points_actual_shape, &
                          points_1st_array, points_2nd_array, points_3rd_array, new_points, ierror)
       Character (len=*), Intent(In)                 :: point_name
       Integer, Intent(In)                           :: grid_id
       Integer, Intent(InOut)                        :: method_id
       Real, Intent(In), dimension (:,:)             :: points_1st_array, points_2nd_array
       Real, Intent(In), dimension (:,:,:)           :: points_3rd_array
       Integer, Intent(In)                           :: points_actual_shape (2, *)
       Logical, Intent(In)                           :: new_points
       Integer, Intent(Out)                          :: ierror 
     end subroutine prism_set_points_3d_real_223

     subroutine prism_set_points_3d_real_221 (method_id, point_name, grid_id, points_actual_shape, &
                          points_1st_array, points_2nd_array, points_3rd_array, new_points, ierror)
       Character (len=*), Intent(In)                 :: point_name
       Integer, Intent(In)                           :: grid_id
       Integer, Intent(InOut)                        :: method_id
       Real, Intent(In), dimension (:,:)             :: points_1st_array, points_2nd_array
       Real, Intent(In), dimension (:)               :: points_3rd_array
       Integer, Intent(In)                           :: points_actual_shape (2, *)
       Logical, Intent(In)                           :: new_points
       Integer, Intent(Out)                          :: ierror 
     end subroutine prism_set_points_3d_real_221

     subroutine prism_set_points_3d_real_122 (method_id, point_name, grid_id, points_actual_shape, &
                          points_1st_array, points_2nd_array, points_3rd_array, new_points, ierror)
       Character (len=*), Intent(In)                 :: point_name
       Integer, Intent(In)                           :: grid_id
       Integer, Intent(InOut)                        :: method_id
       Real, Intent(In), dimension (:)               :: points_1st_array
       Real, Intent(In), dimension (:,:)             :: points_2nd_array, points_3rd_array
       Integer, Intent(In)                           :: points_actual_shape (2, *)
       Logical, Intent(In)                           :: new_points
       Integer, Intent(Out)                          :: ierror 
     end subroutine prism_set_points_3d_real_122

     subroutine prism_set_points_3d_real_113 (method_id, point_name, grid_id, points_actual_shape, &
                          points_1st_array, points_2nd_array, points_3rd_array, new_points, ierror)
       Character (len=*), Intent(In)                 :: point_name
       Integer, Intent(In)                           :: grid_id
       Integer, Intent(InOut)                        :: method_id
       Real, Intent(In), dimension (:)               :: points_1st_array, points_2nd_array
       Real, Intent(In), dimension (:,:,:)           :: points_3rd_array
       Integer, Intent(In)                           :: points_actual_shape (2, *)
       Logical, Intent(In)                           :: new_points
       Integer, Intent(Out)                          :: ierror 
     end subroutine prism_set_points_3d_real_113

     subroutine prism_set_points_3d_real_112 (method_id, point_name, grid_id, points_actual_shape, &
                          points_1st_array, points_2nd_array, points_3rd_array, new_points, ierror)
       Character (len=*), Intent(In)                 :: point_name
       Integer, Intent(In)                           :: grid_id
       Integer, Intent(InOut)                        :: method_id
       Real, Intent(In), dimension (:)               :: points_1st_array, points_2nd_array
       Real, Intent(In), dimension (:,:)             :: points_3rd_array
       Integer, Intent(In)                           :: points_actual_shape (2, *)
       Logical, Intent(In)                           :: new_points
       Integer, Intent(Out)                          :: ierror 
     end subroutine prism_set_points_3d_real_112

     subroutine prism_set_points_3d_real_111 (method_id, point_name, grid_id, points_actual_shape, &
                          points_1st_array, points_2nd_array, points_3rd_array, new_points, ierror)
       Character (len=*), Intent(In)                 :: point_name
       Integer, Intent(In)                           :: grid_id
       Integer, Intent(InOut)                        :: method_id
       Real, Intent(In), dimension (:)               :: points_1st_array, points_2nd_array
       Real, Intent(In), dimension (:)               :: points_3rd_array
       Integer, Intent(In)                           :: points_actual_shape (2, *)
       Logical, Intent(In)                           :: new_points
       Integer, Intent(Out)                          :: ierror
     end subroutine prism_set_points_3d_real_111

#endif /* PRISM_EXTENDED_WIDTH */

  End Interface prism_set_points

! ----------------------------------------------------------------------------
! Overloading PRISM_Calc_newdate
! ----------------------------------------------------------------------------

  Interface  PRISM_Calc_newdate

     subroutine prism_calc_newdate_int ( date, date_incr, ierror )
       use PRISM_Constants, only : PRISM_Time_struct
       Integer, Intent(In)                     :: date_incr
       Type (PRISM_Time_struct), Intent(InOut) :: date
       Integer, Intent(Out)                    :: ierror
     end subroutine prism_calc_newdate_int

#ifndef PRISM_EXTENDED_WIDTH
     subroutine prism_calc_newdate_real ( date, date_incr, ierror )
       use PRISM_Constants, only : PRISM_Time_struct
       Real, Intent(In)                        :: date_incr
       Type (PRISM_Time_struct), Intent(InOut) :: date
       Integer, Intent(Out)                    :: ierror
     end subroutine prism_calc_newdate_real
#endif

     subroutine prism_calc_newdate_double ( date, date_incr, ierror )
       use PRISM_Constants, only : PRISM_Time_struct
       Double Precision, Intent(In)            :: date_incr
       Type (PRISM_Time_struct), Intent(InOut) :: date
       Integer, Intent(Out)                    :: ierror
     end subroutine prism_calc_newdate_double

  End Interface

! ----------------------------------------------------------------------------
! Interfaces of PRISM routines
! ----------------------------------------------------------------------------

  Interface

     subroutine prism_init ( appl_name, ierror )
       Character (len=*), Intent(In) :: appl_name
       Integer, Intent (Out)         :: ierror
     end subroutine prism_init

     subroutine prism_initialized ( flag, ierror )
       Logical, Intent (Out) :: flag
       Integer, Intent (Out) :: ierror
     end subroutine prism_initialized

     subroutine prism_init_comp ( comp_id, comp_name, ierror )
       Character (len=*), Intent(In) :: comp_name
       Integer, Intent (Out) :: comp_id, ierror
     end subroutine prism_init_comp

     subroutine prism_enddef ( ierror )
       Integer, Intent (Out) :: ierror
     end subroutine prism_enddef

     subroutine prism_terminate ( ierror )
       Integer, Intent (Out) :: ierror
     end subroutine prism_terminate

     subroutine prism_terminated ( flag, ierror )
       Logical, Intent (Out) :: flag
       Integer, Intent (Out) :: ierror
     end subroutine prism_terminated

     subroutine prism_abort ( comp_id, file, mesg )
       Integer, Intent (InOut)      :: comp_id
       Character(len=*), Intent(In) :: file
       Character(len=*), Intent(In) :: mesg
     end subroutine prism_abort

     subroutine prism_error ( ierror, error_message )
       Character(len=*), Intent (Out) :: error_message
       Integer, Intent (In)           :: ierror
     end subroutine prism_error

     subroutine prism_message ( comp_id, string )
       Integer, Intent (In)          :: comp_id
       Character (len=*), Intent(In) :: string
     end subroutine prism_message

     subroutine prism_version ()
     end subroutine prism_version

     subroutine prism_get_localcomm ( comp_id, local_comm, ierror )
       Integer, Intent (In)  :: comp_id
       Integer, Intent (Out) :: local_comm, ierror
     end subroutine prism_get_localcomm

     subroutine prism_get_selected_real_type ( prec, range, type, ierror)
       Integer, Intent (In)  :: prec, range
       Integer, Intent (Out) :: type, ierror
     end subroutine prism_get_selected_real_type

     subroutine prism_get_real_kind_type ( kindr, type, ierror)
       Integer, Intent (In)  :: kindr
       Integer, Intent (Out) :: type, ierror
     end subroutine prism_get_real_kind_type

     subroutine prism_get_calendar_type ( calendar_name, calendar_type_id, ierror )
       Character(len=132), Intent(Out) :: calendar_name
       Integer, Intent (Out)           :: calendar_type_id
       Integer, Intent (Out)           :: ierror
     end subroutine prism_get_calendar_type

     subroutine prism_get_nb_ranklists ( comp_name, nb_ranklists, ierror )
       Character(len=*), Intent(In)    :: comp_name
       Integer, Intent (Out)           :: nb_ranklists
       Integer, Intent (Out)           :: ierror
     end subroutine prism_get_nb_ranklists

     subroutine prism_get_ranklists ( comp_name, nb_ranklists, ranklists, ierror )
       Character(len=*), Intent(In)    :: comp_name
       Integer, Intent(In)             :: nb_ranklists
       Integer, Dimension(nb_ranklists,3), Intent (Out) :: ranklists
       Integer, Intent (Out)           :: ierror
     end subroutine prism_get_ranklists

! ----------------------------------------------------------------------------
! Grid definition and specifications for grid definitions
! ----------------------------------------------------------------------------

      subroutine prism_def_grid (grid_id, grid_name, comp_id, &
                                 grid_valid_shape, grid_type, ierror )

         character(len=*), intent(in) :: grid_name
         integer, intent (in)         :: comp_id
         integer, intent (in)         :: grid_valid_shape (1:2,*)
         integer, intent (in)         :: grid_type
         integer, intent (out)        :: grid_id
         integer, intent (out)        :: ierror
      end subroutine prism_def_grid

      subroutine prism_def_partition (grid_id, nbr_blocks, &
                                      partition_array, extent_array, ierror )
         integer, intent (in)  :: grid_id
         integer, intent (in)  :: nbr_blocks
         integer, intent (in)  :: partition_array(1:nbr_blocks,*)
         integer, intent (in)  :: extent_array(1:nbr_blocks,*)
         integer, intent (out) :: ierror
      end subroutine prism_def_partition

      subroutine prism_set_mask (mask_id, grid_id, mask_actual_shape, &
                                 mask_array, new_mask, ierror)
         integer, intent(inout) :: mask_id
         integer, intent(in)    :: grid_id
         integer, intent(in)    :: mask_actual_shape(2, *)
         logical, intent(in)    :: mask_array (*)
         logical, intent(in)    :: new_mask
         integer, intent(out)   :: ierror
      end subroutine prism_set_mask

      subroutine prism_def_var (var_id, var_name, grid_id, point_id, mask_id, &
                                var_nodims, var_actual_shape, var_type, ierror)
         character (len=*), intent (in) :: var_name
         integer, intent (in)           :: mask_id
         integer, intent (in)           :: point_id
         integer, intent (in)           :: grid_id
         integer, intent (in)           :: var_nodims(2)
         integer, intent (in)           :: var_actual_shape(1:2,1:var_nodims(1))
         integer, intent (in)           :: var_type
         integer, intent (out)          :: var_id
         integer, intent (out)          :: ierror
      end subroutine prism_def_var

      subroutine prism_reducedgrid_map (grid_id, nbr_latitudes, &
                                        nbr_points_per_lat, ierror)
         integer, intent (in)  :: grid_id
         integer, intent (in)  :: nbr_latitudes
         integer, intent (in)  :: nbr_points_per_lat(nbr_latitudes)
         integer, intent (out) :: ierror
      end subroutine prism_reducedgrid_map

      subroutine prism_set_points_gridless (point_id, point_name, grid_id, &
                                            new_points, ierror)
         character (len=*), intent(in)    :: point_name
         integer,           intent(in)    :: grid_id
         integer,           intent(inout) :: point_id
         logical,           intent(in)    :: new_points
         integer,           intent(out)   :: ierror
      end subroutine prism_set_points_gridless

! ----------------------------------------------------------------------------
! Routines related to file I/O
! ----------------------------------------------------------------------------

     subroutine prism_get_io_units ( no_of_remaining_units, units, ierror )
       Integer, Intent (Out)               :: units(:)
       Integer, Intent (Out)               :: no_of_remaining_units
       Integer, Intent (Out)               :: ierror
     end subroutine PRISM_Get_IO_Units

     subroutine prism_put_inquire ( field_id, date, date_bounds, info, ierror )
       use PRISM_Constants, only : PRISM_Time_struct
       Integer, Intent (In)                 :: field_id
       Type(PRISM_Time_Struct), Intent (In) :: date
       Type(PRISM_Time_Struct), Intent (In) :: date_bounds(2)
       Integer, Intent (Out)                :: info
       Integer, Intent (Out)                :: ierror
     end subroutine prism_put_inquire

  End Interface

end module PRISM