mod_pio_netcdf::pio_netcdf_put_lvar Interface Reference

Public Member Functions
subroutine	pio_netcdf_put_lvar_0d (ng, model, ncname, myvarname, a, start, total, piofile, piovar)
subroutine	pio_netcdf_put_lvar_1d (ng, model, ncname, myvarname, a, start, total, piofile, piovar)
subroutine	pio_netcdf_put_lvar_2d (ng, model, ncname, myvarname, a, start, total, piofile, piovar)

Detailed Description

Definition at line 114 of file mod_pio_netcdf.F.

Member Function/Subroutine Documentation

pio_netcdf_put_lvar_0d()

subroutine mod_pio_netcdf::pio_netcdf_put_lvar::pio_netcdf_put_lvar_0d	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		character (len=*), intent(in)	ncname,
		character (len=*), intent(in)	myvarname,
		logical, intent(in)	a,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	total,
		type (file_desc_t), intent(in), optional	piofile,
		type (var_desc_t), intent(in), optional	piovar )

Definition at line 7941 of file mod_pio_netcdf.F.

!
!=======================================================================
!                                                                      !
!  It writes a logical scalar variable into a NetCDF file. If the file !
!  descritor is not provided, it opens the file, writes data, and then !
!  closes the file.                                                    !
!                                                                      !
!  The input logical data is converted to integer such that .FALSE.    !
!  is interpreted as zero, and .TRUE. is interpreted as one.           !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     ng           Nested grid number (integer)                        !
!     model        Calling model identifier (integer)                  !
!     ncname       PIO filename (string)                               !
!     myVarName    Variable name (string)                              !
!     A            Data value(s) to be written (logical)               !
!     start        Starting index where the first of the data values   !
!                    will be written along each dimension (integer)    !
!     total        Number of data values to be written along each      !
!                    dimension (integer)                               !
!     pioFile      PIO file descriptor, TYPE(File_desc_t), OPTIONAL    !
!                    pioFile%fh         file handler                   !
!                    pioFile%iosystem   IO system descriptor (struct)  !
!     pioVar       PIO variable descriptor, TYPE(Var_desc_t), OPTIONAL !
!                    pioVar%varID       Variable ID                    !
!                    pioVar%ncid        File ID                        !
!                                                                      !
!  On Ouput:                                                           !
!                                                                      !
!     exit_flag    Error flag (integer) stored in MOD_SCALARS          !
!     ioerror      NetCDF return code (integer) stored in MOD_IOUNITS  !
!                                                                      !
!  Notice: This routine must be used to write only nontiled variables. !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, model
      integer, intent(in) :: start(:), total(:)
!
      logical, intent(in) :: A
!
      character (len=*), intent(in) :: ncname
      character (len=*), intent(in) :: myVarName
!
      TYPE (File_desc_t), intent(in), optional :: pioFile
      TYPE (Var_desc_t),  intent(in), optional :: pioVar
!
!  Local variable declarations.
!
      integer :: status
      integer :: AI
 
      integer, dimension(1) :: my_AI
!
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", pio_netcdf_put_lvar_0d"
!
      TYPE (File_desc_t) :: my_pioFile
      TYPE (Var_desc_t)  :: my_pioVar
!
!-----------------------------------------------------------------------
!  Read in a floating-point scalar variable.
!-----------------------------------------------------------------------
!
!  If file descriptor is not provided, open file for writing.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_open (ng, model, trim(ncname), 1, my_piofile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ELSE
        my_piofile=piofile
      END IF
!
!  If variable descriptor is not provided, inquire its value.
!
      IF (.not.PRESENT(piovar)) THEN
        status=pio_inq_varid(my_piofile, trim(myvarname), my_piovar)
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master)  WRITE (stdout,10) trim(myvarname), trim(ncname), &
     &                                   trim(sourcefile)
          exit_flag=3
          ioerror=status
        END IF
      ELSE
        my_piovar=piovar
      END IF
!
!  Convert logical data to integer: .FALSE. is interpreted as zero, and
!  .TRUE. is interpreted as one.
!
      IF (a) THEN
        ai=1
      ELSE
        ai=0
      END IF
