mom_string_functions Module Reference

Functions/Subroutines
character(len=len(input_string)) function, public	lowercase (input_string)
character(len=len(input_string)) function, public	uppercase (input_string)
character(len=19) function, public	left_int (i)
character(len=1320) function, public	left_ints (i)
character(len=32) function, public	left_real (val)
character(len=1320) function, public	left_reals (r, sep)
logical function	isformattedfloatequalto (str, val)
character(len=120) function, public	extractword (string, n)
	Returns the string corresponding to the nth word in the argument or "" if the string is not long enough. Both spaces and commas are interpreted as separators. More...
character(len=120) function, public	extract_word (string, separators, n)
	Returns the string corresponding to the nth word in the argument or "" if the string is not long enough. Words are delineated by the mandatory separators argument. More...
integer function, public	extract_integer (string, separators, n, missing_value)
	Returns the integer corresponding to the nth word in the argument. More...
real function, public	extract_real (string, separators, n, missing_value)
	Returns the real corresponding to the nth word in the argument. More...
character(len=120) function, public	remove_spaces (string)
	Returns string with all spaces removed. More...
logical function, public	string_functions_unit_tests (verbose)
	Returns true if a unit test of string_functions fails. More...
logical function	localtests (verbose, str1, str2)
	True if str1 does not match str2. False otherwise. More...
logical function	localtesti (verbose, i1, i2)
	True if i1 is not equal to i2. False otherwise. More...
logical function	localtestr (verbose, r1, r2)
	True if r1 is not equal to r2. False otherwise. More...
character(len=len(dir)+2) function, public	slasher (dir)
	Returns a directory name that is terminated with a "/" or "./" if the argument is an empty string. More...

Function/Subroutine Documentation

extract_integer()

integer function, public mom_string_functions::extract_integer	(	character(len=*), intent(in)	string,
		character(len=*), intent(in)	separators,
		integer, intent(in)	n,
		integer, intent(in), optional	missing_value
	)

Returns the integer corresponding to the nth word in the argument.

Parameters

[in]	string	String to scan
[in]	separators	Characters to use for delineation
[in]	n	Number of word to extract
[in]	missing_value	Value to assign if word is missing

Definition at line 265 of file MOM_string_functions.F90.

References extract_word().

Referenced by mom_regridding::initialize_regridding(), and string_functions_unit_tests().

  character(len=*),   intent(in) :: string     !< String to scan
  character(len=*),   intent(in) :: separators !< Characters to use for delineation
  integer,            intent(in) :: n          !< Number of word to extract
  integer, optional,  intent(in) :: missing_value !< Value to assign if word is missing
  ! Local variables
  integer :: ns, i, b, e, nw
  character(len=20) :: word

  word = extract_word(string, separators, n)

  if (len_trim(word)>0) then
    read(word(1:len_trim(word)),*) extract_integer
  else
    if (present(missing_value)) then
      extract_integer = missing_value
    else
      extract_integer = 0
    endif
  endif

Here is the call graph for this function:

Here is the caller graph for this function:

extract_real()

real function, public mom_string_functions::extract_real	(	character(len=*), intent(in)	string,
		character(len=*), intent(in)	separators,
		integer, intent(in)	n,
		real, intent(in), optional	missing_value
	)

Returns the real corresponding to the nth word in the argument.

Parameters

[in]	string	String to scan
[in]	separators	Characters to use for delineation
[in]	n	Number of word to extract
[in]	missing_value	Value to assign if word is missing

Definition at line 289 of file MOM_string_functions.F90.

References extract_word().

Referenced by mom_regridding::initialize_regridding(), and string_functions_unit_tests().

  character(len=*), intent(in) :: string     !< String to scan
  character(len=*), intent(in) :: separators !< Characters to use for delineation
  integer,          intent(in) :: n          !< Number of word to extract
  real, optional,   intent(in) :: missing_value !< Value to assign if word is missing
  ! Local variables
  integer :: ns, i, b, e, nw
  character(len=20) :: word

  word = extract_word(string, separators, n)

  if (len_trim(word)>0) then
    read(word(1:len_trim(word)),*) extract_real
  else
    if (present(missing_value)) then
      extract_real = missing_value
    else
      extract_real = 0
    endif
  endif

Here is the call graph for this function:

Here is the caller graph for this function:

extract_word()

character(len=120) function, public mom_string_functions::extract_word	(	character(len=*), intent(in)	string,
		character(len=*), intent(in)	separators,
		integer, intent(in)	n
	)

Returns the string corresponding to the nth word in the argument or "" if the string is not long enough. Words are delineated by the mandatory separators argument.

Parameters

