inp_decode_mod::load_i Interface Reference

Public Member Functions
integer function	load_0d_i (ninp, vinp, nout, vout)
integer function	load_1d_i (ninp, vinp, nout, vout)
integer function	load_2d_i (ninp, vinp, iout, jout, vout)
integer function	load_3d_i (ninp, vinp, iout, jout, kout, vout)

Detailed Description

Definition at line 57 of file inp_decode.F.

Member Function/Subroutine Documentation

load_0d_i()

integer function inp_decode_mod::load_i::load_0d_i	(	integer, intent(in)	ninp,
		real(dp), dimension(:), intent(in)	vinp,
		integer, intent(in)	nout,
		integer, intent(out)	vout )

Definition at line 476 of file inp_decode.F.

!
!***********************************************************************
!                                                                      !
!  It loads input values into a requested model scalar integer         !
!  variable.                                                           !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     Ninp       Number of input elements to process in Vinp (integer) !
!     Vinp       Input values (1D real(dp) array)                      !
!     Nout       Size of output integer variable dimension (not used)  !
!                                                                      !
!  On Output:                                                          !
!                                                                      !
!     Vout       Output scalar integer variable                        !
!     Nval       Number of output values processed                     !
!                                                                      !
!***********************************************************************
!
!  Imported variable declarations.
!
      integer,  intent(in) :: Ninp, Nout
      real(dp), intent(in) :: Vinp(:)
!
      integer, intent(out) :: Vout
!
!  Local variable declarations.
!
      integer :: ic
      integer :: Nval
!
!-----------------------------------------------------------------------
!  Load scalar integer variable with input value.
!-----------------------------------------------------------------------
!
      ic=1
      vout=int(vinp(ic))
      nval=ic
 
      RETURN

load_1d_i()

integer function inp_decode_mod::load_i::load_1d_i	(	integer, intent(in)	ninp,
		real(dp), dimension(:), intent(in)	vinp,
		integer, intent(in)	nout,
		integer, dimension(:), intent(out)	vout )

Definition at line 519 of file inp_decode.F.

!
!***********************************************************************
!                                                                      !
!  It loads input values into a requested model 1D integer array.      !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     Ninp       Number of input elements to process in Vinp (integer) !
!     Vinp       Input values (1D real(dp) array)                      !
!     Nout       Size of output integer variable dimension             !
!                                                                      !
!  On Output:                                                          !
!                                                                      !
!     Vout       Output 1D integer variable                            !
!     Nval       Number of output values processed                     !
!                                                                      !
!***********************************************************************
!
!  Imported variable declarations.
!
      integer,  intent(in) :: Ninp, Nout
      real(dp), intent(in) :: Vinp(:)
!
      integer, intent(out) :: Vout(:)
!
!  Local variable declarations.
!
      integer :: Nstr, i, ic
      integer :: Nval
!
!-----------------------------------------------------------------------
!  Load 1D integer variable with input values.
!-----------------------------------------------------------------------
!
!  If not all values are provided for variable, assume the last value
!  for the rest of the array.
!
      ic=0
      IF (ninp.le.nout) THEN
        DO i=1,ninp
          ic=ic+1
          vout(i)=int(vinp(i))
        END DO
        IF (nout.gt.ninp) THEN
          nstr=ninp+1
          DO i=nstr,nout
            ic=ic+1
            vout(i)=int(vinp(ninp))
          END DO
        END IF
      ELSE
        DO i=1,nout
          ic=ic+1
          vout(i)=int(vinp(i))
        END DO
      END IF
      nval=ic
 
      RETURN

References mod_param::nstr.

load_2d_i()

integer function inp_decode_mod::load_i::load_2d_i	(	integer, intent(in)	ninp,
		real(dp), dimension(:), intent(in)	vinp,
		integer, intent(in)	iout,
		integer, intent(in)	jout,
		integer, dimension(:,:), intent(out)	vout )

Definition at line 581 of file inp_decode.F.