!
!  Write out logical data as integers.
!
      IF (exit_flag.eq.noerror) THEN
        IF ((start(1).eq.0).and.(total(1).eq.0)) THEN
          status=pio_put_var(my_piofile, my_piovar, ai)
        ELSE
          my_ai(1)=ai
          status=pio_put_var(my_piofile, my_piovar, start, total, my_ai)
        END IF
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master) WRITE (stdout,20) trim(myvarname), trim(ncname),  &
     &                                  trim(sourcefile)
          exit_flag=3
          ioerror=status
        END IF
      END IF
!
!  Close file.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_close (ng, model, my_piofile, ncname, .false.)
      END IF
!
  10  FORMAT (/,' PIO_NETCDF_PUT_LVAR_0D - error while inquiring ',     &
     &        'descriptor for variable:',2x,a,/,26x,'in input file:',   &
     &        2x,a,/,26x,'call from:',2x,a)
  20  FORMAT (/,'PIO_NETCDF_PUT_LVAR_0D  - error while writing ',       &
     &        'variable:',2x,a,/,26x,'in input file:',2x,a,             &
     &        /,26x,'call from:',2x,a)
!
      RETURN

References mod_scalars::exit_flag, strings_mod::founderror(), mod_iounits::ioerror, mod_parallel::master, mod_scalars::noerror, mod_pio_netcdf::pio_netcdf_close(), mod_pio_netcdf::pio_netcdf_open(), mod_iounits::sourcefile, and mod_iounits::stdout.

Here is the call graph for this function:

pio_netcdf_put_lvar_1d()

subroutine mod_pio_netcdf::pio_netcdf_put_lvar::pio_netcdf_put_lvar_1d	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		character (len=*), intent(in)	ncname,
		character (len=*), intent(in)	myvarname,
		logical, dimension(:), intent(in)	a,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	total,
		type (file_desc_t), intent(in), optional	piofile,
		type (var_desc_t), intent(in), optional	piovar )

Definition at line 8076 of file mod_pio_netcdf.F.

!
!=======================================================================
!                                                                      !
!  It writes a logical 1D-array variable into a NetCDF file. If the    !
!  file descritor is not provided, it opens the file, writes data,     !
!  and then closes the file.                                           !
!                                                                      !
!  The input logical data is converted to integer such that .FALSE.    !
!  is interpreted as zero, and .TRUE. is interpreted as one.           !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     ng           Nested grid number (integer)                        !
!     model        Calling model identifier (integer)                  !
!     ncname       PIO filename (string)                               !
!     myVarName    Variable name (string)                              !
!     A            Data value(s) to be written (logical)               !
!     start        Starting index where the first of the data values   !
!                    will be written along each dimension (integer)    !
!     total        Number of data values to be written along each      !
!                    dimension (integer)                               !
!     pioFile      PIO file descriptor, TYPE(File_desc_t), OPTIONAL    !
!                    pioFile%fh         file handler                   !
!                    pioFile%iosystem   IO system descriptor (struct)  !
!     pioVar       PIO variable descriptor, TYPE(Var_desc_t), OPTIONAL !
!                    pioVar%varID       Variable ID                    !
!                    pioVar%ncid        File ID                        !
!                                                                      !
!  On Ouput:                                                           !
!                                                                      !
!     exit_flag    Error flag (integer) stored in MOD_SCALARS          !
!     ioerror      NetCDF return code (integer) stored in MOD_IOUNITS  !
!                                                                      !
!  Notice: This routine must be used to write only nontiled variables. !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, model
      integer, intent(in) :: start(:), total(:)
!
      logical, intent(in) :: A(:)
!
      character (len=*), intent(in) :: ncname
      character (len=*), intent(in) :: myVarName
!
      TYPE (File_desc_t), intent(in), optional :: pioFile
      TYPE (Var_desc_t),  intent(in), optional :: pioVar
!
!  Local variable declarations.
!
      integer :: i, status
 
      integer, dimension(SIZE(A,1)) :: AI