[in]	string	String to scan
[in]	separators	Characters to use for delineation
[in]	n	Number of word to extract

Definition at line 228 of file MOM_string_functions.F90.

Referenced by extract_integer(), extract_real(), extractword(), mom_open_boundary::parse_segment_data_str(), mom_open_boundary::parse_segment_str(), and string_functions_unit_tests().

  character(len=*),   intent(in) :: string     !< String to scan
  character(len=*),   intent(in) :: separators !< Characters to use for delineation
  integer,            intent(in) :: n          !< Number of word to extract
  ! Local variables
  integer :: ns, i, b, e, nw
  logical :: lastcharisseperator
  extract_word = ''
  lastcharisseperator = .true.
  ns = len_trim(string)
  i = 0; b=0; e=0; nw=0;
  do while (i<ns)
    i = i+1
    if (lastcharisseperator) then ! search for end of word
      if (verify(string(i:i),separators)==0) then
        continue ! Multiple separators
      else
        lastcharisseperator = .false. ! character is beginning of word
        b = i
        continue
      endif
    else ! continue search for end of word
      if (verify(string(i:i),separators)==0) then
        lastcharisseperator = .true.
        e = i-1 ! Previous character is end of word
        nw = nw+1
        if (nw==n) then
          extract_word = trim(string(b:e))
          return
        endif
      endif
    endif
  enddo
  if (b<=ns .and. nw==n-1) extract_word = trim(string(b:ns))

Here is the caller graph for this function:

extractword()

character(len=120) function, public mom_string_functions::extractword	(	character(len=*), intent(in)	string,
		integer, intent(in)	n
	)

Returns the string corresponding to the nth word in the argument or "" if the string is not long enough. Both spaces and commas are interpreted as separators.

Definition at line 217 of file MOM_string_functions.F90.

References extract_word().

Referenced by mom_diag_remap::diag_remap_init(), mom_regridding::initialize_regridding(), and string_functions_unit_tests().

  character(len=*),   intent(in) :: string
  integer,            intent(in) :: n

  extractword = extract_word(string, ' ,', n)

Here is the call graph for this function:

Here is the caller graph for this function:

isformattedfloatequalto()

logical function mom_string_functions::isformattedfloatequalto ( character(len=*), intent(in)  str, real, intent(in)  val  )

private

Definition at line 199 of file MOM_string_functions.F90.

Referenced by left_real().

! Returns True if the string can be read/parsed to give the exact
! value of "val"
  character(len=*), intent(in) :: str
  real,             intent(in) :: val
  logical                      :: isformattedfloatequalto
  ! Local variables
  real :: scannedval

  isformattedfloatequalto=.false.
  read(str(1:),*,err=987) scannedval
  if (scannedval == val) isformattedfloatequalto=.true.
 987 return

Here is the caller graph for this function:

left_int()

character(len=19) function, public mom_string_functions::left_int

(

integer, intent(in)

i

)

Definition at line 83 of file MOM_string_functions.F90.

Referenced by left_ints(), left_reals(), and string_functions_unit_tests().

! Returns a character string of a left-formatted integer
! e.g. "123       "  (assumes 19 digit maximum)
  ! Arguments
  character(len=19) :: left_int
  integer, intent(in) :: i
  ! Local variables
  character(len=19) :: tmp
  write(tmp(1:19),'(I19)') i
  write(left_int(1:19),'(A)') adjustl(tmp)

Here is the caller graph for this function:

left_ints()

character(len=1320) function, public mom_string_functions::left_ints

(

integer, dimension(:), intent(in)

i

)

Definition at line 95 of file MOM_string_functions.F90.

References left_int().

Referenced by string_functions_unit_tests().

! Returns a character string of a comma-separated, compact formatted,
! integers  e.g. "1, 2, 3, 4"
  ! Arguments
  character(len=1320) :: left_ints
  integer, intent(in) :: i(:)
  ! Local variables
  character(len=1320) :: tmp
  integer :: j
  write(left_ints(1:1320),'(A)') trim(left_int(i(1)))
  if (size(i)>1) then
    do j=2,size(i)
      tmp=left_ints
      write(left_ints(1:1320),'(A,", ",A)') trim(tmp),trim(left_int(i(j)))
    enddo
  endif

Here is the call graph for this function:

Here is the caller graph for this function:

left_real()

character(len=32) function, public mom_string_functions::left_real

(

real, intent(in)

val

)

Definition at line 113 of file MOM_string_functions.F90.

References isformattedfloatequalto().

Referenced by left_reals(), mom_file_parser::log_param_real(), and string_functions_unit_tests().

  real, intent(in)  :: val
  character(len=32) :: left_real
