fms_string_utils.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/>.
!***********************************************************************
 
!> @brief Converts a 1D array of real numbers to a string
!> @return The 1D array as a string
function stringify_1d_(arr, fmt)
  real(STRING_UTILS_KIND_), dimension(:), intent(in) :: arr !< Real array to be converted to a string
  character(*), intent(in), optional :: fmt !< Optional format string for the real array entries
  character(:), allocatable :: STRINGIFY_1D_
  integer :: i, n
 
  n = size(arr)
 
  if (n .gt. 0) then
    stringify_1d_ = "[" // string(arr(1), fmt)
  else
    stringify_1d_ = "["
  endif
 
  do i = 2,n
    stringify_1d_ = stringify_1d_ // ", " // string(arr(i), fmt)
  enddo
 
  stringify_1d_ = stringify_1d_ // "]"
end function
 
!> @brief Converts a 2D array of real numbers to a string
!> @return The 2D array as a string
function stringify_2d_(arr, fmt)
  real(STRING_UTILS_KIND_), dimension(:,:), intent(in) :: arr !< Real array to be converted to a string
  character(*), intent(in), optional :: fmt !< Optional format string for the real array entries
  character(:), allocatable :: STRINGIFY_2D_
  integer :: i, n
 
  n = size(arr, 2)
 
  if (n .gt. 0) then
    stringify_2d_ = "[" // stringify_1d_(arr(:,1), fmt)
  else
    stringify_2d_ = "["
  endif
 
  do i = 2,n
    stringify_2d_ = stringify_2d_ // ", " // stringify_1d_(arr(:,i), fmt)
  enddo
 
  stringify_2d_ = stringify_2d_ // "]"
end function
 
!> @brief Converts a 3D array of real numbers to a string
!> @return The 3D array as a string
function stringify_3d_(arr, fmt)
  real(STRING_UTILS_KIND_), dimension(:,:,:), intent(in) :: arr !< Real array to be converted to a string
  character(*), intent(in), optional :: fmt !< Optional format string for the real array entries
  character(:), allocatable :: STRINGIFY_3D_
  integer :: i, n
 
  n = size(arr, 3)
 
  if (n .gt. 0) then
    stringify_3d_ = "[" // stringify_2d_(arr(:,:,1), fmt)
  else
    stringify_3d_ = "["
  endif
 
  do i = 2,n
    stringify_3d_ = stringify_3d_ // ", " // stringify_2d_(arr(:,:,i), fmt)
  enddo
 
  stringify_3d_ = stringify_3d_ // "]"
end function