!
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", pio_netcdf_put_lvar_1d"
!
      TYPE (File_desc_t) :: my_pioFile
      TYPE (Var_desc_t)  :: my_pioVar
!
!-----------------------------------------------------------------------
!  Read in a floating-point scalar variable.
!-----------------------------------------------------------------------
!
!  If file descriptor is not provided, open file for writing.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_open (ng, model, trim(ncname), 1, my_piofile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ELSE
        my_piofile=piofile
      END IF
!
!  If variable descriptor is not provided, inquire its value.
!
      IF (.not.PRESENT(piovar)) THEN
        status=pio_inq_varid(my_piofile, trim(myvarname), my_piovar)
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master)  WRITE (stdout,10) trim(myvarname), trim(ncname), &
     &                                   trim(sourcefile)
          exit_flag=3
          ioerror=status
        END IF
      ELSE
        my_piovar=piovar
      END IF
!
!  Convert logical data to integer: .FALSE. is interpreted as zero, and
!  .TRUE. is interpreted as one.
!
      DO i=1,SIZE(a,1)
        IF (a(i)) THEN
          ai(i)=1
        ELSE
          ai(i)=0
        END IF
      END DO
!
!  Write out logical data as integers.
!
      IF (exit_flag.eq.noerror) THEN
        status=pio_put_var(my_piofile, my_piovar, start, total, ai)
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master) WRITE (stdout,20) trim(myvarname), trim(ncname),  &
     &                                  trim(sourcefile)
          exit_flag=3
          ioerror=status
        END IF
      END IF
!
!  Close file.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_close (ng, model, my_piofile, ncname, .false.)
      END IF
!
  10  FORMAT (/,' PIO_NETCDF_PUT_LVAR_1D - error while inquiring ',     &
     &        'descriptor for variable:',2x,a,/,26x,'in input file:',   &
     &        2x,a,/,26x,'call from:',2x,a)
  20  FORMAT (/,' PIO_NETCDF_PUT_LVAR_1D - error while writing ',       &
     &        'variable:',2x,a,/,26x,'in input file:',2x,a,             &
     &        /,26x,'call from:',2x,a)
!
      RETURN

References mod_scalars::exit_flag, strings_mod::founderror(), mod_iounits::ioerror, mod_parallel::master, mod_scalars::noerror, mod_pio_netcdf::pio_netcdf_close(), mod_pio_netcdf::pio_netcdf_open(), mod_iounits::sourcefile, and mod_iounits::stdout.

Here is the call graph for this function:

pio_netcdf_put_lvar_2d()

subroutine mod_pio_netcdf::pio_netcdf_put_lvar::pio_netcdf_put_lvar_2d	(	integer, intent(in)	ng,
		integer, intent(in)	model,
		character (len=*), intent(in)	ncname,
		character (len=*), intent(in)	myvarname,
		logical, dimension(:,:), intent(in)	a,
		integer, dimension(:), intent(in)	start,
		integer, dimension(:), intent(in)	total,
		type (file_desc_t), intent(in), optional	piofile,
		type (var_desc_t), intent(in), optional	piovar )

Definition at line 8207 of file mod_pio_netcdf.F.

!
!=======================================================================
!                                                                      !
!  It writes a logical 2D-array variable into a NetCDF file. If the    !
!  file descritor is not provided, it opens the file, writes data,     !
!  and then closes the file.                                           !
!                                                                      !
!  The input logical data is converted to integer such that .FALSE.    !
!  is interpreted as zero, and .TRUE. is interpreted as one.           !
!                                                                      !
!  On Input:                                                           !
!                                                                      !
!     ng           Nested grid number (integer)                        !
!     model        Calling model identifier (integer)                  !
!     ncname       PIO filename (string)                               !
!     myVarName    Variable name (string)                              !
!     A            Data value(s) to be written (logical)               !
!     start        Starting index where the first of the data values   !
!                    will be written along each dimension (integer)    !
!     total        Number of data values to be written along each      !
!                    dimension (integer)                               !
!     pioFile      PIO file descriptor, TYPE(File_desc_t), OPTIONAL    !
!                    pioFile%fh         file handler                   !
!                    pioFile%iosystem   IO system descriptor (struct)  !
!     pioVar       PIO variable descriptor, TYPE(Var_desc_t), OPTIONAL !
!                    pioVar%varID       Variable ID                    !
!                    pioVar%ncid        File ID                        !
!                                                                      !
!  On Ouput:                                                           !
!                                                                      !
!     exit_flag    Error flag (integer) stored in MOD_SCALARS          !
!     ioerror      NetCDF return code (integer) stored in MOD_IOUNITS  !
!                                                                      !
!  Notice: This routine must be used to write only nontiled variables. !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng, model
      integer, intent(in) :: start(:), total(:)