! Returns a left-justified string with a real formatted like '(G)'
  integer :: l, ind

  if ((abs(val) < 1.0e4) .and. (abs(val) >= 1.0e-3)) then
    write(left_real, '(F30.11)') val
    if (.not.isformattedfloatequalto(left_real,val)) then
      write(left_real, '(F30.12)') val
      if (.not.isformattedfloatequalto(left_real,val)) then
        write(left_real, '(F30.13)') val
        if (.not.isformattedfloatequalto(left_real,val)) then
          write(left_real, '(F30.14)') val
          if (.not.isformattedfloatequalto(left_real,val)) then
            write(left_real, '(F30.15)') val
            if (.not.isformattedfloatequalto(left_real,val)) then
              write(left_real, '(F30.16)') val
            endif
          endif
        endif
      endif
    endif
    do
      l = len_trim(left_real)
      if ((l<2) .or. (left_real(l-1:l) == ".0") .or. &
          (left_real(l:l) /= "0")) exit
      left_real(l:l) = " "
    enddo
  elseif (val == 0.) then
    left_real = "0.0"
  else
    write(left_real(1:32), '(ES23.14)') val
    if (.not.isformattedfloatequalto(left_real,val)) then
     write(left_real(1:32), '(ES23.15)') val
    endif
    do
      ind = index(left_real,"0E")
      if (ind == 0) exit
      if (left_real(ind-1:ind-1) == ".") exit
      left_real = left_real(1:ind-1)//left_real(ind+1:)
    enddo
  endif
  left_real = adjustl(left_real)

Here is the call graph for this function:

Here is the caller graph for this function:

left_reals()

character(len=1320) function, public mom_string_functions::left_reals	(	real, dimension(:), intent(in)	r,
		character(len=*), optional	sep
	)

Definition at line 159 of file MOM_string_functions.F90.

References left_int(), and left_real().

Referenced by mom_file_parser::log_param_real_array(), and string_functions_unit_tests().

! Returns a character string of a comma-separated, compact formatted, reals
! e.g. "1., 2., 5*3., 5.E2"
  ! Arguments
  character(len=1320) :: left_reals
  real, intent(in) :: r(:)
  character(len=*), optional :: sep
  ! Local variables
  integer :: j, n, b, ns
  logical :: dowrite
  character(len=10) :: separator
  n=1 ; dowrite=.true. ; left_reals='' ; b=1
  if (present(sep)) then
    separator=sep ; ns=len(sep)
  else
    separator=', ' ; ns=2
  endif
  do j=1,size(r)
    dowrite=.true.
    if (j<size(r)) then
      if (r(j)==r(j+1)) then
        n=n+1
        dowrite=.false.
      endif
    endif
    if (dowrite) then
      if (b>1) then ! Write separator if a number has already been written
        write(left_reals(b:),'(A)') separator
        b=b+ns
      endif
      if (n>1) then
        write(left_reals(b:),'(A,"*",A)') trim(left_int(n)),trim(left_real(r(j)))
      else
        write(left_reals(b:),'(A)') trim(left_real(r(j)))
      endif
      n=1 ; b=len_trim(left_reals)+1
    endif
  enddo

Here is the call graph for this function:

Here is the caller graph for this function:

localtesti()

logical function mom_string_functions::localtesti ( logical, intent(in)  verbose, integer, intent(in)  i1, integer, intent(in)  i2  )

private

True if i1 is not equal to i2. False otherwise.

Parameters

[in]	verbose	If true, write results to stdout
[in]	i1	Integer
[in]	i2	Integer

Definition at line 392 of file MOM_string_functions.F90.

Referenced by string_functions_unit_tests().

  logical, intent(in) :: verbose !< If true, write results to stdout
  integer, intent(in) :: i1 !< Integer
  integer, intent(in) :: i2 !< Integer
  localtesti=.false.
  if (i1/=i2) localtesti=.true.
  if (localtesti .or. verbose) then
    write(*,*) i1,i2
    if (localtesti) write(*,*) i1,'!=',i2, '<-- FAIL'
  endif

Here is the caller graph for this function:

localtestr()

logical function mom_string_functions::localtestr ( logical, intent(in)  verbose, real, intent(in)  r1, real, intent(in)  r2  )

private

True if r1 is not equal to r2. False otherwise.

Parameters

[in]	verbose	If true, write results to stdout
[in]	r1	Float
[in]	r2	Float

Definition at line 405 of file MOM_string_functions.F90.

