get_data_type_string.inc

!***********************************************************************
!*                   GNU Lesser General Public License
!*
!* This file is part of the GFDL Flexible Modeling System (FMS).
!*
!* FMS is free software: you can redistribute it and/or modify it under
!* the terms of the GNU Lesser General Public License as published by
!* the Free Software Foundation, either version 3 of the License, or (at
!* your option) any later version.
!*
!* FMS is distributed in the hope that it will be useful, but WITHOUT
!* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
!* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
!* for more details.
!*
!* You should have received a copy of the GNU Lesser General Public
!* License along with FMS.  If not, see <http://www.gnu.org/licenses/>.
!***********************************************************************
!> @file
!> @brief Routines to return a given arguments data type as a string.
!! Provides multiple dimensions for @ref get_data_type_string interface.
 
!> @addtogroup fms_io_utils_mod
!> @{
 
!> @brief Return a string describing the input data's type.
subroutine get_data_type_string_0d(sdata, type_string)
 
  class(*),  intent(in) :: sdata !> Data.
  character(len=*), intent(inout) :: type_string !> Data type.
 
  select type(sdata)
    type is (integer(kind=i4_kind))
      call string_copy(type_string, "int")
    type is (integer(kind=i8_kind))
      call string_copy(type_string, "i8_kind")
    type is (real(kind=r4_kind))
      call string_copy(type_string, "float")
    type is (real(kind=r8_kind))
      call string_copy(type_string, "double")
    type is (character(len=*))
      call string_copy(type_string, "char")
    class default
      call error("unsupported type.")
    end select
end subroutine get_data_type_string_0d
 
 
 
!> @brief Return a string describing the input data's type.
subroutine get_data_type_string_1d(sdata, type_string)
 
  class(*), dimension(:), intent(in) :: sdata !> Data.
  character(len=*), intent(inout) :: type_string !> Data type.
 
  select type(sdata)
    type is (integer(kind=i4_kind))
      call string_copy(type_string, "int")
    type is (integer(kind=i8_kind))
      call string_copy(type_string, "i8_kind")
    type is (real(kind=r4_kind))
      call string_copy(type_string, "float")
    type is (real(kind=r8_kind))
      call string_copy(type_string, "double")
    type is (character(len=*))
      call string_copy(type_string, "char")
    class default
      call error("unsupported type.")
    end select
end subroutine get_data_type_string_1d
 
 
 
!> @brief Return a string describing the input data's type.
subroutine get_data_type_string_2d(sdata, type_string)
 
  class(*), dimension(:,:), intent(in) :: sdata !> Data.
  character(len=*), intent(inout) :: type_string !> Data type.
 
  select type(sdata)
    type is (integer(kind=i4_kind))
      call string_copy(type_string, "int")
    type is (integer(kind=i8_kind))
      call string_copy(type_string, "i8_kind")
    type is (real(kind=r4_kind))
      call string_copy(type_string, "float")
    type is (real(kind=r8_kind))
      call string_copy(type_string, "double")
    type is (character(len=*))
      call string_copy(type_string, "char")
    class default
      call error("unsupported type.")
    end select
end subroutine get_data_type_string_2d
 
 
 
!> @brief Return a string describing the input data's type.
subroutine get_data_type_string_3d(sdata, type_string)
 
  class(*), dimension(:,:,:), intent(in) :: sdata !> Data.
  character(len=*), intent(inout) :: type_string !> Data type.
 
  select type(sdata)
    type is (integer(kind=i4_kind))
      call string_copy(type_string, "int")
    type is (integer(kind=i8_kind))
      call string_copy(type_string, "i8_kind")
    type is (real(kind=r4_kind))
      call string_copy(type_string, "float")
    type is (real(kind=r8_kind))
      call string_copy(type_string, "double")
    type is (character(len=*))
      call string_copy(type_string, "char")
    class default
      call error("unsupported type.")
    end select
end subroutine get_data_type_string_3d
 
 
 
!> @brief Return a string describing the input data's type.
subroutine get_data_type_string_4d(sdata, type_string)
 
  class(*), dimension(:,:,:,:), intent(in) :: sdata !> Data.
  character(len=*), intent(inout) :: type_string !> Data type.
 
  select type(sdata)
    type is (integer(kind=i4_kind))
      call string_copy(type_string, "int")
    type is (integer(kind=i8_kind))
      call string_copy(type_string, "i8_kind")
    type is (real(kind=r4_kind))
      call string_copy(type_string, "float")
    type is (real(kind=r8_kind))
      call string_copy(type_string, "double")
    type is (character(len=*))
      call string_copy(type_string, "char")
    class default
      call error("unsupported type.")
    end select
end subroutine get_data_type_string_4d
 
 
 
!> @brief Return a string describing the input data's type.
subroutine get_data_type_string_5d(sdata, type_string)
 
  class(*), dimension(:,:,:,:,:), intent(in) :: sdata !> Data.
  character(len=*), intent(inout) :: type_string !> Data type.
 
  select type(sdata)
    type is (integer(kind=i4_kind))
      call string_copy(type_string, "int")
    type is (integer(kind=i8_kind))
      call string_copy(type_string, "i8_kind")
    type is (real(kind=r4_kind))
      call string_copy(type_string, "float")
    type is (real(kind=r8_kind))
      call string_copy(type_string, "double")
    type is (character(len=*))
      call string_copy(type_string, "char")
    class default
      call error("unsupported type.")
    end select
end subroutine get_data_type_string_5d
!> @}