!
      logical, intent(in) :: A(:,:)
!
      character (len=*), intent(in) :: ncname
      character (len=*), intent(in) :: myVarName
!
      TYPE (File_desc_t), intent(in), optional :: pioFile
      TYPE (Var_desc_t),  intent(in), optional :: pioVar
!
!  Local variable declarations.
!
      integer :: i, j, status
 
      integer, dimension(SIZE(A,1),SIZE(A,2)) :: AI
!
      character (len=*), parameter :: MyFile =                          &
     &  __FILE__//", pio_netcdf_put_lvar_2d"
!
      TYPE (File_desc_t) :: my_pioFile
      TYPE (Var_desc_t)  :: my_pioVar
!
!-----------------------------------------------------------------------
!  Read in a floating-point scalar variable.
!-----------------------------------------------------------------------
!
!  If file descriptor is not provided, open file for writing.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_open (ng, model, trim(ncname), 1, my_piofile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ELSE
        my_piofile=piofile
      END IF
!
!  If variable descriptor is not provided, inquire its value.
!
      IF (.not.PRESENT(piovar)) THEN
        status=pio_inq_varid(my_piofile, trim(myvarname), my_piovar)
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master)  WRITE (stdout,10) trim(myvarname), trim(ncname), &
     &                                   trim(sourcefile)
          exit_flag=3
          ioerror=status
        END IF
      ELSE
        my_piovar=piovar
      END IF
!
!  Convert logical data to integer: .FALSE. is interpreted as zero, and
!  .TRUE. is interpreted as one.
!
      DO j=1,SIZE(a,2)
        DO i=1,SIZE(a,1)
          IF (a(i,j)) THEN
            ai(i,j)=1
          ELSE
            ai(i,j)=0
          END IF
        END DO
      END DO
!
!  Write out logical data as integers.
!
      IF (exit_flag.eq.noerror) THEN
        status=pio_put_var(my_piofile, my_piovar, start, total, ai)
        IF (founderror(status, pio_noerr, __line__, myfile)) THEN
          IF (master) WRITE (stdout,20) trim(myvarname), trim(ncname),  &
     &                                  trim(sourcefile)
          exit_flag=3
          ioerror=status
        END IF
      END IF
!
!  Close file.
!
      IF (.not.PRESENT(piofile)) THEN
        CALL pio_netcdf_close (ng, model, my_piofile, ncname, .false.)
      END IF
!
  10  FORMAT (/,' PIO_NETCDF_PUT_LVAR_2D - error while inquiring ',     &
     &        'descriptor for variable:',2x,a,/,26x,'in input file:',   &
     &        2x,a,/,26x,'call from:',2x,a)
  20  FORMAT (/,' PIO_NETCDF_PUT_LVAR_2D - error while writing ',       &
     &        'variable:',2x,a,/,26x,'in input file:',2x,a,             &
     &        /,26x,'call from:',2x,a)
!
      RETURN

References mod_scalars::exit_flag, strings_mod::founderror(), mod_iounits::ioerror, mod_parallel::master, mod_scalars::noerror, mod_pio_netcdf::pio_netcdf_close(), mod_pio_netcdf::pio_netcdf_open(), mod_iounits::sourcefile, and mod_iounits::stdout.

Here is the call graph for this function:

---

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

• ROMS/Modules/mod_pio_netcdf.F