Referenced by string_functions_unit_tests().

  logical, intent(in) :: verbose !< If true, write results to stdout
  real, intent(in) :: r1 !< Float
  real, intent(in) :: r2 !< Float
  localtestr=.false.
  if (r1/=r2) localtestr=.true.
  if (localtestr .or. verbose) then
    write(*,*) r1,r2
    if (localtestr) write(*,*) r1,'!=',r2, '<-- FAIL'
  endif

Here is the caller graph for this function:

localtests()

logical function mom_string_functions::localtests ( logical, intent(in)  verbose, character(len=*), intent(in)  str1, character(len=*), intent(in)  str2  )

private

True if str1 does not match str2. False otherwise.

Parameters

[in]	verbose	If true, write results to stdout
[in]	str1	String
[in]	str2	String

Definition at line 379 of file MOM_string_functions.F90.

Referenced by string_functions_unit_tests().

  logical, intent(in) :: verbose !< If true, write results to stdout
  character(len=*), intent(in) :: str1 !< String
  character(len=*), intent(in) :: str2 !< String
  localtests=.false.
  if (trim(str1)/=trim(str2)) localtests=.true.
  if (localtests .or. verbose) then
    write(*,*) '>'//trim(str1)//'<'
    if (localtests) write(*,*) trim(str1),':',trim(str2), '<-- FAIL'
  endif

Here is the caller graph for this function:

lowercase()

character(len=len(input_string)) function, public mom_string_functions::lowercase

(

character(len=*), intent(in)

input_string

)

Definition at line 48 of file MOM_string_functions.F90.

Referenced by mom_diag_remap::diag_remap_configure_axes(), mom_state_initialization::mom_initialize_state(), mom_io::num_timelevels(), and mom_restart::restore_state().

!   This function returns a string in which all uppercase letters have been
! replaced by their lowercase counterparts.  It is loosely based on the
! lowercase function in mpp_util.F90.
  ! Arguments
  character(len=*),     intent(in) :: input_string
  character(len=len(input_string)) :: lowercase
  ! Local variables
  integer, parameter :: co=iachar('a')-iachar('A') ! case offset
  integer :: k

  lowercase = input_string
  do k=1, len_trim(input_string)
    if (lowercase(k:k) >= 'A' .and. lowercase(k:k) <= 'Z') &
        lowercase(k:k) = achar(ichar(lowercase(k:k))+co)
  end do

Here is the caller graph for this function:

remove_spaces()

character(len=120) function, public mom_string_functions::remove_spaces

(

character(len=*), intent(in)

string

)

Returns string with all spaces removed.

Parameters

[in]

string

String to scan

Definition at line 313 of file MOM_string_functions.F90.

Referenced by mom_open_boundary::open_boundary_config(), and string_functions_unit_tests().

  character(len=*),   intent(in) :: string     !< String to scan
  ! Local variables
  integer :: ns, i, o
  logical :: lastcharisseperator
  lastcharisseperator = .true.
  ns = len_trim(string)
  i = 0; o = 0
  do while (i<ns)
    i = i+1
    if (string(i:i) /= ' ') then ! Copy character to output string
      o = o + 1
      remove_spaces(o:o) = string(i:i)
    endif
  enddo
  do i = o+1, 120
    remove_spaces(i:i) = ' ' ! Wipe any non-empty characters
  enddo
  remove_spaces = trim(remove_spaces)

Here is the caller graph for this function:

slasher()

character(len=len(dir)+2) function, public mom_string_functions::slasher

(

character(len=*), intent(in)

dir

)

Returns a directory name that is terminated with a "/" or "./" if the argument is an empty string.

Parameters

[in]

dir

A directory to be terminated with a "/" or changed to "./" if it is blank.

Definition at line 419 of file MOM_string_functions.F90.

Referenced by mom_domains::mom_domains_init().

  character(len=*), intent(in) :: dir !< A directory to be terminated with a "/"
                                      !! or changed to "./" if it is blank.
  character(len=len(dir)+2) :: slasher

  if (len_trim(dir) == 0) then
    slasher = "./"
  elseif (dir(len_trim(dir):len_trim(dir)) == '/') then
    slasher = trim(dir)
  else
    slasher = trim(dir)//"/"
  endif

Here is the caller graph for this function:

string_functions_unit_tests()

logical function, public mom_string_functions::string_functions_unit_tests

(

logical, intent(in)

verbose

)

Returns true if a unit test of string_functions fails.

Parameters

[in]

verbose

If true, write results to stdout

Definition at line 335 of file MOM_string_functions.F90.

References extract_integer(), extract_real(), extract_word(), extractword(), left_int(), left_ints(), left_real(), left_reals(), localtesti(), localtestr(), localtests(), and remove_spaces().