!
!***********************************************************************
!                                                                      !
!  It loads input values into a requested model 2D integer array.      !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     Ninp       Number of input elements to process in Vinp (integer) !
!     Vinp       Input values (1D real(dp) array)                      !
!     Iout       Size of output integer variable first  I-dimension    !
!     Jout       Size of output integer variable second J-dimension    !
!                                                                      !
!  On Output:                                                          !
!                                                                      !
!     Vout       Output 2D integer variable                            !
!     Nval       Number of output values processed                     !
!                                                                      !
!***********************************************************************
!
!  Imported variable declarations.
!
      integer,  intent(in) :: Ninp, Iout, Jout
      real(dp), intent(in) :: Vinp(:)
!
      integer, intent(out) :: Vout(:,:)
!
!  Local variable declarations.
!
      integer :: Nstr, i, ic
      integer :: Nout, Nval
!
      integer, dimension(Iout*Jout) :: Vwrk
!
!-----------------------------------------------------------------------
!  Load 2D integer variable with input values.
!-----------------------------------------------------------------------
!
!  If not all values are provided for variable, assume the last value
!  for the rest of the 2D array.
!
      ic=0
      nout=iout*jout
      IF (ninp.le.nout) THEN
        DO i=1,ninp
          ic=ic+1
          vwrk(i)=int(vinp(i))
        END DO
        IF (nout.gt.ninp) THEN
          nstr=ninp+1
          DO i=nstr,nout
            ic=ic+1
            vwrk(i)=int(vinp(ninp))
          END DO
        END IF
      ELSE
        DO i=1,nout
          ic=ic+1
          vwrk(i)=int(vinp(i))
        END DO
      END IF
      vout=reshape(vwrk,(/iout,jout/))
      nval=ic
!
      RETURN

References mod_param::nstr.

load_3d_i()

integer function inp_decode_mod::load_i::load_3d_i	(	integer, intent(in)	ninp,
		real(dp), dimension(:), intent(in)	vinp,
		integer, intent(in)	iout,
		integer, intent(in)	jout,
		integer, intent(in)	kout,
		integer, dimension(:,:,:), intent(out)	vout )

Definition at line 648 of file inp_decode.F.

!
!***********************************************************************
!                                                                      !
!  It loads input values into a requested model 3D integer array.      !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     Ninp       Number of input elements to process in Vinp (integer) !
!     Vinp       Input values (1D real(dp) array)                      !
!     Iout       Size of output integer variable first  I-dimension    !
!     Jout       Size of output integer variable second J-dimension    !
!     Kout       Size of output integer variable third  K-dimension    !
!                                                                      !
!  On Output:                                                          !
!                                                                      !
!     Vout       Output 3D integer variable                            !
!     Nval       Number of output values processed                     !
!                                                                      !
!***********************************************************************
!
!  Imported variable declarations.
!
      integer,  intent(in) :: Ninp, Iout, Jout, Kout
      real(dp), intent(in) :: Vinp(:)
!
      integer, intent(out) :: Vout(:,:,:)
!
!  Local variable declarations.
!
      integer :: Nstr, i, ic
      integer :: Nout, Nval
!
      integer, dimension(Iout*Jout*Kout) :: Vwrk
!
!-----------------------------------------------------------------------
!  Load 3D integer variable with input values.
!-----------------------------------------------------------------------
!
!  If not all values are provided for variable, assume the last value
!  for the rest of the 3D array.
!
      ic=0
      nout=iout*jout*kout
      IF (ninp.le.nout) THEN
        DO i=1,ninp
          ic=ic+1
          vwrk(i)=int(vinp(i))
        END DO
        IF (nout.gt.ninp) THEN
          nstr=ninp+1
          DO i=nstr,nout
            ic=ic+1
            vwrk(i)=int(vinp(ninp))
          END DO
        END IF
      ELSE
        DO i=1,nout
          ic=ic+1
          vwrk(i)=int(vinp(i))
        END DO
      END IF
      vout=reshape(vwrk,(/iout,jout,kout/))
      nval=ic
!
      RETURN

References mod_param::nstr.

---

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

• ROMS/Utility/inp_decode.F