mod_sng::ftn_arg_get Interface Reference

Public Member Functions
subroutine	ftn_arg_get_dbl (arg_idx, arg_val, opt_val, opt_flg)
subroutine	ftn_arg_get_int (arg_idx, arg_val, opt_val, opt_flg)
subroutine	ftn_arg_get_lgc (arg_idx, arg_val, opt_val, opt_flg)
subroutine	ftn_arg_get_sng (arg_idx, arg_val, opt_val, opt_flg)
subroutine	ftn_arg_get_flt (arg_idx, arg_val, opt_val, opt_flg)

Detailed Description

Definition at line 88 of file mod_sng.f90.

Member Function/Subroutine Documentation

ftn_arg_get_dbl()

subroutine mod_sng::ftn_arg_get::ftn_arg_get_dbl	(	integer, intent(inout)	arg_idx,
		character(len=*), intent(inout)	arg_val,
		real(selected_real_kind(p=12)), intent(out)	opt_val,
		logical, intent(out), optional	opt_flg
	)

Definition at line 247 of file mod_sng.f90.

    ! Purpose: Copy command-line double argument arg_val into variable opt_val
    ! Usage:
    ! call ftn_arg_get_dbl(arg_idx,arg_val,opt_val) ! [sbr] Process double-valued command-line argument
    use mod_utils ! [mdl] Debugging constants, prg_nm, dbg_lvl
    implicit none
    ! Parameters
    character(len=*),parameter::sbr_nm='ftn_arg_get_dbl' ! [sng] Subroutine name
    ! Commons
    ! Input
    ! Input/Output
    integer,intent(inout)::arg_idx ! I/O [idx] Argument counter 
    character(len=*),intent(inout)::arg_val ! I/O [sng] Double to copy into opt_val
    ! Output
    real(selected_real_kind(p=12)),intent(out)::opt_val ! O [frc] Variable to receive copy of arg_val
    logical,optional,intent(out)::opt_flg ! O [flg] Variable set by command-line
    ! Local
    integer arg_lng           ! [nbr] Length of argument
    integer opt_lng           ! [nbr] Length of option
    integer arg_val_srt_idx   ! [idx] Starting position of argument value
    logical opt_cnj_is_spc ! [flg] Option conjunction is space character
    ! Main Code
    ! Print any diagnostics before current value of arg_val is overwritten
    arg_lng=len_trim(arg_val) ! [nbr] Length of argument
    opt_lng=ftn_opt_lng_get(arg_val) ! [nbr] Length of option
    if (dbg_lvl >= dbg_io) then
       write (6,'(2a,i2,3a,i2)') prg_nm(1:ftn_strlsc(prg_nm)), &
            ': DEBUG '//sbr_nm//'() reports arg_idx = ',arg_idx,  &
            ', Full option = ''',arg_val(1:arg_lng),''', Length = ',arg_lng
    endif                     ! endif dbg
    ! Determine whether format is --opt_sng=val or --opt_sng val
    ! Add two to cover preliminary dashes
    if (opt_lng+2 < arg_lng) then
       opt_cnj_is_spc=.false. ! [flg] Option conjunction is space character
       arg_val_srt_idx=3+opt_lng+1 ! [idx] Starting position of argument value
       if (dbg_lvl >= dbg_io) then
          write (6,'(8a)') prg_nm(1:ftn_strlsc(prg_nm)), &
               ': DEBUG '//sbr_nm//'() diassembles argument into Option = ''', &
               arg_val(3:2+opt_lng),''', conjunction is ''', &
               arg_val(3+opt_lng:3+opt_lng),''', argument = ''', &
               arg_val(arg_val_srt_idx:arg_lng),'''' ! Quote syntax is mystical
       endif                  ! endif dbg
    else
       opt_cnj_is_spc=.true.  ! [flg] Option conjunction is space character
       arg_val_srt_idx=1      ! [idx] Starting position of argument value
    endif                     ! endif
    if (opt_cnj_is_spc) then 
       ! Obtain value of option by getting next command-line argument
       ! New arguments will alter input values of arg_idx,arg_val
       call get_command_argument(arg_idx,arg_val)
       ! Increment counter for next read
       arg_idx=arg_idx+1
       ! Sanity checks
       arg_lng=len_trim(arg_val) ! [nbr] Length of argument
       if (arg_lng <= 0) stop 'ftn_???_arg_get() reports option lacks argument'
    endif                     ! endif opt_cnj_is_spc
    ! Read argument into double and return
    read (arg_val(arg_val_srt_idx:arg_lng),*) opt_val ! [frc] Variable to receive copy of arg_val
    if (dbg_lvl >= dbg_io) then
       write (6,'(2a,g13.6)') prg_nm(1:ftn_strlsc(prg_nm)), &
            ': DEBUG '//sbr_nm//'() assigned argument value = ',opt_val
    endif                     ! endif
    if(present(opt_flg)) opt_flg=.true. ! [flg] Variable set by command-line
    return

Here is the call graph for this function:

ftn_arg_get_flt()

subroutine mod_sng::ftn_arg_get::ftn_arg_get_flt	(	integer, intent(inout)	arg_idx,
		character(len=*), intent(inout)	arg_val,
		real(selected_real_kind(p=6)), intent(out)	opt_val,
		logical, intent(out), optional	opt_flg
	)

Definition at line 317 of file mod_sng.f90.

    ! Purpose: Copy command-line float argument arg_val into variable opt_val
    ! Usage:
    ! call ftn_arg_get_flt(arg_idx,arg_val,opt_val) ! [sbr] Process float-valued command-line argument
    use mod_utils ! [mdl] Debugging constants, prg_nm, dbg_lvl
    implicit none
    ! Parameters
    character(len=*),parameter::sbr_nm='ftn_arg_get_flt' ! [sng] Subroutine name
    ! Commons
    ! Input
    ! Input/Output
    integer,intent(inout)::arg_idx ! I/O [idx] Argument counter 
    character(len=*),intent(inout)::arg_val ! I/O [sng] Float to copy into opt_val
    ! Output
    real(selected_real_kind(p=6)),intent(out)::opt_val ! O [frc] Variable to receive copy of arg_val
    logical,optional,intent(out)::opt_flg ! O [flg] Variable set by command-line
    ! Local
    integer arg_lng           ! [nbr] Length of argument
    integer opt_lng           ! [nbr] Length of option
    integer arg_val_srt_idx   ! [idx] Starting position of argument value
    logical opt_cnj_is_spc ! [flg] Option conjunction is space character
    ! Main Code
    ! Print any diagnostics before current value of arg_val is overwritten
    arg_lng=len_trim(arg_val) ! [nbr] Length of argument
    opt_lng=ftn_opt_lng_get(arg_val) ! [nbr] Length of option
    if (dbg_lvl >= dbg_io) then
       write (6,'(2a,i2,3a,i2)') prg_nm(1:ftn_strlsc(prg_nm)), &
            ': DEBUG '//sbr_nm//'() reports arg_idx = ',arg_idx,  &
            ', Full option = ''',arg_val(1:arg_lng),''', Length = ',arg_lng
    endif                     ! endif dbg
    ! Determine whether format is --opt_sng=val or --opt_sng val
    ! Add two to cover preliminary dashes
    if (opt_lng+2 < arg_lng) then
       opt_cnj_is_spc=.false. ! [flg] Option conjunction is space character
       arg_val_srt_idx=3+opt_lng+1 ! [idx] Starting position of argument value
       if (dbg_lvl >= dbg_io) then
          write (6,'(8a)') prg_nm(1:ftn_strlsc(prg_nm)), &
               ': DEBUG '//sbr_nm//'() diassembles argument into Option = ''', &
               arg_val(3:2+opt_lng),''', conjunction is ''', &
               arg_val(3+opt_lng:3+opt_lng),''', argument = ''', &
               arg_val(arg_val_srt_idx:arg_lng),'''' ! Quote syntax is mystical
       endif                  ! endif dbg
    else
       opt_cnj_is_spc=.true.  ! [flg] Option conjunction is space character
       arg_val_srt_idx=1      ! [idx] Starting position of argument value
    endif                     ! endif
    if (opt_cnj_is_spc) then 
       ! Obtain value of option by getting next command-line argument
       ! New arguments will alter input values of arg_idx,arg_val
       call get_command_argument(arg_idx,arg_val)
       ! Increment counter for next read
       arg_idx=arg_idx+1
       ! Sanity checks
       arg_lng=len_trim(arg_val) ! [nbr] Length of argument
       if (arg_lng <= 0) stop 'ftn_???_arg_get() reports option lacks argument'
    endif                     ! endif opt_cnj_is_spc
    ! Read argument into float and return
    read (arg_val(arg_val_srt_idx:arg_lng),*) opt_val ! [frc] Variable to receive copy of arg_val
    if (dbg_lvl >= dbg_io) then
       write (6,'(2a,g13.6)') prg_nm(1:ftn_strlsc(prg_nm)), &
            ': DEBUG '//sbr_nm//'() assigned argument value = ',opt_val
    endif                     ! endif
    if(present(opt_flg)) opt_flg=.true. ! [flg] Variable set by command-line
    return

Here is the call graph for this function:

ftn_arg_get_int()

subroutine mod_sng::ftn_arg_get::ftn_arg_get_int	(	integer, intent(inout)	arg_idx,
		character(len=*), intent(inout)	arg_val,
		integer, intent(inout)	opt_val,
		logical, intent(out), optional	opt_flg
	)

Definition at line 387 of file mod_sng.f90.

    ! Purpose: Copy command-line integer argument arg_val into variable opt_val
    ! Usage:
    ! call ftn_arg_get_int(arg_idx,arg_val,opt_val) ! [sbr] Process integer-valued command-line argument
    use mod_utils ! [mdl] Debugging constants, prg_nm, dbg_lvl
    implicit none
    ! Parameters
    character(len=*),parameter::sbr_nm='ftn_arg_get_int' ! [sng] Subroutine name
    ! Commons
    ! Input
    ! Input/Output
    integer,intent(inout)::arg_idx ! I/O [idx] Argument counter 
    character(len=*),intent(inout)::arg_val ! I/O [sng] Integer to copy into opt_val
    ! 20030429: Change opt_val to inout since dbg_lvl itself may be an opt_val but is referenced on LHS
    integer,intent(inout)::opt_val ! O [nbr] Variable to receive copy of arg_val
    logical,optional,intent(out)::opt_flg ! O [flg] Variable set by command-line
    ! Output
    ! Local
    integer arg_lng           ! [nbr] Length of argument
    integer opt_lng           ! [nbr] Length of option
    integer arg_val_srt_idx   ! [idx] Starting position of argument value
    logical opt_cnj_is_spc ! [flg] Option conjunction is space character
    ! Main Code
    ! Print any diagnostics before current value of arg_val is overwritten
    arg_lng=len_trim(arg_val) ! [nbr] Length of argument
    opt_lng=ftn_opt_lng_get(arg_val) ! [nbr] Length of option
    if (dbg_lvl >= dbg_io) then
       write (6,'(2a,i2,3a,i2)') prg_nm(1:ftn_strlsc(prg_nm)), &
            ': DEBUG '//sbr_nm//'() reports arg_idx = ',arg_idx,  &
            ', Full option = ''',arg_val(1:arg_lng),''', Length = ',arg_lng
    endif                     ! endif dbg
    ! Determine whether format is --opt_sng=val or --opt_sng val
    ! Add two to cover preliminary dashes
    if (opt_lng+2 < arg_lng) then
       opt_cnj_is_spc=.false. ! [flg] Option conjunction is space character
       arg_val_srt_idx=3+opt_lng+1 ! [idx] Starting position of argument value
       if (dbg_lvl >= dbg_io) then
          write (6,'(8a)') prg_nm(1:ftn_strlsc(prg_nm)), &
               ': DEBUG '//sbr_nm//'() diassembles argument into Option = ''', &
               arg_val(3:2+opt_lng),''', conjunction is ''', &
               arg_val(3+opt_lng:3+opt_lng),''', argument = ''', &
               arg_val(arg_val_srt_idx:arg_lng),'''' ! Quote syntax is mystical
       endif                  ! endif dbg
    else
       opt_cnj_is_spc=.true.  ! [flg] Option conjunction is space character
       arg_val_srt_idx=1      ! [idx] Starting position of argument value
    endif                     ! endif
    if (opt_cnj_is_spc) then 
       ! Obtain value of option by getting next command-line argument
       ! New arguments will alter input values of arg_idx,arg_val
       call get_command_argument(arg_idx,arg_val)
       ! Increment counter for next read
       arg_idx=arg_idx+1
       ! Sanity checks
       arg_lng=len_trim(arg_val) ! [nbr] Length of argument
       if (arg_lng <= 0) stop 'ftn_arg_get_int() reports option lacks argument'
    endif                     ! endif opt_cnj_is_spc
    ! Read argument into integer and return
    read (arg_val(arg_val_srt_idx:arg_lng),*) opt_val ! [nbr] Variable to receive copy of arg_val
    if (dbg_lvl >= dbg_io) then
       write (6,'(2a,g13.6)') prg_nm(1:ftn_strlsc(prg_nm)), &
            ': DEBUG '//sbr_nm//'() assigned argument value = ',opt_val
    endif                     ! endif
    if(present(opt_flg)) opt_flg=.true. ! [flg] Variable set by command-line
    return

Here is the call graph for this function:

ftn_arg_get_lgc()

subroutine mod_sng::ftn_arg_get::ftn_arg_get_lgc	(	integer, intent(inout)	arg_idx,
		character(len=*), intent(inout)	arg_val,
		logical, intent(out)	opt_val,
		logical, intent(out), optional	opt_flg
	)

Definition at line 458 of file mod_sng.f90.

    ! Purpose: Copy command-line logical argument arg_val into variable opt_val
    ! Usage:
    ! call ftn_arg_get_lgc(arg_idx,arg_val,opt_val) ! [sbr] Process logical-valued command-line argument
    use mod_utils ! [mdl] Debugging constants, prg_nm, dbg_lvl
    implicit none
    ! Parameters
    character(len=*),parameter::sbr_nm='ftn_arg_get_lgc' ! [sng] Subroutine name
    ! Commons
    ! Input
    ! Input/Output
    integer,intent(inout)::arg_idx ! I/O [idx] Argument counter 
    character(len=*),intent(inout)::arg_val ! I/O [sng] Logical to copy into opt_val
    ! Output
    logical,intent(out)::opt_val ! O [flg] Variable to receive copy of arg_val
    logical,optional,intent(out)::opt_flg ! O [flg] Variable set by command-line
    ! Local
    integer arg_lng           ! [nbr] Length of argument
    integer opt_lng           ! [nbr] Length of option
    integer arg_val_srt_idx   ! [idx] Starting position of argument value
    logical opt_cnj_is_spc ! [flg] Option conjunction is space character
    ! Main Code
    ! Print any diagnostics before current value of arg_val is overwritten
    arg_lng=len_trim(arg_val) ! [nbr] Length of argument
    opt_lng=ftn_opt_lng_get(arg_val) ! [nbr] Length of option
    if (dbg_lvl >= dbg_io) then
       write (6,'(2a,i2,3a,i2)') prg_nm(1:ftn_strlsc(prg_nm)), &
            ': DEBUG '//sbr_nm//'() reports arg_idx = ',arg_idx,  &
            ', Full option = ''',arg_val(1:arg_lng),''', Length = ',arg_lng
    endif                     ! endif dbg
    ! Determine whether format is --opt_sng=val or --opt_sng val
    ! Add two to cover preliminary dashes
    if (opt_lng+2 < arg_lng) then
       opt_cnj_is_spc=.false. ! [flg] Option conjunction is space character
       arg_val_srt_idx=3+opt_lng+1 ! [idx] Starting position of argument value
       if (dbg_lvl >= dbg_io) then
          write (6,'(8a)') prg_nm(1:ftn_strlsc(prg_nm)), &
               ': DEBUG '//sbr_nm//'() diassembles argument into Option = ''', &
               arg_val(3:2+opt_lng),''', conjunction is ''', &
               arg_val(3+opt_lng:3+opt_lng),''', argument = ''', &
               arg_val(arg_val_srt_idx:arg_lng),'''' ! Quote syntax is mystical
       endif                  ! endif dbg
    else
       opt_cnj_is_spc=.true.  ! [flg] Option conjunction is space character
       arg_val_srt_idx=1      ! [idx] Starting position of argument value
    endif                     ! endif
    if (opt_cnj_is_spc) then 
       ! Obtain value of option by getting next command-line argument
       ! New arguments will alter input values of arg_idx,arg_val
       call get_command_argument(arg_idx,arg_val)
       ! Increment counter for next read
       arg_idx=arg_idx+1
       ! Sanity checks
       arg_lng=len_trim(arg_val) ! [nbr] Length of argument
       if (arg_lng <= 0) stop 'ftn_arg_get_lgc() reports option lacks argument'
    endif                     ! endif opt_cnj_is_spc
    ! Read argument into integer and return
    read (arg_val(arg_val_srt_idx:arg_lng),*) opt_val ! [flg] Variable to receive copy of arg_val
    if (dbg_lvl >= dbg_io) then
       write (6,'(2a,g13.6)') prg_nm(1:ftn_strlsc(prg_nm)), &
            ': DEBUG '//sbr_nm//'() assigned argument value = ',opt_val
    endif                     ! endif
    if(present(opt_flg)) opt_flg=.true. ! [flg] Variable set by command-line
    return

Here is the call graph for this function:

ftn_arg_get_sng()

subroutine mod_sng::ftn_arg_get::ftn_arg_get_sng	(	integer, intent(inout)	arg_idx,
		character(len=*), intent(inout)	arg_val,
		character(len=*), intent(out)	opt_val,
		logical, intent(out), optional	opt_flg
	)

Definition at line 528 of file mod_sng.f90.

    ! Purpose: Copy command-line string argument arg_val into variable opt_val
    ! opt_val is unchanged if arg_val cannot be copied
    ! Remainder of opt_val is NUL-initialized
    ! Usage:
    ! call ftn_arg_get_sng(arg_idx,arg_val,opt_val) ! [sbr] Process string-valued command-line argument
    use mod_utils ! [mdl] Debugging constants, prg_nm, dbg_lvl
    implicit none
    ! Parameters
    character(len=*),parameter::sbr_nm='ftn_arg_get_sng' ! [sng] Subroutine name
    ! Commons
    ! Input
    ! Input/Output
    integer,intent(inout)::arg_idx ! I/O [idx] Argument counter 
    character(len=*),intent(inout)::arg_val ! I/O [sng] String to copy into opt_val
    ! Output
    character(len=*),intent(out)::opt_val ! O [sng] Variable to receive copy of arg_val
    logical,optional,intent(out)::opt_flg ! O [flg] Variable set by command-line
    ! Local
    integer idx
    integer len_var           ! [nbr] Length of string variable
    integer arg_lng           ! [nbr] Length of argument
    integer opt_lng           ! [nbr] Length of option
    integer arg_val_srt_idx   ! [idx] Starting position of argument value
    logical opt_cnj_is_spc ! [flg] Option conjunction is space character
    integer nll_srt_idx ! [idx] First NUL position in opt_val
    ! Main Code
    ! Print any diagnostics before current value of arg_val is overwritten
    len_var=len(opt_val)      ! [nbr] Length of string variable
    arg_lng=len_trim(arg_val) ! [nbr] Length of argument
    opt_lng=ftn_opt_lng_get(arg_val) ! [nbr] Length of option
    if (dbg_lvl >= dbg_io) then
       write (6,'(2a,i2,3a,i2)') prg_nm(1:ftn_strlsc(prg_nm)), &
            ': DEBUG '//sbr_nm//'() reports arg_idx = ',arg_idx,  &
            ', Option = ''',arg_val(1:arg_lng),''', Length = ',arg_lng
    endif                     ! endif
    ! Determine whether format is --opt_sng=val or --opt_sng val
    ! Add two to cover preliminary dashes
    if (opt_lng+2 < arg_lng) then
       opt_cnj_is_spc=.false. ! [flg] Option conjunction is space character
       arg_val_srt_idx=3+opt_lng+1 ! [idx] Starting position of argument value
       if (dbg_lvl >= dbg_io) then
          write (6,'(8a)') prg_nm(1:ftn_strlsc(prg_nm)), &
               ': DEBUG '//sbr_nm//'() diassembles argument into Option = ''', &
               arg_val(3:2+opt_lng),''', conjunction is ''', &
               arg_val(3+opt_lng:3+opt_lng),''', argument = ''', &
               arg_val(arg_val_srt_idx:arg_lng),'''' ! Quote syntax is mystical
       endif                  ! endif dbg
    else
       opt_cnj_is_spc=.true.  ! [flg] Option conjunction is space character
       arg_val_srt_idx=1      ! [idx] Starting position of argument value
    endif                     ! endif
    if (opt_cnj_is_spc) then 
       ! Obtain value of option by getting next command-line argument
       ! New arguments will alter input values of arg_idx,arg_val
       call get_command_argument(arg_idx,arg_val)
       ! Increment counter for next read
       arg_idx=arg_idx+1
       ! Sanity checks
       arg_lng=len_trim(arg_val) ! [nbr] Length of argument
       if (arg_lng <= 0) stop 'ftn_???_arg_get() reports option lacks argument'
       if (arg_lng > len_var) then
          write (6,'(2a,i5,a,i5)') prg_nm(1:ftn_strlsc(prg_nm)), &
               ': ERROR '//sbr_nm//'() reports argument length = ',arg_lng, &
               ' too long to fit into variable length ',len_var
          stop
       endif ! endif arg_lng > len_var
    endif                     ! endif opt_cnj_is_spc
    ! Read argument into string and return
    read (arg_val(arg_val_srt_idx:arg_lng),'(a)') opt_val ! [sng] Variable to receive copy of arg_val
    ! NUL-initialize remainder of opt_val
    nll_srt_idx=arg_lng-arg_val_srt_idx+2 ! [idx] First NUL position in opt_val
    do idx=nll_srt_idx,len_var
       opt_val(idx:idx)=char(0) ! [sng] Variable to receive copy of arg_val
    end do                    ! end loop over characters
    if (dbg_lvl >= dbg_io) then
       write (6,'(4a)') prg_nm(1:ftn_strlsc(prg_nm)), &
            ': DEBUG '//sbr_nm//'() assigned argument value = ',opt_val(1:len_trim(opt_val)),'<--End of opt_val string'
       call ftn_strprn(opt_val)   ! [fnc] Print character values of string
    endif ! endif
    if(present(opt_flg)) opt_flg=.true. ! [flg] Variable set by command-line
    return

Here is the call graph for this function:

---

The documentation for this interface was generated from the following file:

• FVCOMg01/mod_sng.f90