Referenced by mom_unit_tests::unit_tests().

  ! Arguments
  logical, intent(in) :: verbose !< If true, write results to stdout
  ! Local variables
  integer :: i(5) = (/ -1, 1, 3, 3, 0 /)
  real :: r(8) = (/ 0., 1., -2., 1.3, 3.e-11, 3.e-11, 3.e-11, -5.1e12 /)
  logical :: fail, v
  fail = .false.
  v = verbose
  write(*,*) '==== MOM_string_functions: string_functions_unit_tests ==='
  fail = fail .or. localtests(v,left_int(-1),'-1')
  fail = fail .or. localtests(v,left_ints(i(:)),'-1, 1, 3, 3, 0')
  fail = fail .or. localtests(v,left_real(0.),'0.0')
  fail = fail .or. localtests(v,left_reals(r(:)),'0.0, 1.0, -2.0, 1.3, 3*3.0E-11, -5.1E+12')
  fail = fail .or. localtests(v,left_reals(r(:),sep=' '),'0.0 1.0 -2.0 1.3 3*3.0E-11 -5.1E+12')
  fail = fail .or. localtests(v,left_reals(r(:),sep=','),'0.0,1.0,-2.0,1.3,3*3.0E-11,-5.1E+12')
  fail = fail .or. localtests(v,extractword("One Two,Three",1),"One")
  fail = fail .or. localtests(v,extractword("One Two,Three",2),"Two")
  fail = fail .or. localtests(v,extractword("One Two,Three",3),"Three")
  fail = fail .or. localtests(v,extractword("One Two,  Three",3),"Three")
  fail = fail .or. localtests(v,extractword(" One Two,Three",1),"One")
  fail = fail .or. localtests(v,extract_word("One,Two,Three",",",3),"Three")
  fail = fail .or. localtests(v,extract_word("One,Two,Three",",",4),"")
  fail = fail .or. localtests(v,remove_spaces("1 2 3"),"123")
  fail = fail .or. localtests(v,remove_spaces(" 1 2 3"),"123")
  fail = fail .or. localtests(v,remove_spaces("1 2 3 "),"123")
  fail = fail .or. localtests(v,remove_spaces("123"),"123")
  fail = fail .or. localtests(v,remove_spaces(" "),"")
  fail = fail .or. localtests(v,remove_spaces(""),"")
  fail = fail .or. localtesti(v,extract_integer("1","",1),1)
  fail = fail .or. localtesti(v,extract_integer("1,2,3",",",1),1)
  fail = fail .or. localtesti(v,extract_integer("1,2",",",2),2)
  fail = fail .or. localtesti(v,extract_integer("1,2",",",3),0)
  fail = fail .or. localtesti(v,extract_integer("1,2",",",4,4),4)
  fail = fail .or. localtestr(v,extract_real("1.","",1),1.)
  fail = fail .or. localtestr(v,extract_real("1.,2.,3.",",",1),1.)
  fail = fail .or. localtestr(v,extract_real("1.,2.",",",2),2.)
  fail = fail .or. localtestr(v,extract_real("1.,2.",",",3),0.)
  fail = fail .or. localtestr(v,extract_real("1.,2.",",",4,4.),4.)
  if (.not. fail) write(*,*) 'Pass'
  string_functions_unit_tests = fail

Here is the call graph for this function:

Here is the caller graph for this function:

uppercase()

character(len=len(input_string)) function, public mom_string_functions::uppercase

(

character(len=*), intent(in)

input_string

)

Definition at line 66 of file MOM_string_functions.F90.

Referenced by mom_continuity::continuity_init(), regrid_consts::coordinatemode(), mom_coriolisadv::coriolisadv_init(), mom_eos::eos_init(), regrid_interp::interpolation_scheme(), mom_main(), ocean_model_mod::ocean_model_init(), mom_shared_initialization::read_face_length_list(), mom_shared_initialization::reset_face_lengths_list(), mom_remapping::setreconstructiontype(), and mom_surface_forcing::wind_forcing_from_file().

  character(len=*),     intent(in) :: input_string
  character(len=len(input_string)) :: uppercase
!   This function returns a string in which all lowercase letters have been
! replaced by their uppercase counterparts.  It is loosely based on the
! uppercase function in mpp_util.F90.
  ! Arguments
  integer, parameter :: co=iachar('A')-iachar('a') ! case offset
  integer :: k

  uppercase = input_string
  do k=1, len_trim(input_string)
    if (uppercase(k:k) >= 'a' .and. uppercase(k:k) <= 'z') &
        uppercase(k:k) = achar(ichar(uppercase(k:k))+co)
  end do

Here is the caller graph for this function: