mod_ncdio Module Reference

Functions/Subroutines
subroutine	archive
subroutine	init_ncdio
subroutine	dump_nc_dat
subroutine	dump_nc_avg
subroutine	dump_nc_rst
subroutine	setup_datfile
subroutine	setup_avgfile
subroutine	add_average
subroutine	divide_average
subroutine	zero_average
subroutine	setup_rstfile
subroutine	dump_data (NCF)
subroutine	define_dimensions (G)
subroutine	kill_dimensions
type(ncfile) function, pointer	grid_file_object (G)
type(ncfile) function, pointer	zeta_file_object ()
type(ncfile) function, pointer	grid_metrics_file_object (G)
type(ncfile) function, pointer	file_date_object (SIZE)
type(ncfile) function, pointer	velocity_file_object ()
type(ncfile) function, pointer	vorticity_file_object ()
type(ncfile) function, pointer	average_vel_file_object ()
type(ncfile) function, pointer	vertical_vel_file_object ()
type(ncfile) function, pointer	salt_temp_file_object ()
type(ncfile) function, pointer	density_file_object ()
type(ncfile) function, pointer	turbulence_file_object ()
type(ncfile) function, pointer	surface_heating_file_object ()
type(ncfile) function, pointer	wind_velocity_file_object ()
type(ncfile) function, pointer	wind_stress_file_object ()
type(ncfile) function, pointer	precipitation_file_object ()
type(ncfile) function, pointer	restart_extras_file_object ()
type(ncfile) function, pointer	wet_dry_file_object ()
type(ncfile) function, pointer	icing_file_object ()
type(ncfile) function, pointer	groundwater_file_object ()
type(ncfile) function, pointer	time_file_object ()
subroutine	update_iodata (NCF, NOW)
subroutine	setup_subdomains (SUB_FILES, GRIDS)
subroutine	set_fvcom_grid (G)
subroutine	set_subdomain_grid (G)
subroutine	setup_mpi_io_mode (TF, COMMGRP)
subroutine	mpi_io_synchronize (CODE)

Variables
logical	visit_cmd_dump
logical	ncnest_cmd_dump
character(len=50)	coordvar
type(ncdim), pointer	dim_nele
type(ncdim), pointer	dim_node
type(ncdim), pointer	dim_three
type(ncdim), pointer	dim_four
type(ncdim), pointer	dim_siglay
type(ncdim), pointer	dim_siglev
type(ncdim), pointer	dim_time
type(ncdim), pointer	dim_datestrlen
type(ncdim), pointer	dim_nobc
type(ncdim), pointer	dim_nlsf
type(ncdim), pointer	dim_maxnode
type(ncdim), pointer	dim_maxelem
type(ncdim), pointer	dim_grid
type(ncdim), pointer	dim_ncat
type(ncdim), pointer	dim_ntilay
type(ncfile), pointer	nc_avg_data
type(ncfile), pointer	nc_avg_sum
type(grid), dimension(:), pointer	nc_dat_grids
type(grid), dimension(:), pointer	nc_avg_grids

Function/Subroutine Documentation

add_average()

subroutine mod_ncdio::add_average

(

)

Definition at line 824 of file mod_ncdio.f90.

    IMPLICIT NONE

    TYPE(NCVARP),POINTER :: CURRENT_DATA,CURRENT_SUM
    TYPE(NCVAR),POINTER :: VAR_DATA, VAR_SUM

    current_data => nc_avg_data%VARS%NEXT
    current_sum => nc_avg_sum%VARS%NEXT

    DO
       IF(.NOT. ASSOCIATED(current_data)) THEN
          EXIT ! END OF VAR LIST
       END IF

       IF(.NOT. ASSOCIATED(current_sum)) THEN
          CALL fatal_error("ADD_AVERAGE: SUM AND DATA VAR LISTS DO NOT HAVE THE SAME LENGTH?")
       END IF

       IF(.NOT. ASSOCIATED(current_sum%VAR)) THEN
          CALL fatal_error("ALLOCATE_ASSOCIATED_VARS: FOUND NULL VAR POINTER IN THE LIST")
       END IF

       IF(.NOT. ASSOCIATED(current_data%VAR)) THEN
          CALL fatal_error("ALLOCATE_ASSOCIATED_VARS: FOUND NULL VAR POINTER IN THE LIST")
       END IF

       var_sum => current_sum%VAR
       var_data => current_data%VAR


       IF(Associated(var_data%SCL_INT)) var_sum%SCL_INT=var_data%SCL_INT+var_sum%SCL_INT
       IF(Associated(var_data%VEC_INT)) var_sum%VEC_INT=var_data%VEC_INT+var_sum%VEC_INT
       IF(Associated(var_data%ARR_INT)) var_sum%ARR_INT=var_data%ARR_INT+var_sum%ARR_INT
       IF(Associated(var_data%CUB_INT)) var_sum%CUB_INT=var_data%CUB_INT+var_sum%CUB_INT
       
       IF(Associated(var_data%SCL_FLT)) var_sum%SCL_FLT=var_data%SCL_FLT+var_sum%SCL_FLT
       IF(Associated(var_data%VEC_FLT)) var_sum%VEC_FLT=var_data%VEC_FLT+var_sum%VEC_FLT
       IF(Associated(var_data%ARR_FLT)) var_sum%ARR_FLT=var_data%ARR_FLT+var_sum%ARR_FLT
       IF(Associated(var_data%CUB_FLT)) var_sum%CUB_FLT=var_data%CUB_FLT+var_sum%CUB_FLT
       
       IF(Associated(var_data%SCL_DBL)) var_sum%SCL_DBL=var_data%SCL_DBL+var_sum%SCL_DBL
       IF(Associated(var_data%VEC_DBL)) var_sum%VEC_DBL=var_data%VEC_DBL+var_sum%VEC_DBL
       IF(Associated(var_data%ARR_DBL)) var_sum%ARR_DBL=var_data%ARR_DBL+var_sum%ARR_DBL
       IF(Associated(var_data%CUB_DBL)) var_sum%CUB_DBL=var_data%CUB_DBL+var_sum%CUB_DBL


       current_data => current_data%NEXT
       current_sum => current_sum%NEXT
    END DO

Here is the call graph for this function:

Here is the caller graph for this function:

archive()

subroutine mod_ncdio::archive

(

)

Definition at line 153 of file mod_ncdio.f90.

    IMPLICIT NONE

    INTEGER :: STATUS
    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START ARCHIVE"


    if(need_init) then
       IF(use_mpi_io_mode) THEN
          CALL mpi_io_synchronize(init_code)
       ELSE
          CALL call_func(init_code,status)
          IF (status/=0) call fatal_error("ARCHIVE:: Bad INIT_CODE",&
               & "Could not retrieve valid function pointer?")
       END IF

       need_init = .false.
       visit_cmd_dump = .false.
    end if

    ncnest_cmd_dump = .false.

    IF(nc_on)THEN
       ! bounds checking
       !IF(NC_DAT%FTIME%NEXT_IO == IntTime .or. FORCE_ARCHIVE) THEN
       IF(abs(nc_dat%FTIME%NEXT_IO -inttime)<0.1_sp*imdti .or. force_archive) THEN
        
          IF(use_mpi_io_mode) THEN
             CALL mpi_io_synchronize(nc_code)
          ELSE
             CALL call_func(nc_code,status)
             IF (status/=0) call fatal_error("ARCHIVE:: Bad NC_CODE",&
                  & "Could not retrieve valid function pointer?")
          END IF
       END IF
    END IF


    IF(ncav_on)THEN

!       !qxu IF(NC_AVG%FTIME%NEXT_IO < IntTime) CALL ADD_AVERAGE
!       IF(NC_AVG%FTIME%PREV_IO < IntTime) CALL ADD_AVERAGE
!       write(*,*) 'NC_AVG%FTIME%PREV_IO=',NC_AVG%FTIME%PREV_IO
!       write(*,*) '             IntTime=',IntTime
!       !CALL ADD_AVERAGE
!       !IF((NC_AVG%FTIME%NEXT_IO + NC_AVG%FTIME%INTERVAL)  == IntTime)THEN
!       !DAS{ ADD for AVG TIMES
!       !IF(abs(NC_AVG%FTIME%NEXT_IO + NC_AVG%FTIME%INTERVAL-IntTime)<0.1_SP*IMDTI)THEN
!       IF(abs(NC_AVG%FTIME%NEXT_IO -IntTime)<0.1_SP*IMDTI)THEN
!       !DAS}
!          CALL DIVIDE_AVERAGE
!
!          IF(USE_MPI_IO_MODE) THEN
!             CALL MPI_IO_SYNCHRONIZE(NCAV_CODE)
!          ELSE
!             CALL CALL_FUNC(NCAV_CODE,status)
!             IF (status/=0) call fatal_error("ARCHIVE:: Bad NCAV_CODE",&
!                  & "Could not retrieve valid function pointer?")
!          END IF
!
!          CALL ZERO_AVERAGE
!
!         END IF


          ! Start averaging data at Next_IO
          IF(nc_avg%FTIME%NEXT_IO < inttime) CALL add_average
          write(*,*) 'NC_AVG%FTIME%NEXT_IO=',nc_avg%FTIME%NEXT_IO
          write(*,*) '             IntTime=',inttime
          
          ! When average interval is complete - write to file
          IF((nc_avg%FTIME%NEXT_IO + nc_avg%FTIME%INTERVAL)  == inttime)THEN

             CALL divide_average

             IF(use_mpi_io_mode) THEN
                CALL mpi_io_synchronize(ncav_code)
             ELSE
                CALL call_func(ncav_code,status)
                IF (status/=0) call fatal_error("ARCHIVE:: Bad NCAV_CODE",&
                & "Could not retrieve valid function pointer?")
             END IF

             CALL zero_average

       END IF
    END IF

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END AVG ARCHIVE"

    IF(rst_on)THEN
       !IF(NC_RST%FTIME%NEXT_IO == IntTime .or.VISIT_CMD_DUMP) then
       IF(abs(nc_rst%FTIME%NEXT_IO-inttime)<0.1_sp*imdti .or.visit_cmd_dump) then

          visit_cmd_dump = .false.
          
          ncnest_cmd_dump = .true.

          IF(use_mpi_io_mode) THEN
             CALL mpi_io_synchronize(restart_code)
          ELSE
             CALL call_func(restart_code,status)
             IF (status/=0) call fatal_error("ARCHIVE:: Bad RESTART_CODE",&
                  & "Could not retrieve valid function pointer?")
          END IF
       END IF
    END IF
        
    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END ARCHIVE"

Here is the call graph for this function:

Here is the caller graph for this function:

average_vel_file_object()

type(ncfile) function, pointer mod_ncdio::average_vel_file_object

(

)

Definition at line 2194 of file mod_ncdio.f90.

    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    character(len=100)    :: timestamp, temp, netcdf_convention

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START AVERAGE_VEL_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(ua(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:UA")
       ua = 0.0_sp

       allocate(va(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:VA")
       va = 0.0_sp

    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! UA
    var  => nc_make_avar(name='ua',&
         & values=ua, dim1= dim_nele, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Vertically Averaged x-velocity') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='meters s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)


    ! VA
    var  => nc_make_avar(name='va',&
         & values=va, dim1= dim_nele, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Vertically Averaged y-velocity') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='meters s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END AVERAGE_VEL_FILE_OBJECT"

Here is the call graph for this function:

Here is the caller graph for this function:

define_dimensions()

subroutine mod_ncdio::define_dimensions

(

type(grid)

G

)

Definition at line 1098 of file mod_ncdio.f90.

!# if defined (WAVE_CURRENT_INTERACTION)
!    USE SWCOMM3
!    USE VARS_WAVE
!    USE MOD_WAVE_CURRENT_INTERACTION
!# endif
    USE bcs
    IMPLICIT NONE
    TYPE(GRID) :: G
    INTEGER :: SBUF, SOURCE
    INTEGER :: RBUF, DEST
    

    dim_nele       => nc_make_dim(name='nele',len=g%ngl)
    dim_node       => nc_make_dim(name='node',len=g%mgl)

    dim_three      => nc_make_dim(name='three',len=3)
    dim_four       => nc_make_dim(name='four',len=4)

    dim_siglev     => nc_make_dim(name='siglev',len=g%kb)
    dim_siglay     => nc_make_dim(name='siglay',len=g%kbm1)

    
    dim_datestrlen => nc_make_dim(name='DateStrLen',len=datestrlen)
    dim_time       => nc_make_dim(name='time',len=nf90_unlimited)

    NULLIFY(dim_grid,dim_ncat,dim_ntilay)
   
    ! ONLY USED IF OBC IS ON
    IF(obc_on) THEN
       dim_nobc       => nc_make_dim(name='nobc',len=iobcn_gl)
    ELSE
       nullify(dim_nobc)
    END IF
    ! ONLY USED IF LOND SHORE FLOW BOUNDARY IS ON
    IF(obc_longshore_flow_on) THEN
       dim_nlsf       => nc_make_dim(name='nlsf',len=nobclsf_gl)
    ELSE
       nullify(dim_nlsf)
    END IF

    dim_maxnode    => nc_make_runtime_dim(name='maxnode',len=mx_nbr_elem+3)

    dim_maxelem    => nc_make_runtime_dim(name='maxelem',len=mx_nbr_elem+1)

Here is the call graph for this function:

Here is the caller graph for this function:

density_file_object()

type(ncfile) function, pointer mod_ncdio::density_file_object

(

)

Definition at line 2453 of file mod_ncdio.f90.

    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    character(len=100)    :: timestamp, temp, netcdf_convention

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START DENSITY_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(rho1(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:RHO1")
       rho1 = 0.0_sp

       allocate(rmean1(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:RMEAN1")
       rmean1 = 0.0_sp

    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! DENSITY
    var  => nc_make_avar(name='rho1',&
         & values=rho1, dim1= dim_node, dim2= dim_siglay, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='density') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='sea_water_density') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='kg/m3') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values=coordvar) 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)    

    ncf  => add(ncf,var)


    ! RMEAN1
    var  => nc_make_avar(name='rmean1',&
         & values=rmean1, dim1= dim_node, dim2= dim_siglay)

    att  => nc_make_att(name='long_name',values='mean density') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='sea_water_density') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='kg/m3') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='SigmaLayer_Mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END DENSITY_FILE_OBJECT"

Here is the call graph for this function:

Here is the caller graph for this function:

divide_average()

subroutine mod_ncdio::divide_average

(

)

Definition at line 877 of file mod_ncdio.f90.

    IMPLICIT NONE      
    TYPE(NCVARP),POINTER :: CURRENT
    TYPE(NCVAR),POINTER :: VAR
    REAL(DP) :: avg_steps

    avg_steps = seconds(nc_avg%FTIME%INTERVAL)/seconds(imdti)

    current => nc_avg_sum%VARS%NEXT

    DO
       IF(.NOT. ASSOCIATED(current)) THEN
          EXIT ! END OF VAR LIST
       END IF

       IF(.NOT. ASSOCIATED(current%VAR)) THEN
          CALL fatal_error("ALLOCATE_ASSOCIATED_VARS: FOUND NULL VAR POINTER IN THE LIST")
       END IF

       var => current%VAR


       IF(Associated(var%SCL_INT)) var%SCL_INT=var%SCL_INT/avg_steps
       IF(Associated(var%VEC_INT)) var%VEC_INT=var%VEC_INT/avg_steps
       IF(Associated(var%ARR_INT)) var%ARR_INT=var%ARR_INT/avg_steps
       IF(Associated(var%CUB_INT)) var%CUB_INT=var%CUB_INT/avg_steps
       
       IF(Associated(var%SCL_FLT)) var%SCL_FLT=var%SCL_FLT/avg_steps
       IF(Associated(var%VEC_FLT)) var%VEC_FLT=var%VEC_FLT/avg_steps
       IF(Associated(var%ARR_FLT)) var%ARR_FLT=var%ARR_FLT/avg_steps
       IF(Associated(var%CUB_FLT)) var%CUB_FLT=var%CUB_FLT/avg_steps
       
       IF(Associated(var%SCL_DBL)) var%SCL_DBL=var%SCL_DBL/avg_steps
       IF(Associated(var%VEC_DBL)) var%VEC_DBL=var%VEC_DBL/avg_steps
       IF(Associated(var%ARR_DBL)) var%ARR_DBL=var%ARR_DBL/avg_steps
       IF(Associated(var%CUB_DBL)) var%CUB_DBL=var%CUB_DBL/avg_steps


       current => current%NEXT
    END DO
 

Here is the call graph for this function:

Here is the caller graph for this function:

dump_data()

subroutine mod_ncdio::dump_data

(

type(ncfile), pointer

NCF

)

Definition at line 1050 of file mod_ncdio.f90.

    IMPLICIT NONE  
    TYPE(NCFILE), POINTER ::NCF
    TYPE(NCFTIME), POINTER :: FTM

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START DUMP_DATA"

    IF(dbg_set(dbg_io)) CALL print_file(ncf)
    IF(dbg_set(dbg_sbrio)) CALL print_var_list(ncf)

    ftm => ncf%FTIME


    IF (ftm%MAX_STKCNT .NE. 0 .AND. &
         & ftm%NEXT_STKCNT > ftm%MAX_STKCNT) THEN

       ftm%NEXT_STKCNT=0
       CALL incriment_fname(ncf%FNAME)
       ncf%CONNECTED=.false.
   

       ! WRITE NEW FILE'S CONSTANT DATA (GRID ETC)
       CALL nc_write_file(ncf)

       ! INCRIMENT THE STACK COUNT
       ftm%NEXT_STKCNT = 1

    END IF


    ! IF UPDATE IODATA BECOMES SPECIFIC TO DIFFERENT DATA SETS IT
    ! WILL HAVE TO BE MOVED INSIDE OF THE PARTICULAR OUTPUT STATEMENTS
    CALL update_iodata(ncf,inttime)

    CALL nc_write_file(ncf)

    ! ONCE THE FILE IS WRITEN INCRIMENT THE FILE OBJECT TIME
    ftm%PREV_IO = inttime
    ftm%NEXT_IO = ftm%NEXT_IO + ftm%INTERVAL

    ! INCRIMENT THE STACK COUNT
    ftm%PREV_STKCNT = ftm%NEXT_STKCNT
    ftm%NEXT_STKCNT = ftm%NEXT_STKCNT + 1
    
    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END DUMP_DATA"
    

Here is the call graph for this function:

Here is the caller graph for this function:

dump_nc_avg()

subroutine mod_ncdio::dump_nc_avg

(

)

Definition at line 344 of file mod_ncdio.f90.

    IMPLICIT NONE
    INTEGER :: I
    TYPE(NCFILE), POINTER :: NCF
    LOGICAL :: FOUND
    
    DO i = 1, SIZE(nc_avg_grids)
       
       ncf => find_file(filehead,nc_avg_grids(i)%NAME,found)
       IF(.NOT.found) CALL fatal_error&
            ("DUMP_NC_AVG: CAN NOT FILE FILE OBJECT NAME:"//trim(nc_avg_grids(i)%NAME))

       CALL dump_data(ncf)

       ! INCASE THE NAME WAS CHANGED INSIDE DUMP_DATA
       nc_avg_grids(i)%NAME = ncf%FNAME

    END DO

Here is the call graph for this function:

Here is the caller graph for this function:

dump_nc_dat()

subroutine mod_ncdio::dump_nc_dat

(

)

Definition at line 320 of file mod_ncdio.f90.

    IMPLICIT NONE
    INTEGER :: I
    TYPE(NCFILE), POINTER :: NCF
    LOGICAL :: FOUND


    IF (icing_model .AND. .NOT. ioproc) CALL icing(inttime)

    DO i = 1, SIZE(nc_dat_grids)
       
       ncf => find_file(filehead,nc_dat_grids(i)%NAME,found)
       IF(.NOT.found) CALL fatal_error&
            ("DUMP_NC_DAT: CAN NOT FILE FILE OBJECT NAME:"//trim(nc_dat_grids(i)%NAME))

       CALL dump_data(ncf)

       ! INCASE THE NAME WAS CHANGED INSIDE DUMP_DATA
       nc_dat_grids(i)%NAME = ncf%FNAME

    END DO

Here is the call graph for this function:

Here is the caller graph for this function:

dump_nc_rst()

subroutine mod_ncdio::dump_nc_rst

(

)

Definition at line 365 of file mod_ncdio.f90.

    IMPLICIT NONE
    CALL dump_data(nc_rst)

Here is the call graph for this function:

Here is the caller graph for this function:

file_date_object()

type(ncfile) function, pointer mod_ncdio::file_date_object

(

integer, optional

SIZE

)

Definition at line 1961 of file mod_ncdio.f90.

    USE mod_clock
    IMPLICIT NONE

    INTEGER :: status
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT
    INTEGER, OPTIONAL :: SIZE
    CHARACTER(LEN=80),pointer :: Data_vec(:)
    
    
    IF(PRESENT(size)) THEN
       ALLOCATE(data_vec(size))
    ELSE
       ALLOCATE(data_vec(1))
    END IF


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START FILE_DATE_OBJECT"
    
  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()

    ! FILE_DATE
    var  => nc_make_pvar(name='file_date', values=data_vec, dim1= dim_datestrlen, dim2 = dim_time)
    var%SCL_CHR => var%VEC_CHR(1)

    IF(use_real_world_time) THEN
       att  => nc_make_att(name='time_zone',values=trim(timezone))
    ELSE
       att  => nc_make_att(name='time_zone',values="UTC")
    END IF

    var  => add(var,att)

    ncf  => add(ncf,var)

Here is the call graph for this function:

Here is the caller graph for this function:

grid_file_object()

type(ncfile) function, pointer mod_ncdio::grid_file_object

(

type(grid)

G

)

Definition at line 1175 of file mod_ncdio.f90.

    USE mod_clock
    USE mod_force
    IMPLICIT NONE
    
    TYPE(GRID) :: G
    INTEGER, POINTER :: partition(:)
    INTEGER :: status, I
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    character(len=100)    :: timestamp, temp, netcdf_convention

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START GRID_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN


       ! MGL AND NGL ARE THE BIGEST THING GOING - USE THEM TO MAKE
       ! SURE WE DON'T GET A SIG SEV - MULTIPLE FILE GRIDS MAY USE
       ! THESE POINTERS!
       ioproc_allocated = .true.

       allocate(partition(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:partition")
       partition = 0

       allocate(xm(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:XM")
       xm = 0.0_sp

       allocate(ym(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:YM")
       ym = 0.0_sp

       allocate(lon(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:LON")
       lon = 0.0_sp

       allocate(lat(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:LAT")
       lat = 0.0_sp

       allocate(xmc(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:XMC")
       xmc = 0.0_sp

       allocate(ymc(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:YMC")
       ymc = 0.0_sp

       allocate(lonc(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:LONC")
       lonc = 0.0_sp

       allocate(latc(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:LATC")
       latc = 0.0_sp

       allocate(zz(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:ZZ")
       zz = 0.0_sp

       allocate(z(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:Z")
       z = 0.0_sp

       allocate(h(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:H")
       h = 0.0_sp
       
!# if defined(UCF)
       allocate(zz1(ngl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:ZZ1")
       zz1 = 0.0_sp

       allocate(z1(ngl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:Z1")
       z1 = 0.0_sp

       allocate(h1(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORcY ON IO PROC FOR OUTPUT DATA:H1")
       h1 = 0.0_sp
!# endif

       
    END IF

    IF(ioproc) THEN

       ! ALLOCATE NV BASED ON THE GRID DIMENSION
       IF(ASSOCIATED(g%NV)) THEN
          
          IF(ubound(g%nv,1)/=dim_nele%DIM) THEN
             CALL fatal_error &
                  &("GRID DATA NV HAS ALREADY BEEN ASSOICATED ON THE IOPROC",&
                  & "AND THE DIMENSION DOES NOT MATCH THE CURRENT FILE!",&
                  &"GRID NAME:"//trim(g%NAME))
          END IF

       ELSE
          allocate(g%nv(g%NGL,3),stat=status)
          IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:G%NV")
          g%nv = 0
       END IF
    END IF



    ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! ADD THE FILE ATTRIBUTES
    att => nc_make_att(name='title',values=trim(case_title)) 
    ncf => add(ncf,att)


    att => nc_make_att(name='institution',values=trim(institution)) 
    ncf => add(ncf,att)

    att => nc_make_att(name='source',values=trim(fvcom_version)) 
    ncf => add(ncf,att)

    call get_timestamp(temp)
    timestamp = 'model started at: '//trim(temp)

    att => nc_make_att(name='history',values=trim(timestamp)) 
    ncf => add(ncf,att)

    att => nc_make_att(name='references',values=trim(fvcom_website)) 
    ncf => add(ncf,att)

    netcdf_convention = 'CF-1.0'
    att => nc_make_att(name='Conventions',values=trim(netcdf_convention)) 
    ncf => add(ncf,att)

    att => nc_make_att(name='CoordinateSystem',values="Cartesian" ) 
    ncf => add(ncf,att)

    att => nc_make_att(name='CoordinateProjection',values=projection_reference ) 
    IF(ASSOCIATED(att)) ncf => add(ncf,att)

    IF(trim(prg_name) == "FVCOM") THEN
       
       att=> nc_make_runtime_att_chr(name='Tidal_Forcing',values=tide_forcing_comments)
       IF(ASSOCIATED(att)) ncf => add(ncf,att)
       
       att=> nc_make_runtime_att_chr(name='River_Forcing',values=river_forcing_comments)
       IF(ASSOCIATED(att)) ncf => add(ncf,att)
       
       att=> nc_make_runtime_att_chr(name='GroundWater_Forcing',values=gwater_forcing_comments)
       IF(ASSOCIATED(att)) ncf => add(ncf,att)
       
       att=> nc_make_runtime_att_chr(name='Surface_Heat_Forcing',values=heat_forcing_comments)
       IF(ASSOCIATED(att)) ncf => add(ncf,att)
       
       att=> nc_make_runtime_att_chr(name='Surface_Wind_Forcing',values=winds_forcing_comments)
       IF(ASSOCIATED(att)) ncf => add(ncf,att)

!------Jadon for offline wave forcing

       att=> nc_make_runtime_att_chr(name='Surface_PrecipEvap_Forcing',values=precip_forcing_comments)
       IF(ASSOCIATED(att)) ncf => add(ncf,att)
       
       IF (icing_model) THEN
          att=> nc_make_runtime_att_chr(name='Icing_Model_Forcing',values=icing_forcing_comments)
          IF(ASSOCIATED(att)) ncf => add(ncf,att)
       END IF
       
       IF (ice_model) THEN
          att=> nc_make_runtime_att_chr(name='Ice_Model_Forcing',values=ice_forcing_comments)
          IF(ASSOCIATED(att)) ncf => add(ncf,att)
       END IF
       
       
       IF(obc_longshore_flow_on) THEN
          att=> nc_make_att(name='Special_Physical_processes',&
               & values='long shore flow adjustment for thermal wind and win&
               &d driven setup')
          ncf => add(ncf,att)
       END IF

    END IF

    ! ADD THE VARIABLES

    ! NPROCS
    var  => nc_make_avar(name='nprocs',values=nprocs)

    att  => nc_make_att(name='long_name',values='number of processors') 
    var  => add(var,att)
    ncf  => add(ncf,var)




    ! X
    var  => nc_make_avar(name='x',values=xm,dim1=dim_node)
   
    att  => nc_make_att(name='long_name',values='nodal x-coordinate') 
    var  => add(var,att)
    
    att  => nc_make_att(name='units',values='meters') 
    var  => add(var,att)
    ncf  => add(ncf,var)
    
    ! Y
    var  => nc_make_avar(name='y',values=ym,dim1=dim_node)

    att  => nc_make_att(name='long_name',values='nodal y-coordinate') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='meters') 
    var  => add(var,att)

    ncf  => add(ncf,var)


    ! LON
    var  => nc_make_avar(name='lon',values=lon,dim1=dim_node)

    att  => nc_make_att(name='long_name',values='nodal longitude') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='longitude') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='degrees_east') 
    var  => add(var,att)
    ncf  => add(ncf,var)

    ! LAT
    var  => nc_make_avar(name='lat',values=lat,dim1=dim_node)

    att  => nc_make_att(name='long_name',values='nodal latitude') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='latitude') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='degrees_north') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    IF (ALLOCATED(xmc)) THEN
       ! XMC
       var  => nc_make_avar(name='xc',values=xmc,dim1=dim_nele)
       
       att  => nc_make_att(name='long_name',values='zonal x-coordinate') 
       var  => add(var,att)
       
       att  => nc_make_att(name='units',values='meters') 
       var  => add(var,att)
       ncf  => add(ncf,var)
    END IF

    IF (ALLOCATED(ymc)) THEN
       ! YMC
       var  => nc_make_avar(name='yc',values=ymc,dim1=dim_nele)
       
       att  => nc_make_att(name='long_name',values='zonal y-coordinate') 
       var  => add(var,att)
       
       att  => nc_make_att(name='units',values='meters') 
       var  => add(var,att)
       
       ncf  => add(ncf,var)
    END IF

    IF (ALLOCATED(lonc)) THEN
       ! LONC
       var  => nc_make_avar(name='lonc',values=lonc,dim1=dim_nele)
       
       att  => nc_make_att(name='long_name',values='zonal longitude') 
       var  => add(var,att)
       
       att  => nc_make_att(name='standard_name',values='longitude') 
       var  => add(var,att)
       
       att  => nc_make_att(name='units',values='degrees_east') 
       var  => add(var,att)
       ncf  => add(ncf,var)
    END IF

    IF (ALLOCATED(latc)) THEN
       ! LATC
       var  => nc_make_avar(name='latc',values=latc,dim1=dim_nele)
       
       att  => nc_make_att(name='long_name',values='zonal latitude') 
       var  => add(var,att)
       
       att  => nc_make_att(name='standard_name',values='latitude') 
       var  => add(var,att)
       
       att  => nc_make_att(name='units',values='degrees_north') 
       var  => add(var,att)
       
       ncf  => add(ncf,var)
    END IF

    IF (ALLOCATED(zz)) THEN
       ! siglay
       var  => nc_make_avar(name='siglay',&
            & values=zz,&
            & dim1= dim_node,&
            & dim2= dim_siglay )
       
       att  => nc_make_att(name='long_name',values='Sigma Layers') 
       var  => add(var,att)
       
       att  => nc_make_att(name='standard_name',values='ocean_sigma/general_coordinate') 
       var  => add(var,att)
       
       att  => nc_make_att(name='positive',values='up') 
       var  => add(var,att)
       
       att  => nc_make_att(name='valid_min',values=-1.0_spa) 
       var  => add(var,att)
       
       att  => nc_make_att(name='valid_max',values=0.0_spa) 
       var  => add(var,att)
       
       att  => nc_make_att(name='formula_terms',values='sigma: siglay eta: zeta depth: h') 
       var  => add(var,att)
       
       ncf  => add(ncf,var)
    END IF

    IF (ALLOCATED(z)) THEN
       ! siglev
       var  => nc_make_avar(name='siglev',&
            & values=z, dim1= dim_node, dim2= dim_siglev )
       
       att  => nc_make_att(name='long_name',values='Sigma Levels') 
       var  => add(var,att)
       
       att  => nc_make_att(name='standard_name',values='ocean_sigma/general_coordinate') 
       var  => add(var,att)
       
       att  => nc_make_att(name='positive',values='up') 
       var  => add(var,att)
       
       att  => nc_make_att(name='valid_min',values=-1.0_spa) 
       var  => add(var,att)
       
       att  => nc_make_att(name='valid_max',values=0.0_spa) 
       var  => add(var,att)
       
       att  => nc_make_att(name='formula_terms',values='sigma:siglay eta: zeta depth: h') 
       var  => add(var,att)
       
       ncf  => add(ncf,var)
    END IF

!# if defined(UCF)
    ! ADD SIGMA VALUE AT CELL CENTERS!
    IF (ALLOCATED(zz1)) THEN
       ! siglay
       var  => nc_make_avar(name='siglay_center',&
            & values=zz1,&
            & dim1= dim_nele,&
            & dim2= dim_siglay )
       
       att  => nc_make_att(name='long_name',values='Sigma Layers') 
       var  => add(var,att)
       
       att  => nc_make_att(name='standard_name',values='ocean_sigma/general_coordinate') 
       var  => add(var,att)
       
       att  => nc_make_att(name='positive',values='up') 
       var  => add(var,att)
       
       att  => nc_make_att(name='valid_min',values=-1.0_spa) 
       var  => add(var,att)
       
       att  => nc_make_att(name='valid_max',values=0.0_spa) 
       var  => add(var,att)
       
       att  => nc_make_att(name='formula_terms',values='sigma: siglay_center eta: zeta_center depth: h_center') 
       var  => add(var,att)
       
       ncf  => add(ncf,var)
    END IF

    IF (ALLOCATED(z1)) THEN
       ! siglev
       var  => nc_make_avar(name='siglev_center',&
            & values=z1, dim1= dim_nele, dim2= dim_siglev )
       
       att  => nc_make_att(name='long_name',values='Sigma Levels') 
       var  => add(var,att)
       
       att  => nc_make_att(name='standard_name',values='ocean_sigma/general_coordinate') 
       var  => add(var,att)
       
       att  => nc_make_att(name='positive',values='up') 
       var  => add(var,att)
       
       att  => nc_make_att(name='valid_min',values=-1.0_spa) 
       var  => add(var,att)
       
       att  => nc_make_att(name='valid_max',values=0.0_spa) 
       var  => add(var,att)
       
       att  => nc_make_att(name='formula_terms',values='sigma:siglay_center eta: zeta_center depth: h_center') 
       var  => add(var,att)
       
       ncf  => add(ncf,var)
    END IF

    IF (ALLOCATED(h1)) THEN
       ! h1  (if morphodynamics is on, dump time-dependent bathymetry)
       var  => nc_make_avar(name='h_center',values=h1, dim1= dim_nele)

       att  => nc_make_att(name='long_name',values='Bathymetry') 
       var  => add(var,att)
       
       att  => nc_make_att(name='standard_name',values='sea_floor_depth_below_geoid') 
       var  => add(var,att)

       att  => nc_make_att(name='units',values='m')
       var  => add(var,att)

       att  => nc_make_att(name='positive',values='down') 
       var  => add(var,att)
       
       att  => nc_make_att(name='grid',values='grid1 grid3') 
       var  => add(var,att)

       att  => nc_make_att(name='coordinates',values='latc lonc') 
       var  => add(var,att)

       att  => nc_make_att(name='grid_location',values='center') 
       var  => add(var,att)

       ncf  => add(ncf,var)
    END IF


!# endif

    IF (ALLOCATED(h)) THEN
       ! h (if morphodynamics is on, dump time-dependent bathymetry)
       var  => nc_make_avar(name='h',values=h, dim1= dim_node)

       att  => nc_make_att(name='long_name',values='Bathymetry') 
       var  => add(var,att)
       
       att  => nc_make_att(name='standard_name',values='sea_floor_depth_below_geoid') 
       var  => add(var,att)

       att  => nc_make_att(name='units',values='m')
       var  => add(var,att)

       att  => nc_make_att(name='positive',values='down') 
       var  => add(var,att)

       att  => nc_make_att(name='grid',values='Bathymetry_Mesh') 
       var  => add(var,att)

       att  => nc_make_att(name='coordinates',values=coordvar) 
       var  => add(var,att)

       att  => nc_make_att(name='type',values='data') 
       var  => add(var,att)

       ncf  => add(ncf,var)
    END IF

    ! nv
    var  => nc_make_pvar(name='nv',&
         & values=g%nv, dim1= dim_nele, dim2= dim_three)

    att  => nc_make_att(name='long_name',values='nodes surrounding element') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END GRID_FILE_OBJECT"

Here is the call graph for this function:

Here is the caller graph for this function:

grid_metrics_file_object()

type(ncfile) function, pointer mod_ncdio::grid_metrics_file_object

(

type(grid)

G

)

Definition at line 1734 of file mod_ncdio.f90.

    IMPLICIT NONE

    TYPE(GRID) :: G

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    REAL(SP), POINTER :: vec_flt(:),arr_flt(:)
    INTEGER, POINTER :: vec_int(:),arr_int(:)

    character(len=100)    :: timestamp, temp, netcdf_convention

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START GRID_METRICS_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!

    IF(ioproc) THEN
       ! ALWAYS ALLOCATE SPECIAL SPACE IN THE GRID TYPE FOR INDEX ARRAYS!

       IF(.NOT. ASSOCIATED(g%NBE)) THEN
          allocate(g%NBE(g%NGL,3),stat=status)
          IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:G%NBE")
          g%NBE = 0
       ELSE
          IF(ubound(g%NBE,1)/=dim_nele%DIM) CALL fatal_error &
               &("GRID DATA NBE HAS ALREADY BEEN ASSOICATED ON THE IOPROC",&
               & "AND THE DIMENSION DOES NOT MATCH THE CURRENT FILE!",&
               &"GRID NAME:"//trim(g%NAME))
       END IF
          
       IF(.NOT. ASSOCIATED(g%NBSN)) THEN
          allocate(g%NBSN(g%MGL,dim_maxnode%DIM),stat=status)
          IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:G%NBSN")
          g%NBSN = 0
       ELSE
          IF(ubound(g%NBSN,1)/=dim_node%DIM) CALL fatal_error &
               &("GRID DATA NBSN HAS ALREADY BEEN ASSOICATED ON THE IOPROC",&
               & "AND THE DIMENSION DOES NOT MATCH THE CURRENT FILE!",&
               &"GRID NAME:"//trim(g%NAME))
       END IF

       IF(.NOT. ASSOCIATED(g%NBVE)) THEN
          allocate(g%NBVE(g%MGL,dim_maxelem%DIM),stat=status)
          IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:G%NBVE")
          g%NBVE = 0  
       ELSE
          IF(ubound(g%NBVE,1)/=dim_node%DIM) CALL fatal_error &
               &("GRID DATA NBVE HAS ALREADY BEEN ASSOICATED ON THE IOPROC",&
               & "AND THE DIMENSION DOES NOT MATCH THE CURRENT FILE!",&
               &"GRID NAME:"//trim(g%NAME))
       END IF
       

    END IF


    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ! ONLY ALLOCATE THIS SPACE ONCE - IT IS SHARED NO MATTER WHAT
       ! DOMAIN IS BEING SAVED!
       ioproc_allocated = .true.

       allocate(ntsn(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:NTSN")
       ntsn = 0

       allocate(ntve(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:NTVE")
       ntve = 0

       allocate(a1u(ngl,4),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:A1U")
       a1u = 0.0_sp

       allocate(a2u(ngl,4),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:A2U")
       a2u = 0.0_sp

       allocate(awx(ngl,3),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:AWX")
       awx = 0.0_sp

       allocate(awy(ngl,3),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:AWY")
       awy = 0.0_sp

       allocate(aw0(ngl,3),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:AW0")
       aw0 = 0.0_sp

       allocate(art2(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:ART2")
       art2 = 0.0_sp

       allocate(art1(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:ART1")
       art1 = 0.0_sp


    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! NBE
    var  => nc_make_pvar(name='nbe',&
         & values=g%NBE, dim1= dim_nele, dim2= dim_three)

    att  => nc_make_att(name='long_name',values='elements surrounding each element') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! NTSN
    var  => nc_make_avar(name='ntsn',&
         & values=ntsn, dim1= dim_node)

    att  => nc_make_att(name='long_name',values='#nodes surrounding each node') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! NBSN
    var  => nc_make_pvar(name='nbsn',&
         & values=g%NBSN, dim1= dim_node, dim2= dim_maxnode)

    att  => nc_make_att(name='long_name',values='nodes surrounding each node') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! NTVE
    var  => nc_make_avar(name='ntve',&
         & values=ntve, dim1= dim_node)

    att  => nc_make_att(name='long_name',values='#elems surrounding each node') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! NBVE
    var  => nc_make_pvar(name='nbve',&
         & values=g%NBVE, dim1= dim_node, dim2= dim_maxelem)

    att  => nc_make_att(name='long_name',values='elems surrounding each node') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! A1U
    var  => nc_make_avar(name='a1u',&
         & values=a1u, dim1= dim_nele, dim2= dim_four)

    att  => nc_make_att(name='long_name',values='a1u') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! A2U
    var  => nc_make_avar(name='a2u',&
         & values=a2u, dim1= dim_nele, dim2= dim_four)

    att  => nc_make_att(name='long_name',values='a2u') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! AW0
    var  => nc_make_avar(name='aw0',&
         & values=aw0, dim1= dim_nele, dim2= dim_three)

    att  => nc_make_att(name='long_name',values='aw0') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! AWX
    var  => nc_make_avar(name='awx',&
         & values=awx, dim1= dim_nele, dim2= dim_three)

    att  => nc_make_att(name='long_name',values='awx') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! AWY
    var  => nc_make_avar(name='awy',&
         & values=awy, dim1= dim_nele, dim2= dim_three)

    att  => nc_make_att(name='long_name',values='awy') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! ART2
    var  => nc_make_avar(name='art2',&
         & values=art2, dim1= dim_node)

    att  => nc_make_att(name='long_name',values='Area of elements around a node') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! ART1
    var  => nc_make_avar(name='art1',&
         & values=art1, dim1= dim_node)

    att  => nc_make_att(name='long_name',values='Area of Node-Base Con&
         &trol volume') 
    var  => add(var,att)

    ncf  => add(ncf,var)


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END GRID_METRICS_FILE_OBJECT"

Here is the call graph for this function:

Here is the caller graph for this function:

groundwater_file_object()

type(ncfile) function, pointer mod_ncdio::groundwater_file_object

(

)

Definition at line 3728 of file mod_ncdio.f90.

    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START: GROUNDWATER_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(bfwdis(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:BFWDIS")
       bfwdis = 0.0_sp

       IF(groundwater_temp_on) THEN
          allocate(bfwtmp(mgl),stat=status)
          IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:BFWTMP")
          bfwtmp = 0.0_sp
       END IF

       IF(groundwater_salt_on) THEN
          allocate(bfwslt(mgl),stat=status)
          IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:BFWSLT")
          bfwslt = 0.0_sp
       END IF


    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! GROUNDWATER VOLUME FLUX
    var  => nc_make_avar(name='groundwater_flux',&
         & values=bfwdis, dim1= dim_node, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='groundwater volume flux') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m3 s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! GROUNDWATER INFLOW TEMPERATURE
    IF(groundwater_temp_on) THEN
       var  => nc_make_avar(name='groundwater_temp',&
            & values=bfwdis, dim1= dim_node, dim2= dim_time)
       
       att  => nc_make_att(name='long_name',values='groundwater inflow temperature') 
       var  => add(var,att)
       
       att  => nc_make_att(name='units',values='degrees_C') 
       var  => add(var,att)
       
       att  => nc_make_att(name='grid',values='fvcom_grid') 
       var  => add(var,att)
       
       att  => nc_make_att(name='type',values='data') 
       var  => add(var,att)
       
       ncf  => add(ncf,var)
    END IF

    ! GROUNDWATER INFLOW SALINITY
    IF(groundwater_salt_on) THEN
       var  => nc_make_avar(name='groundwater_salt',&
            & values=bfwdis, dim1= dim_node, dim2= dim_time)
       
       att  => nc_make_att(name='long_name',values='groundwater inflow salinity') 
       var  => add(var,att)
       
       att  => nc_make_att(name='units',values='1e-3') 
       var  => add(var,att)
       
       att  => nc_make_att(name='grid',values='fvcom_grid') 
       var  => add(var,att)
       
       att  => nc_make_att(name='type',values='data') 
       var  => add(var,att)
       
       ncf  => add(ncf,var)
    END IF


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END GROUND_FILE_OBJECT"
    

Here is the call graph for this function:

Here is the caller graph for this function:

icing_file_object()

type(ncfile) function, pointer mod_ncdio::icing_file_object

(

)

Definition at line 3587 of file mod_ncdio.f90.

    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START ICING_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(icing_0kts(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:ICING_0kts")
       icing_0kts = 0.0_sp

       allocate(icing_10kts(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:ICING_10kts")
       icing_10kts = 0.0_sp

       allocate(icing_wndx(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:ICING_wndY")
       icing_wndx = 0.0_sp

       allocate(icing_wndy(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:ICING_wndX")
       icing_wndy = 0.0_sp

       allocate(icing_satmp(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:ICING_satmp")
       icing_satmp = 0.0_sp

    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! ICING_0KTS
    var  => nc_make_avar(name='icing_0kts',&
         & values=icing_0kts, dim1= dim_node, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Icing Hazard@0knots') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m C s^-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! ICING_10KTS
    var  => nc_make_avar(name='icing_10kts',&
         & values=icing_10kts, dim1= dim_node, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Icing Hazard@10knots') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m C s^-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! ICING_WNDX
    var  => nc_make_avar(name='icing_wndx',&
         & values=icing_wndx, dim1= dim_node, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Icing Wind x-direction') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m s^-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! ICING_WNDY
    var  => nc_make_avar(name='icing_wndy',&
         & values=icing_wndy, dim1= dim_node, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Icing Wind y-direction') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m s^-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! ICING_SATMP
    var  => nc_make_avar(name='icing_satmp',&
         & values=icing_satmp, dim1= dim_node, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Icing Surface Air Temperature') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='degrees_C') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END ICING_FILE_OBJECT"
    

Here is the call graph for this function:

Here is the caller graph for this function:

init_ncdio()

subroutine mod_ncdio::init_ncdio

(

)

Definition at line 264 of file mod_ncdio.f90.

    IMPLICIT NONE

    IF(dbg_set(dbg_log)) THEN
       
       write(ipt,*)"!=============================================================="
       write(ipt,*)"! SETTING UP NCDIO: CREATING AND DUMPING OUTPUT FILE META DATA"
       write(ipt,*)"!=============================================================="
    END IF

    ! DEFINE DIMENSIONS HERE - THEY ARE KILLED AT THE END OF THIS
    ! SETUP SCRIPT...

    coordvar="x y"


    IF(nc_on) then
       
       IF(.not. ASSOCIATED(nc_dat)) Call fatal_error &
            & ("INIT_NCDIO: THE DATA FILE OBJECT IS NOT ASSOCIATED ")
           
       CALL setup_datfile


    END IF
  
    IF(ncav_on) then
       
       IF(.not. ASSOCIATED(nc_avg)) Call fatal_error &
            & ("INIT_NCDIO: THE AVERAGE FILE OBJECT IS NOT ASSOCIATED ")


       CALL setup_avgfile
    END IF

    IF(rst_on) then


       IF(.not. ASSOCIATED(nc_rst)) Call fatal_error &
            & ("INIT_NCDIO: THE RESTART FILE OBJECT IS NOT ASSOCIATED ")

       CALL setup_rstfile
    END IF

    IF(dbg_set(dbg_log)) THEN
       

       write(ipt,*)"! FINISHED NCDIO SETUP!"
       write(ipt,*)"!=============================================================="
    END IF

Here is the call graph for this function:

Here is the caller graph for this function:

kill_dimensions()

subroutine mod_ncdio::kill_dimensions

(

)

Definition at line 1148 of file mod_ncdio.f90.

    IMPLICIT NONE

    IF (ASSOCIATED(dim_nele)) CALL kill_dim(dim_nele)
    IF (ASSOCIATED(dim_node)) CALL kill_dim(dim_node)

    IF (ASSOCIATED(dim_three)) CALL kill_dim(dim_three)
    IF (ASSOCIATED(dim_four)) CALL kill_dim(dim_four)

    IF (ASSOCIATED(dim_siglay)) CALL kill_dim(dim_siglay)
    IF (ASSOCIATED(dim_siglev)) CALL kill_dim(dim_siglev)

    IF (ASSOCIATED(dim_datestrlen)) CALL kill_dim(dim_datestrlen)
    IF (ASSOCIATED(dim_time)) CALL kill_dim(dim_time)

    IF (ASSOCIATED(dim_grid)) CALL kill_dim(dim_grid)
    IF (ASSOCIATED(dim_ncat)) CALL kill_dim(dim_ncat)
    IF (ASSOCIATED(dim_ntilay)) CALL kill_dim(dim_ntilay)

    IF (ASSOCIATED(dim_nobc)) CALL kill_dim(dim_nobc)
    IF (ASSOCIATED(dim_nlsf)) CALL kill_dim(dim_nlsf)

    IF (ASSOCIATED(dim_maxnode)) CALL kill_dim(dim_maxnode)
    IF (ASSOCIATED(dim_maxelem)) CALL kill_dim(dim_maxelem)    

Here is the caller graph for this function:

mpi_io_synchronize()

subroutine mod_ncdio::mpi_io_synchronize

(

integer

CODE

)

Definition at line 4252 of file mod_ncdio.f90.

    implicit none
    integer code

    CALL fatal_error("THIS IS A DUMMY ROUTINE:","MPI_IO_SYNCHRONIZ&
         &E only exists when FVCOM is compiled with multiprocessor",&
         & "USE_MPI_IO_MODE should not be .true.")

Here is the call graph for this function:

Here is the caller graph for this function:

precipitation_file_object()

type(ncfile) function, pointer mod_ncdio::precipitation_file_object

(

)

Definition at line 3055 of file mod_ncdio.f90.

    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT
    TYPE(NCDIM),  POINTER :: DIM1
    TYPE(NCDIM),  POINTER :: DIM2
    TYPE(NCDIM),  POINTER :: DIM3

    character(len=100)    :: timestamp, temp, netcdf_convention

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START PRECIPITATION_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(qprec(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:QPREC2")
       qprec = 0.0_sp

       allocate(qevap(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:QEVAP2")
       qevap = 0.0_sp

    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! PRECIPITATION
    var  => nc_make_avar(name='precip',&
         & values=qprec, dim1= dim_node, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Precipitation') 
    var  => add(var,att)

    att  => nc_make_att(name='description',values='Precipitation, ocean &
         &lose water is negative') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values=coordvar) 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! EVAPORATION
    var  => nc_make_avar(name='evap',&
         & values=qevap, dim1= dim_node, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Evaporation') 
    var  => add(var,att)

    att  => nc_make_att(name='description',values='Evaporation, ocean &
         &lose water is negative') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values=coordvar) 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END PRECIPITATION_FILE_OBJECT"
    

Here is the call graph for this function:

Here is the caller graph for this function:

restart_extras_file_object()

type(ncfile) function, pointer mod_ncdio::restart_extras_file_object

(

)

Definition at line 3151 of file mod_ncdio.f90.

    USE bcs
    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    character(len=100)    :: timestamp, temp, netcdf_convention

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START RESTART_EXTRAS_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(cor(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:COR")
       cor = 0.0_sp

       allocate(cc_sponge(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:CC_SPONGE")
       cc_sponge = 0.0_sp

       allocate(et(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:EL")
       et = 0.0_sp


! OPEN BOUNDARY SETTINGS
       IF (obc_on) THEN
          ! NEED SPECIAL VARIABLE FOR GLOBAL NODE NUMBER OF LOCAL NODES...
          allocate(i_obc_n_output(iobcn_gl),stat=status)
          IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:I_OBC_N_OUTPUT")
          i_obc_n_output = 0
          
          
          allocate(type_obc(iobcn_gl),stat=status)
          IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:type_obc")
          type_obc = 0
       END IF

! LONG SHORE FLOW BOUNDARY SETTINGS
       IF(obc_longshore_flow_on) THEN
          allocate(ibclsf_output(nobclsf_gl),stat=status)
          IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:IBCLSF_OUTPUT")
          ibclsf_output = 0
          
          allocate(rbc_geo(nobclsf_gl),stat=status)
          IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:RBC_GEO")
          rbc_geo = 0.0_sp
          
          allocate(rbc_wdf(nobclsf_gl),stat=status)
          IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:RBC_WDF")
          rbc_wdf = 0.0_sp
       END IF
       
          
       allocate(tmean1(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:Tmean1")
       tmean1 = 0.0_sp
       
       allocate(smean1(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:Smean1")
       smean1 = 0.0_sp



    ! ------ New: Karsten Lettmann, 2016, June ---------------
    ! add the atmospheric pressure elevation
    ! -------- end new -------------------------------------


    END IF

  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! COR
    var  => nc_make_avar(name='cor',&
         & values=cor, dim1= dim_nele)

    att  => nc_make_att(name='long_name',values='Coriolis Parameter') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! CC_SPONGE
    var  => nc_make_avar(name='cc_sponge',&
         & values=cc_sponge, dim1= dim_nele)

    att  => nc_make_att(name='long_name',values='Sponge Layer Parameter') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='nd') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! et
    var  => nc_make_avar(name='et',&
         & values=et, dim1= dim_node, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Water Surface Elevation At Last Timestep') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='meters') 
    var  => add(var,att)

    att  => nc_make_att(name='positive',values='up') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='sea_surface_elevation') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='SSH_Mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! TMEAN1
    var  => nc_make_avar(name='tmean1',&
         & values=tmean1, dim1= dim_node, dim2= dim_siglay )

    att  => nc_make_att(name='long_name',values='mean initial temperature') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='sea_water_temperature') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='degrees_C') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='SigmaLayer_Mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! SMEAN1
    var  => nc_make_avar(name='smean1',&
         & values=smean1, dim1= dim_node, dim2= dim_siglay )

    att  => nc_make_att(name='long_name',values='mean initial salinity') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='sea_water_temperature') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='1e-3') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='SigmaLayer_Mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    IF(obc_on)THEN
       ! OBC_GRID
       var  => nc_make_avar(name='obc_nodes',&
            & values=i_obc_n_output, dim1= dim_nobc)
       
       att  => nc_make_att(name='long_name',values='Open Boundary Node Number') 
       var  => add(var,att)
       
       att  => nc_make_att(name='grid',values='obc_grid') 
       var  => add(var,att)
       
       ncf  => add(ncf,var)
       
       ! OBC_TYPE
       var  => nc_make_avar(name='obc_type',&
            & values=type_obc, dim1= dim_nobc)
       
       att  => nc_make_att(name='long_name',values='Open Boundary Type') 
       var  => add(var,att)
       
       att  => nc_make_att(name='grid',values='obc_grid') 
       var  => add(var,att)
       
       ncf  => add(ncf,var)
    END IF

    IF(obc_longshore_flow_on)THEN
       ! long shore flow grid
       var  => nc_make_avar(name='lsf_nodes',&
            & values=ibclsf_output, dim1= dim_nlsf)
       
       att  => nc_make_att(name='long_name',values='Longshore Flow Node Number') 
       var  => add(var,att)
       
       att  => nc_make_att(name='grid',values='lsf_grid') 
       var  => add(var,att)
       
       ncf  => add(ncf,var)
       
       ! 
       var  => nc_make_avar(name='wdf',&
            & values=rbc_wdf, dim1= dim_nlsf)
       
       att  => nc_make_att(name='long_name',values='Wind Driven Flow Adjustment Scaling') 
       var  => add(var,att)
       
       att  => nc_make_att(name='valid_range',values='[0 1]') 
       var  => add(var,att)       

       att  => nc_make_att(name='grid',values='lsf_grid') 
       var  => add(var,att)
       
       ncf  => add(ncf,var)

       var  => nc_make_avar(name='geo',&
            & values=rbc_geo, dim1= dim_nlsf)
       
       att  => nc_make_att(name='long_name',values='Thermal Wind Flow Adjustment Scaling') 
       var  => add(var,att)
       
       att  => nc_make_att(name='valid_range',values='[0 1]') 
       var  => add(var,att)       

       att  => nc_make_att(name='grid',values='lsf_grid') 
       var  => add(var,att)
       
       ncf  => add(ncf,var)
    END IF


    


    ! ------ New: Karsten Lettmann, 2016, June ---------------
    ! add the atmospheric pressure elevation
    ! -------- end new -------------------------------------


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END RESTART_EXTRAS_FILE_OBJECT"
    

Here is the call graph for this function:

Here is the caller graph for this function:

salt_temp_file_object()

type(ncfile) function, pointer mod_ncdio::salt_temp_file_object

(

)

Definition at line 2349 of file mod_ncdio.f90.

    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    character(len=100)    :: timestamp, temp, netcdf_convention

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START SALT_TEMP_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(t1(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:T1")
       t1 = 0.0_sp

       allocate(s1(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:S1")
       s1 = 0.0_sp

    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! T
    var  => nc_make_avar(name='temp',&
         & values=t1, dim1= dim_node, dim2= dim_siglay, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='temperature') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='sea_water_temperature') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='degrees_C') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

!!$    ATT  => NC_MAKE_ATT(name='coordinates',values=CoordVar) 
    att  => nc_make_att(name='coordinates',values='time siglay lat lon') 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)    

    att  => nc_make_att(name='mesh',values='fvcom_mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='location',values='node') 
    var  => add(var,att)

    ncf  => add(ncf,var)


    ! S
    var  => nc_make_avar(name='salinity',&
         & values=s1, dim1= dim_node, dim2= dim_siglay, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='salinity') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='sea_water_salinity') 
    var  => add(var,att)


    att  => nc_make_att(name='units',values='1e-3') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

!!$    ATT  => NC_MAKE_ATT(name='coordinates',values=CoordVar) 
    att  => nc_make_att(name='coordinates',values='time siglay lat lon') 
    var  => add(var,att)    

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    att  => nc_make_att(name='mesh',values='fvcom_mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='location',values='node') 
    var  => add(var,att)

    ncf  => add(ncf,var)


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END SALT_TEMP_FILE_OBJECT"

Here is the call graph for this function:

Here is the caller graph for this function:

set_fvcom_grid()

subroutine mod_ncdio::set_fvcom_grid

(

type(grid)

G

)

Definition at line 4016 of file mod_ncdio.f90.

     IMPLICIT NONE
     TYPE(GRID):: G
     INTEGER :: I,J,STATUS
     
    if(dbg_set(dbg_sbr)) &
         & write(ipt,*) "START SET_FVCOM_GRID"

     ! SET UP GLOBAL GRID INDEX - USED TO MAKE INDEX ARRAYS FOR OUTPUT
     ! TO FILE

     g%NAME = "FVCOM"
     g%UNITS = "Not used yet"
     
     g%MGL  = mgl
     g%NGL  = ngl
     g%KB   = kb
     g%KBM1 = kbm1
     g%KBM2 = kbm2
     
     NULLIFY(g%NV)

     NULLIFY(g%XM)
     NULLIFY(g%YM)
     NULLIFY(g%XMC)
     NULLIFY(g%YMC)

     NULLIFY(g%LAT)
     NULLIFY(g%LON)
     NULLIFY(g%LATC)
     NULLIFY(g%LONC)

     NULLIFY(g%NBE)
     NULLIFY(g%NBSN)
     NULLIFY(g%NBVE)
     
     IF(.NOT. ioproc) THEN
        g%M  = m
        g%MT = mt
        g%N  = n
        g%NT = nt
        
        g%ELID   => elid
        g%ELID_X => elid_x
        g%NLID   => nlid
        g%NLID_X => nlid_x
        
        g%EGID   => egid
        g%EGID_X => egid_x
        g%NGID   => ngid
        g%NGID_X => ngid_x
        
        
        
        IF(par) THEN
           ! MUST ALLOCATE SPACE AND CREATE GLOBAL INDEX FOR OUTPUT

           ALLOCATE(g%NV(g%NT,3), stat=status)
           IF(status /=0) CALL fatal_error("FVCOM2GRID: COULD NOT ALLOCATE G%NV")
           g%NV=0
           DO i = 1,g%NT
              g%NV(i,:) = g%NGID_X(nv(i,1:3))
           END DO
        

           ALLOCATE(g%NBE(0:n,3), stat=status)
           IF(status /=0) CALL fatal_error("FVCOM2GRID: COULD NOT ALLOCATE G%NBE")
           g%NBE = 0
           DO i = 1,n
              g%NBE(i,:) = g%EGID_X(nbe(i,:))
           END DO


           ALLOCATE(g%NBSN(0:m,mx_nbr_elem+3), stat=status)
           IF(status /=0) CALL fatal_error("FVCOM2GRID: COULD NOT ALLOCATE G%NBSN")
           g%NBSN = 0

           ALLOCATE(g%NBVE(0:m,mx_nbr_elem+1), stat=status)
           IF(status /=0) CALL fatal_error("FVCOM2GRID: COULD NOT ALLOCATE G%NBVE")
           g%NBVE = 0

           DO i = 1,m
              g%NBVE(i,:) = g%EGID_X(nbve(i,:))

              g%NBSN(i,:) = g%NGID_X(nbsn(i,:))
           END DO


        ELSE
           ! IF NOT PARALLEL JUST POINT TO FVCOM DATA FOR OUTPUT
           g%NV => nv
           
           g%NBE  => nbe
           g%NBVE => nbve
           g%NBSN => nbsn

        END IF

     END IF
     
     if(dbg_set(dbg_sbr)) &
          & write(ipt,*) "END SET_FVCOM_GRID"
    

Here is the call graph for this function:

Here is the caller graph for this function:

set_subdomain_grid()

subroutine mod_ncdio::set_subdomain_grid

(

type(grid)

G

)

Definition at line 4122 of file mod_ncdio.f90.

    ! THIS CODE SETS THE VALUES FOR NBE, NV, NBVE, NBSN

    IMPLICIT NONE
    TYPE(GRID) :: G
    LOGICAL :: TEST
    INTEGER :: I,J,STATUS
    INTEGER, POINTER :: INV_E(:),INV_N(:)

    if(dbg_set(dbg_sbr)) &
         & write(ipt,*) "START SET_SUBDOMAIN_GRID"


    IF(.NOT. ioproc) THEN
       
       ! CREATE THE INVERSE ARRAY FOR NLID_X 
       ALLOCATE(inv_n(0:mt));inv_n=0
       DO i=1,g%MT
          inv_n(g%NLID_X(i))=i
       END DO


       ALLOCATE(inv_e(0:nt));inv_e=0
       DO i=1,g%NT
          inv_e(g%ELID_X(i))=i
       END DO

       
       ! MAKE NV - CONNECTIVITY
       ALLOCATE(g%NV(g%NT,3), stat=status)
       IF(status /=0) CALL fatal_error("SET_SUBDOMAIN_GRID: COULD NOT ALLOCATE G%NV")
       
       ! CREAT THE GLOBAL INDEXED CONNECTIVITY ARRAY FOR THIS SUBDOMAIN
       DO i = 1,g%NT
          !       write(ipt,*) "NV(G%ELID_X(I),1:3)", NV(G%ELID_X(I),1:3)
          !       write(ipt,*) "INV(NV(G%ELID_X(I),1:3))" ,INV(NV(G%ELID_X(I),1:3))
          g%NV(i,:) = g%NGID_X(inv_n(nv(g%ELID_X(i),1:3)))
       END DO
       

       ! CREATE THE INVERSE ARRAY FOR NLID AND ELID


       ! MAKE NBE - ELEMENTS SURROUNDING EACH ELEMENT
       ALLOCATE(g%NBE(0:g%N,3), stat=status)
       IF(status /=0) CALL fatal_error("FVCOM2GRID: COULD NOT ALLOCATE G%NBE")
       g%NBE = 0
       DO i = 1,g%N
          g%NBE(i,:) = g%EGID_X(inv_e(nbe(g%ELID(i),:)))
       END DO
       

       ! MAKE NBSN AND NBVE
       ALLOCATE(g%NBSN(0:g%M,mx_nbr_elem+3), stat=status)
       IF(status /=0) CALL fatal_error("FVCOM2GRID: COULD NOT ALLOCATE G%NBSN")
       g%NBSN = 0
       
       ALLOCATE(g%NBVE(0:g%M,mx_nbr_elem+1), stat=status)
       IF(status /=0) CALL fatal_error("FVCOM2GRID: COULD NOT ALLOCATE G%NBVE")
       g%NBVE = 0
       
       DO i = 1,g%M
          g%NBVE(i,:) = g%EGID_X(inv_e(nbve(g%NLID(i),:)))
          
          g%NBSN(i,:) = g%NGID_X(inv_n(nbsn(g%NLID(i),:)))
       END DO
       
       
       DEALLOCATE(inv_n)
       DEALLOCATE(inv_e)
    

    END IF


    if(dbg_set(dbg_sbr)) &
         & write(ipt,*) "END SET_SUBDOMAIN_GRID"

Here is the call graph for this function:

setup_avgfile()

subroutine mod_ncdio::setup_avgfile

(

)

Definition at line 567 of file mod_ncdio.f90.

    IMPLICIT NONE
    character(len=80) :: tmp,dat_name
    TYPE(NCVAR),POINTER :: VAR
    TYPE(NCATT),POINTER :: ATT
    TYPE(NCDIM),POINTER :: DIM
    LOGICAL :: FOUND
    INTEGER :: NUMG, I
    TYPE(GRID), SAVE :: MYGRID
    TYPE(NCFILE), POINTER :: NCF,NCF_TMP
    LOGICAL :: INCLUDE_MASTER = .false.


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START SETUP_AVGFILE"

    !===================================================================
    ! MAKE A FILE TO HOLD POINTERS TO ALL VARIABLES THAT WILL BE AVERAGED
    !===================================================================

    IF(dbg_set(dbg_log)) THEN
       
       write(ipt,*)"!--------------------------------------------------"
       write(ipt,*)"! SETTING UP AVERAGE FILE OUTPUTS..."
    END IF

    CALL set_fvcom_grid(mygrid)

    CALL define_dimensions(mygrid)

    nc_avg_data => new_file()

    ncf_tmp => zeta_file_object()
    nc_avg_data => add(nc_avg_data,ncf_tmp)
!!$    NC_AVG_DATA => ADD(NC_AVG_DATA,ZETA_FILE_OBJECT() )

    ! NOW ADD THE OTHER DATA VARIABLES TO THE AVG FILE
    IF(ncav_velocity) THEN
       ncf_tmp => velocity_file_object()
       nc_avg_data => add(nc_avg_data,ncf_tmp)
!!$       NC_AVG_DATA => ADD(NC_AVG_DATA,VELOCITY_FILE_OBJECT() )
    END IF

    IF(ncav_vertical_vel) THEN
       ncf_tmp => vertical_vel_file_object()
       nc_avg_data => add(nc_avg_data,ncf_tmp)
!!$       NC_AVG_DATA => ADD(NC_AVG_DATA,VERTICAL_VEL_FILE_OBJECT() )
    END IF

    IF(ncav_average_vel) THEN
       ncf_tmp => average_vel_file_object()
       nc_avg_data => add(nc_avg_data,ncf_tmp)
!!$       NC_AVG_DATA => ADD(NC_AVG_DATA,AVERAGE_VEL_FILE_OBJECT() )
    END IF
    
    IF(ncav_vorticity) THEN
       ncf_tmp => vorticity_file_object()
       nc_avg_data => add(nc_avg_data,ncf_tmp)
!!$       NC_AVG_DATA => ADD(NC_AVG_DATA,VORTICITY_FILE_OBJECT() )
    END IF
    
    IF(ncav_salt_temp) THEN
       ncf_tmp => salt_temp_file_object()
       nc_avg_data => add(nc_avg_data,ncf_tmp)
!!$       NC_AVG_DATA => ADD(NC_AVG_DATA,SALT_TEMP_FILE_OBJECT() )
    END IF

    IF(ncav_turbulence) THEN
       ncf_tmp => turbulence_file_object()
       nc_avg_data => add(nc_avg_data,ncf_tmp)
!!$       NC_AVG_DATA => ADD(NC_AVG_DATA,TURBULENCE_FILE_OBJECT() )
    END IF

    IF (ncav_surface_heat .and. heating_on) THEN
       ncf_tmp => surface_heating_file_object()
       nc_avg_data => add(nc_avg_data,ncf_tmp)
 !!$      NC_AVG_DATA => ADD(NC_AVG_DATA,SURFACE_HEATING_FILE_OBJECT() )
    END IF

    IF (ncav_wind_vel) THEN
       ncf_tmp => wind_velocity_file_object()
       nc_avg_data => add(nc_avg_data,ncf_tmp)
!!$       NC_AVG_DATA => ADD(NC_AVG_DATA,WIND_VELOCITY_FILE_OBJECT() )
    END IF

    IF (ncav_wind_stress .and. wind_on) THEN
       ncf_tmp => wind_stress_file_object()
       nc_avg_data => add(nc_avg_data,ncf_tmp)
!!$       NC_AVG_DATA => ADD(NC_AVG_DATA,WIND_STRESS_FILE_OBJECT() )
    END IF


    IF (ncav_evap_precip .and. precipitation_on) THEN
       ncf_tmp => precipitation_file_object()
       nc_avg_data => add(nc_avg_data,ncf_tmp)
!!$       NC_AVG_DATA => ADD(NC_AVG_DATA,PRECIPITATION_FILE_OBJECT() )
    END IF

!    IF(WETTING_DRYING_ON) THEN
!       NC_AVG_DATA => ADD(NC_AVG_DATA, WET_DRY_FILE_OBJECT() )
!    END IF

!    IF(ICING_MODEL) THEN
!       NC_AVG_DATA => ADD(NC_AVG_DATA, ICING_FILE_OBJECT() )
!    END IF

    IF (groundwater_on .and. ncav_groundwater) THEN
       ncf_tmp => groundwater_file_object()
       nc_avg_data => add(nc_avg_data,ncf_tmp)
!!$       NC_AVG_DATA => ADD(NC_AVG_DATA,GROUNDWATER_FILE_OBJECT() )
    END IF






    


    !===================================================================
    ! MAKE A COPY OF THE DATA POINTER FILE TO IN WHICH TO DO THE SUM
    !===================================================================
    nc_avg_sum => copy_file(nc_avg_data)

    !===================================================================
    ! ALLOCATE ALL ITS DATA POINTERS TO MAKE THE EXTRA STORAGE
    !===================================================================
    CALL allocate_associated_vars(nc_avg_sum)


    CALL kill_dimensions

    

    !===================================================================
    ! NOW MAKE THE ACTUAL FILES WHICH ARE WRITTEN TO DISK
    !===================================================================

    ! Get the suffix from the NC_DAT file
    i = len_trim(nc_avg%FNAME)
    dat_name = nc_avg%FNAME(i-11:i)
    
    ! SETUP THE SUBDOMAIN FILES AND MAPS
    CALL setup_subdomains(ncav_subdomain_files,nc_avg_grids)

    numg = size(nc_avg_grids)
    
    ! FOR EACH SUBDOMAIN MAKE THE FILE
    DO i = 1, numg

       ! DEFINEN DIMENSIONS FOR THIS GRID
       CALL define_dimensions(nc_avg_grids(i))
       
       IF(nc_avg_grids(i)%NAME /="FVCOM") THEN
          ! MAKE NEW FILE OBJECT
          tmp = trim(nc_avg_grids(i)%NAME)//trim(dat_name)
          ncf => new_file(trim(tmp))
          
          ! SET THE CURRENT NAME IN THE GRID OBJECT
          nc_avg_grids(i)%NAME=ncf%FNAME

          ! SET THE FTIME OBJECT
          ncf%FTIME => new_ftime()
          ncf%FTIME = nc_avg%FTIME
          
          ! MAKE A TEMPORARY POINTER TO ADD THE FILE TO THE LIST
          ncf_tmp => ncf
          filehead => add(filehead,ncf_tmp)

       ELSE
          ! THIS IS THE AVERAGE FVCOM GRID FILE
          ncf => nc_avg
          nc_avg_grids(i)%NAME = nc_avg%FNAME
          
          include_master = .true.
       END IF



       ! ADD THE GRID STUFF THAT DOES NOT COME FROM THE AVERAGE DATA
       ncf_tmp => grid_file_object(nc_avg_grids(i))
       ncf => add(ncf,ncf_tmp)
!!$       NCF => ADD(NCF,GRID_FILE_OBJECT(NC_AVG_GRIDS(I)) )
       
       ncf_tmp => time_file_object()
       ncf => add(ncf,ncf_tmp)
!!$       NCF => ADD(NCF,TIME_FILE_OBJECT() )
       
       att => find_att(ncf,"title",found)
       att%CHR(1) = trim(case_title)//"; Average output file!"
       NULLIFY(att)
       
       IF(ncav_file_date) THEN
          ncf_tmp => file_date_object()
          ncf => add(ncf,ncf_tmp)
!!$          NCF => ADD(NCF,FILE_DATE_OBJECT() )
      END IF
    
       IF(ncav_grid_metrics) THEN
          ncf_tmp => grid_metrics_file_object(nc_avg_grids(i))
          ncf => add(ncf,ncf_tmp)
!!$          NCF => ADD(NCF,GRID_METRICS_FILE_OBJECT(NC_AVG_GRIDS(I)) )
       END IF


       ! MAKE A COPY OF THE FILE POINTER TO ADD TO THE ACTUAL FILE
       ! THIS COPY POINTS TO THE MEMORY WHICH CONTAINS THE SUM/AVERAGE
       ncf_tmp =>copy_file(nc_avg_sum)

       ! ADJUST THE NODE AND NELE DIMENSION OF THE COPIED FILE TO
       ! MATCH THE NEW FILE

       dim => find_dim(ncf_tmp,'node',found)
       IF(.not.found) CALL fatal_error&
            &("LOGICAL ERROR IN SETUP_AVGFILE: CAN'T FIND DIM NODE")
       dim%DIM = nc_avg_grids(i)%MGL

       dim => find_dim(ncf_tmp,'nele',found)
       IF(.not.found) CALL fatal_error&
            &("LOGICAL ERROR IN SETUP_AVGFILE: CAN'T FIND DIM NELE")
       dim%DIM = nc_avg_grids(i)%NGL


       ncf => add(ncf,ncf_tmp)

       
       IF (startup_type /= "crashrestart") THEN

          ! IF NOT CRASH RESTART - OVER RIDE THE STKCNT
          ncf%FTIME%NEXT_STKCNT = 0
          CALL nc_write_file(ncf)
          ncf%FTIME%NEXT_STKCNT = 1
          
       ELSE
          ncf%CONNECTED = .true.
          ncf%WRITABLE = .true.
       END IF
       
       CALL kill_dimensions


    END DO


    IF(.not. include_master) THEN

       CALL kill_file(nc_avg)
       nc_avg => find_file(filehead,nc_avg_grids(1)%NAME,found)

       IF(.NOT. found) CALL fatal_error&
            &("LOGICAL ERROR IN SETUP_AVGFILE")
    END IF


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END SETUP_AVGFILE"

Here is the call graph for this function:

Here is the caller graph for this function:

setup_datfile()

subroutine mod_ncdio::setup_datfile

(

)

Definition at line 370 of file mod_ncdio.f90.

    IMPLICIT NONE
    character(len=80) :: tmp,dat_name
    INTEGER :: NUMG, I

    TYPE(NCFILE), POINTER :: NCF,NCF_TMP,NCF2

    LOGICAL :: INCLUDE_MASTER = .false.

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START SETUP_DATAFILE"

    IF(dbg_set(dbg_log)) THEN
       
       write(ipt,*)"!--------------------------------------------------"
       write(ipt,*)"! SETTING UP DATA FILE OUTPUTS..."
    END IF


    ! Get the suffix from the NC_DAT file
    i = len_trim(nc_dat%FNAME)
    dat_name = nc_dat%FNAME(i-7:i)
    

    CALL setup_subdomains(nc_subdomain_files,nc_dat_grids)

    numg = size(nc_dat_grids)

    DO i = 1, numg

       ! DEFINEN DIMENSIONS FOR THIS GRID
       CALL define_dimensions(nc_dat_grids(i))
       
       IF(nc_dat_grids(i)%NAME /="FVCOM") THEN
          ! MAKE NEW FILE OBJECT
          tmp = trim(output_dir)//trim(nc_dat_grids(i)%NAME)//trim(dat_name)
          ncf => new_file(trim(tmp))
          
          ! SET THE CURRENT NAME IN THE GRID OBJECT
          nc_dat_grids(i)%NAME=ncf%FNAME

          ! SET THE FTIME OBJECT
          ncf%FTIME => new_ftime()
          ncf%FTIME = nc_dat%FTIME
          
          ! MAKE A TEMPORARY POINTER TO ADD THE FILE TO THE LIST
          ncf_tmp => ncf
          filehead => add(filehead,ncf_tmp)

       ELSE
          ! THIS IS THE FVCOM GRID FILE
          ncf => nc_dat
          nc_dat_grids(i)%NAME = nc_dat%FNAME
          include_master = .true.
       END IF




       ! ADD THE DATA OBJECTS
       ncf2 => grid_file_object(nc_dat_grids(i))
       ncf => add(ncf,ncf2)
!!$       NCF => ADD(NCF,GRID_FILE_OBJECT(NC_DAT_GRIDS(I)) )
       
       ncf2 => time_file_object()
       ncf => add(ncf,ncf2)
!!$       NCF => ADD(NCF,TIME_FILE_OBJECT() )
       
       ncf2 => zeta_file_object()
       ncf => add(ncf,ncf2)
!!$       NCF => ADD(NCF,ZETA_FILE_OBJECT() )
       
       IF(nc_file_date) THEN
          ncf2 => file_date_object()
          ncf => add(ncf,ncf2)
!!$          NCF => ADD(NCF,FILE_DATE_OBJECT() )
       END IF
       
       IF(nc_grid_metrics) THEN
          ncf2 => grid_metrics_file_object(nc_dat_grids(i))
          ncf => add(ncf,ncf2)
!!$          NCF => ADD(NCF,GRID_METRICS_FILE_OBJECT(NC_DAT_GRIDS(I)) )
       END IF
       
       IF(nc_velocity) THEN
          ncf2 => velocity_file_object()
          ncf => add(ncf,ncf2)
!!$          NCF => ADD(NCF,VELOCITY_FILE_OBJECT() )
       END IF
       
       IF(nc_vertical_vel) THEN
          ncf2 => vertical_vel_file_object()
          ncf => add(ncf,ncf2)
!!$          NCF => ADD(NCF,VERTICAL_VEL_FILE_OBJECT() )
       END IF
       
       IF(nc_average_vel) THEN
          ncf2 => average_vel_file_object()
          ncf => add(ncf,ncf2)
!!$          NCF => ADD(NCF,AVERAGE_VEL_FILE_OBJECT() )
       END IF
       
       IF(nc_vorticity) THEN
          ncf2 => vorticity_file_object()
          ncf => add(ncf,ncf2)
!!$          NCF => ADD(NCF,VORTICITY_FILE_OBJECT() )
       END IF
       
       IF(nc_salt_temp) THEN
          ncf2 => salt_temp_file_object()
          ncf => add(ncf,ncf2)
!!$          NCF => ADD(NCF,SALT_TEMP_FILE_OBJECT() )
       END IF
       
       IF(nc_turbulence) THEN
          ncf2 => turbulence_file_object()
          ncf => add(ncf,ncf2)
!!$          NCF => ADD(NCF,TURBULENCE_FILE_OBJECT() )
       END IF
       
       IF (nc_surface_heat .and. heating_on) THEN
          ncf2 => surface_heating_file_object()
          ncf => add(ncf,ncf2)
!!$          NCF => ADD(NCF,SURFACE_HEATING_FILE_OBJECT() )
       END IF
       
       IF (nc_wind_vel) THEN
          ncf2 => wind_velocity_file_object()
          ncf => add(ncf,ncf2)
!!$          NCF => ADD(NCF,WIND_VELOCITY_FILE_OBJECT() )
       END IF
       
       IF (nc_wind_stress .and. wind_on) THEN
          ncf2 => wind_stress_file_object()
          ncf => add(ncf,ncf2)
!!$          NCF => ADD(NCF,WIND_STRESS_FILE_OBJECT() )
       END IF

       
       IF (nc_evap_precip .and. precipitation_on) THEN
          ncf2 => precipitation_file_object()
          ncf => add(ncf,ncf2)
!!$          NCF => ADD(NCF,PRECIPITATION_FILE_OBJECT() )
       END IF
       
       IF(wetting_drying_on) THEN
          ncf2 => wet_dry_file_object()
          ncf => add(ncf, ncf2)
!!$          NCF => ADD(NCF, WET_DRY_FILE_OBJECT() )
       END IF
       
       IF(icing_model) THEN
          ncf2 => icing_file_object()
          ncf => add(ncf, ncf2)
!!$          NCF => ADD(NCF, ICING_FILE_OBJECT() )
       END IF
       
       IF (groundwater_on .and. nc_groundwater) THEN
          ncf2 => groundwater_file_object()
          ncf => add(ncf,ncf2)
!!$          NCF => ADD(NCF,GROUNDWATER_FILE_OBJECT() )
       END IF
       
       
       



       
       
       IF (startup_type /= "crashrestart") THEN

          ! IF CRASH RESTART - OVER RIDE THE STKCNT
          ncf%FTIME%NEXT_STKCNT = 0
          CALL nc_write_file(ncf)
          ncf%FTIME%NEXT_STKCNT = 1
          
       ELSE
          ncf%CONNECTED = .true.
          ncf%WRITABLE = .true.
       END IF


       CALL kill_dimensions
    END DO

    IF(.not. include_master) THEN

       CALL kill_file(nc_dat)
       nc_dat => find_file(filehead,nc_dat_grids(1)%NAME,found)

       IF(.NOT. found) CALL fatal_error&
            &("LOGICAL ERROR IN SETUP_DATFILE")
    END IF

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END SETUP_DATAFILE"

Here is the call graph for this function:

Here is the caller graph for this function:

setup_mpi_io_mode()

subroutine mod_ncdio::setup_mpi_io_mode	(	logical, intent(inout)	TF,
		integer, intent(out)	COMMGRP
	)

Definition at line 4207 of file mod_ncdio.f90.

    !===================================================================================|
    !  INITIALIZE MPI ENVIRONMENT                                                       |
    !===================================================================================|
    LOGICAL, INTENT(INOUT) :: TF
    INTEGER, INTENT(OUT)   :: COMMGRP
    INTEGER :: total_group  
    INTEGER :: fvcom_group
    INTEGER :: SBUF,RBUF, trueval, i
    INTEGER, allocatable :: fvcom_subset(:)
    INTEGER IERR


    if(dbg_set(dbg_sbr)) &
         & write(ipt,*) "STARTING SETUP_MPI_IO_MODE"


    if (nprocs .LE. 3) THEN
       if (tf) &
            & CALL warning("FVCOM CAN NOT USE MPI IO MODE WHEN RUN &
            &ON LESS THAN 4 PROCESSORS", "CONTINUING WITHOUT THIS OPTION!")
       tf = .false.
    end if

    IF (tf) THEN


    ELSE 

       ! MUST SET INTENT(OUT) COMMGRP
       ! IF NOT MULTIPROCESSOR SET A DUMMY VALUE
       commgrp = -999



       IF (dbg_set(dbg_log)) &
            & write(ipt,*) "!  MPI IO MODE IS NOT ACTIVE"

    END IF

    if(dbg_set(dbg_sbr)) &
         & write(ipt,*) "END SETUP_MPI_IO_MODE"

Here is the call graph for this function:

Here is the caller graph for this function:

setup_rstfile()

subroutine mod_ncdio::setup_rstfile

(

)

Definition at line 963 of file mod_ncdio.f90.

    IMPLICIT NONE
    
    TYPE(GRID), SAVE :: MYGRID
    TYPE(NCFILE), POINTER ::NC_RST2

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START SETUP_RSTFILE"

    IF(dbg_set(dbg_log)) THEN
       
       write(ipt,*)"!--------------------------------------------------"
       write(ipt,*)"! SETTING UP RESTART FILE OUTPUT..."
    END IF

    CALL set_fvcom_grid(mygrid)

    CALL define_dimensions(mygrid)

    nc_rst2 => grid_file_object(mygrid)
    nc_rst => add(nc_rst,nc_rst2)
!!$    NC_RST => ADD(NC_RST,GRID_FILE_OBJECT(MYGRID) )

    nc_rst2 => time_file_object()
    nc_rst => add(nc_rst,nc_rst2)
!!$    NC_RST => ADD(NC_RST,TIME_FILE_OBJECT() )

    nc_rst2 => zeta_file_object()
    nc_rst => add(nc_rst,nc_rst2)
!!$    NC_RST => ADD(NC_RST,ZETA_FILE_OBJECT() )

    nc_rst2 => file_date_object()
    nc_rst => add(nc_rst,nc_rst2)
!!$    NC_RST => ADD(NC_RST,FILE_DATE_OBJECT() )

    nc_rst2 => velocity_file_object()
    nc_rst => add(nc_rst,nc_rst2)
!!$    NC_RST => ADD(NC_RST,VELOCITY_FILE_OBJECT() )

    nc_rst2 => average_vel_file_object()
    nc_rst => add(nc_rst,nc_rst2)
!!$    NC_RST => ADD(NC_RST,AVERAGE_VEL_FILE_OBJECT() )

    nc_rst2 => vertical_vel_file_object()
    nc_rst => add(nc_rst,nc_rst2)
!!$    NC_RST => ADD(NC_RST,VERTICAL_VEL_FILE_OBJECT() )

    nc_rst2 => turbulence_file_object()
    nc_rst => add(nc_rst,nc_rst2)
!!$    NC_RST => ADD(NC_RST,TURBULENCE_FILE_OBJECT() )
    
    nc_rst2 => salt_temp_file_object()
    nc_rst => add(nc_rst,nc_rst2)
!!$    NC_RST => ADD(NC_RST,SALT_TEMP_FILE_OBJECT() )

    nc_rst2 => restart_extras_file_object()
    nc_rst => add(nc_rst,nc_rst2)
!!$    NC_RST => ADD(NC_RST,RESTART_EXTRAS_FILE_OBJECT() )
    
    nc_rst2 => density_file_object()
    nc_rst => add(nc_rst,nc_rst2)
!!$    NC_RST => ADD(NC_RST,DENSITY_FILE_OBJECT() )

    IF(wetting_drying_on) THEN
       nc_rst2 => wet_dry_file_object()
       nc_rst => add(nc_rst, nc_rst2)
!!$       NC_RST => ADD(NC_RST, WET_DRY_FILE_OBJECT() )
    END IF








    IF (startup_type /= "crashrestart") THEN
       CALL nc_write_file(nc_rst)
       nc_rst%FTIME%NEXT_STKCNT = 1
    ELSE
       nc_rst%CONNECTED = .true.
    END IF

    CALL kill_dimensions

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END SETUP_RSTFILE"

Here is the call graph for this function:

Here is the caller graph for this function:

setup_subdomains()

subroutine mod_ncdio::setup_subdomains	(	character(len=*)	SUB_FILES,
		type(grid), dimension(:), pointer	GRIDS
	)

Definition at line 3963 of file mod_ncdio.f90.

  IMPLICIT NONE
  TYPE(NCFILE), POINTER :: NCF
  TYPE(GRID), POINTER :: GRIDS(:)
  CHARACTER(LEN=*) :: SUB_FILES
  CHARACTER(LEN=80),ALLOCATABLE :: FNAMES(:)
  CHARACTER(LEN=80) :: FILE,PATH,EXT
  INTEGER :: NUMF,I, STATUS

  INTEGER, POINTER:: NID(:),EID(:)

  if(dbg_set(dbg_sbr))  write(ipt,*) "START Setup_subdomains"



  IF(serial .and. sub_files /= "FVCOM") THEN 
     CALL warning&
          &("SETUP_SUBDOMAIN: YOU CAN NOT USE SUBDOMAIN OUTPUT DURING A SINGLE PROCESSOR MODLE RUN!")
     sub_files = "FVCOM"
  ELSEIF(len_trim(sub_files) == 0 ) THEN
     CALL fatal_error("THE SUBDOMAIN FILE LIST PASSED TO SETUP_SUBDOMAINS IS EMPTY",&
          &"PLEASE CHECK YOUR NAME LIST FILE FOR THE NC_SUBDOMAIN_FILES",&
          &"AND NCAV_SUBDOMAIN_FILES ENTRIES!")
     
  END IF



  CALL split_string(sub_files,",",fnames)
  numf =SIZE(fnames)

  
  if(dbg_set(dbg_log))  write(ipt,*) "! NUMBER OF DOMAINS TO OUTPUT:",numf
  ALLOCATE(grids(numf),stat=status)
  IF(status /=0) CALL fatal_error("NCDIO: COULD NOT ALLOCATE SUBDOMAIN GRIDS!")


  if(dbg_set(dbg_log))  write(ipt,*) "! SETTING FVCOM DOMAIN OUTPUT"
  if(dbg_set(dbg_log))  write(ipt,*) "! DIMENSIONS: MGL =",mgl
  if(dbg_set(dbg_log))  write(ipt,*) "! DIMENSIONS: NGL =",ngl
  
  CALL set_fvcom_grid(grids(1))

Here is the call graph for this function:

Here is the caller graph for this function:

surface_heating_file_object()

type(ncfile) function, pointer mod_ncdio::surface_heating_file_object

(

)

Definition at line 2776 of file mod_ncdio.f90.

    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    character(len=100)    :: timestamp, temp, netcdf_convention

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START SURFACE_HEATING_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(swrad_watts(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:SWRAD")
       swrad_watts = 0.0_sp

       allocate(wtsurf_watts(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:WTSURF")
       wtsurf_watts = 0.0_sp

    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! SWRAD
    var  => nc_make_avar(name='short_wave',&
         & values=swrad_watts, dim1= dim_node, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Short Wave Radiation') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='W m-2') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

!!$    ATT  => NC_MAKE_ATT(name='coordinates',values=CoordVar) 
    att  => nc_make_att(name='coordinates',values='time lat lon') 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    att  => nc_make_att(name='mesh',values='fvcom_mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='location',values='node') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! WTSURF - NET HEAT FLUX
    var  => nc_make_avar(name='net_heat_flux',&
         & values=wtsurf_watts, dim1= dim_node, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Surface Net Heat Flux') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='W m-2') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

!!$    ATT  => NC_MAKE_ATT(name='coordinates',values=CoordVar) 
    att  => nc_make_att(name='coordinates',values='time lat lon') 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    att  => nc_make_att(name='mesh',values='fvcom_mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='location',values='node') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END SURFACE_HEATING_FILE_OBJECT"

Here is the call graph for this function:

Here is the caller graph for this function:

time_file_object()

type(ncfile) function, pointer mod_ncdio::time_file_object

(

)

Definition at line 3843 of file mod_ncdio.f90.

   IMPLICIT NONE

   INTEGER :: status
   TYPE(NCFILE), POINTER :: NCF
   TYPE(NCVAR),  POINTER :: VAR
   TYPE(NCATT),  POINTER :: ATT
   INTEGER :: II

   IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START TIME_OBJECT"

  ! ALLOCATE THE NEW FILE OBJECT
   ncf => new_file()

   ! IINT
   var  => iint_object(dim=dim_time)
   
   ncf  => add(ncf,var)
   
   ! time
   var => float_time_object &
        &(use_mjd=use_real_world_time, &
        & dim=dim_time)
   
   ncf  => add(ncf,var)
   
   
   ! Itime
   var  => itime_object &
        &(use_mjd=use_real_world_time, &
        & dim=dim_time)
   
   ncf  => add(ncf,var)
   
   ! Itime2
   var => itime2_object &
        &(use_mjd=use_real_world_time, &
        & dim=dim_time)
   
   ncf => add(ncf,var)
   
   IF (use_real_world_time) THEN
      
      var => datetime_object &
           &(dimstr=dim_datestrlen,&
           & dimtime=dim_time,&
           timezone=timezone)
      
      ncf  => add(ncf,var)
   END IF

   IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END TIME_OBJECT"

Here is the call graph for this function:

Here is the caller graph for this function:

turbulence_file_object()

type(ncfile) function, pointer mod_ncdio::turbulence_file_object

(

)

Definition at line 2539 of file mod_ncdio.f90.

    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT
    TYPE(NCDIM),  POINTER :: DIM1
    TYPE(NCDIM),  POINTER :: DIM2
    TYPE(NCDIM),  POINTER :: DIM3

    character(len=100)    :: timestamp, temp, netcdf_convention

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START TURBULENCE_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(viscofm(ngl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:VISCOFM")
       viscofm = 0.0_sp

       allocate(viscofh(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:VISCOFH")
       viscofh = 0.0_sp
       
       allocate(km(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:KM")
       km = 0.0_sp

       allocate(kh(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:KH")
       kh = 0.0_sp

       allocate(kq(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:KQ")
       kq = 0.0_sp
       
       allocate(q2(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:Q2")
       q2 = 0.0_sp

       allocate(q2l(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:Q2L")
       q2l = 0.0_sp
       
       allocate(l(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:L")
       l = 0.0_sp


    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! VISCOFM
    var  => nc_make_avar(name='viscofm',&
         & values=viscofm, dim1= dim_nele, dim2= dim_siglay, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='Horizontal Turbulent Eddy Viscosity For Momentum') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m 2 s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values=coordvar) 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! VISCOFH
    var  => nc_make_avar(name='viscofh',&
         & values=viscofh, dim1= dim_node, dim2= dim_siglay, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='Horizontal Turbulent Eddy Viscosity For Scalars') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m 2 s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values=coordvar) 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! KM
    var  => nc_make_avar(name='km',&
         & values=km, dim1= dim_node, dim2= dim_siglev, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='Turbulent Eddy Viscosity For Momentum') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m 2 s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values=coordvar) 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! KH
    var  => nc_make_avar(name='kh',&
         & values=kh, dim1= dim_node, dim2= dim_siglev, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='Turbulent Eddy Viscosity For Scalars') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m 2 s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values=coordvar) 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! KQ
    var  => nc_make_avar(name='kq',&
         & values=kq, dim1= dim_node, dim2= dim_siglev, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='Turbulent Eddy Viscosity For Q2/Q2L') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m 2 s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values=coordvar) 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! Q2
    var  => nc_make_avar(name='q2',&
         & values=q2, dim1= dim_node, dim2= dim_siglev, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='Turbulent Kinetic Energy') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m2 s-2') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values=coordvar) 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! Q2L
    var  => nc_make_avar(name='q2l',&
         & values=q2l, dim1= dim_node, dim2= dim_siglev, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='Turbulent Kinetic Ene&
         &rgy X Turbulent Macroscale') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m3 s-2') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values=coordvar) 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! L
    var  => nc_make_avar(name='l',&
         & values=l, dim1= dim_node, dim2= dim_siglev, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='Turbulent Macroscale') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='m3 s-2') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values=coordvar) 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END TURBULENCE_FILE_OBJECT"

Here is the call graph for this function:

Here is the caller graph for this function:

update_iodata()

subroutine mod_ncdio::update_iodata	(	type(ncfile), pointer	NCF,
		type(time), intent(in)	NOW
	)

Definition at line 3913 of file mod_ncdio.f90.

  IMPLICIT NONE
  TYPE(TIME), INTENT(IN) :: NOW
  TYPE(NCVAR), POINTER :: VAR1,VAR2
  TYPE(NCFILE), POINTER :: NCF
  LOGICAL :: FOUND
!====================================================================
! THIS SUBROUTINE IS IN CHARGE OF UPDATING ANY VARIABLES FOR IO WHICH
! ARE NOT ALREADY UPDATED BY FVCOM DURING THE MAIN LOOP:
!====================================================================
  IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START UPDATE_IODATA"
  
  if(.not. Associated(ncf)) CALL fatal_error&
       &("UPDATE_IODATA: THE FILE OBJECT IS NOT ASSOCIATED!")
  
  var1 => find_var(ncf,"time",found)
  IF(found) CALL update_float_time(var1,now)

  var1 => find_var(ncf,"Itime",found)
  IF(found) THEN
     var2 => find_var(ncf,"Itime2",found)
     IF (.NOT.found) THEN
        CALL warning&
             & ("FOUND ONLY PART OF INTEGER TIME VARIABLE IN OUT PUT FILE!")
     ELSE
        CALL update_itime(var1,var2,now)
     END IF
  END IF

  var1 => find_var(ncf,"Times",found)
  IF(found) CALL update_datetime(var1,now)


  ! IINT IS A LONG LONG INTEGER BUT WE CAN'T WRITE LONG INTEGERS...
  var1 => find_var(ncf,"iint",found)
  IF(found) var1%scl_int = iint

  var1 => find_var(ncf,"file_date",found)
  IF(found) CALL update_datetime(var1,get_now())

  IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END UPDATE_IODATA"

Here is the call graph for this function:

Here is the caller graph for this function:

velocity_file_object()

type(ncfile) function, pointer mod_ncdio::velocity_file_object

(

)

Definition at line 2003 of file mod_ncdio.f90.

    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    character(len=100)    :: timestamp, temp, netcdf_convention

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START VELOCITY_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(u(ngl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:U")
       u = 0.0_sp

       allocate(v(ngl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:V")
       v = 0.0_sp

       allocate(taubm(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:WUBOT")
       taubm   = 0.0_sp

    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! U
    var  => nc_make_avar(name='u',&
         & values=u, dim1= dim_nele, dim2= dim_siglay, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='Eastward Water Velocity') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='eastward_sea_water_velocity') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='meters s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values='time siglay latc lonc') 
    var  => add(var,att)

    att  => nc_make_att(name='mesh',values='fvcom_mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='location',values='face') 
    var  => add(var,att)

    ncf  => add(ncf,var)



    ! V
    var  => nc_make_avar(name='v',&
         & values=v, dim1= dim_nele, dim2= dim_siglay, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='Northward Water Velocity') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='Northward_sea_water_velocity') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='meters s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values='time siglay latc lonc') 
    var  => add(var,att)

    att  => nc_make_att(name='mesh',values='fvcom_mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='location',values='face') 
    var  => add(var,att)

    ncf  => add(ncf,var)

  var  => nc_make_avar(name='tauc',&
       & values=taubm, dim1= dim_nele, dim2= dim_time)

  att  => nc_make_att(name='long_name',values='bed stress magnitude from currents')
  var  => add(var,att)

  att  => nc_make_att(name='note1',values='this stress is bottom boundary condtion on velocity field')
  var  => add(var,att)

  att  => nc_make_att(name='note2',values='dimensions are stress/rho')
  var  => add(var,att)

  att  => nc_make_att(name='units',values='m^2 s^-2')
  var  => add(var,att)

  att  => nc_make_att(name='grid',values='fvcom_grid')
  var  => add(var,att)

  att  => nc_make_att(name='type',values='data')
  var  => add(var,att)

  att  => nc_make_att(name='coordinates',values='time latc lonc')
  var  => add(var,att)
  
  att  => nc_make_att(name='mesh',values='fvcom_mesh')
  var  => add(var,att)

  att  => nc_make_att(name='location',values='face') 
  var  => add(var,att)

  ncf  => add(ncf,var)


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END VELOCITY_FILE_OBJECT"

Here is the call graph for this function:

Here is the caller graph for this function:

vertical_vel_file_object()

type(ncfile) function, pointer mod_ncdio::vertical_vel_file_object

(

)

Definition at line 2272 of file mod_ncdio.f90.

    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    character(len=100)    :: timestamp, temp, netcdf_convention

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START VERTICAL_VEL_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(ww(ngl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:WW")
       ww = 0.0_sp

       allocate(wts(mgl,kb),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:WTS")
       wts = 0.0_sp

    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! WTS
    var  => nc_make_avar(name='omega',&
         & values=wts, dim1= dim_node, dim2= dim_siglev, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='Vertical Sigma Coordinate Velocity') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)



    ! WW
    var  => nc_make_avar(name='ww',&
         & values=ww, dim1= dim_nele, dim2= dim_siglay, dim3 = dim_time)

    att  => nc_make_att(name='long_name',values='Upward Water Velocity') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='meters s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END VERTICAL_VEL_FILE_OBJECT"

Here is the call graph for this function:

Here is the caller graph for this function:

vorticity_file_object()

type(ncfile) function, pointer mod_ncdio::vorticity_file_object

(

)

Definition at line 2141 of file mod_ncdio.f90.

    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START VORTIICTY_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(vort(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:VORT")
       vort = 0.0_sp

    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! VORTICITY
    var  => nc_make_avar(name='vorticity',&
         & values=vort, dim1= dim_node, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Ertels 2d potential vorticity') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)



    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END VORTICITY_FILE_OBJECT"

Here is the call graph for this function:

Here is the caller graph for this function:

wet_dry_file_object()

type(ncfile) function, pointer mod_ncdio::wet_dry_file_object

(

)

Definition at line 3420 of file mod_ncdio.f90.

    USE mod_wd
    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    character(len=100)    :: timestamp, temp, netcdf_convention

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START WET_DRY_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(iswetn(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:ISWETN")
       iswetn = 0

       allocate(iswetc(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:ISWETC")
       iswetc = 0 

       allocate(iswetnt(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:ISWETNT")
       iswetn = 0

       allocate(iswetct(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:ISWETCT")
       iswetct = 0 

       allocate(iswetce(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:ISWETCE")
       iswetce = 0


    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! WET NODES
    var  => nc_make_avar(name='wet_nodes',&
         & values=iswetn, dim1= dim_node, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Wet_Nodes') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values='time lat lon') 
    var  => add(var,att)
    
    att  => nc_make_att(name='mesh',values='fvcom_mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='location',values='node') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! WET CELLS
    var  => nc_make_avar(name='wet_cells',&
         & values=iswetc, dim1= dim_nele, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Wet_Cells') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values='time latc lonc') 
    var  => add(var,att)
    
    att  => nc_make_att(name='mesh',values='fvcom_mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='location',values='face') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! WET NODES AT LAST INT STEP
    var  => nc_make_avar(name='wet_nodes_prev_int',&
         & values=iswetnt, dim1= dim_node, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Wet_Nodes_At_Previous_Internal_Step') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values='time lat lon') 
    var  => add(var,att)
    
    att  => nc_make_att(name='mesh',values='fvcom_mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='location',values='node') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! WET CELLS AT LAST EXT STEP
    var  => nc_make_avar(name='wet_cells_prev_int',&
         & values=iswetct, dim1= dim_nele, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Wet_Cells_At_Previous_Internal_Step') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values='time latc lonc') 
    var  => add(var,att)
    
    att  => nc_make_att(name='mesh',values='fvcom_mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='location',values='face') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! WET CELLS AT LAST EXT STEP
    var  => nc_make_avar(name='wet_cells_prev_ext',&
         & values=iswetce, dim1= dim_nele, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Wet_Cells_At_Previous_External_Step') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END WET_DRY_FILE_OBJECT"
    

Here is the call graph for this function:

Here is the caller graph for this function:

wind_stress_file_object()

type(ncfile) function, pointer mod_ncdio::wind_stress_file_object

(

)

Definition at line 2972 of file mod_ncdio.f90.

    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    character(len=100)    :: timestamp, temp, netcdf_convention

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START WIND_STRESS_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(wusurf_save(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:WUSURF")
       wusurf_save = 0.0_sp

       allocate(wvsurf_save(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:WVSURF")
       wvsurf_save = 0.0_sp

    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! UUWIND
    var  => nc_make_avar(name='uwind_stress',&
         & values=wusurf_save, dim1= dim_nele, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Eastward Wind Stress') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='Wind Stress') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='Pa') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! VVWIND
    var  => nc_make_avar(name='vwind_stress',&
         & values=wvsurf_save, dim1= dim_nele, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Northward Wind Stress') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='Wind Stress') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='Pa') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    ncf  => add(ncf,var)


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END WIND_STRESS_FILE_OBJECT"
    

Here is the call graph for this function:

Here is the caller graph for this function:

wind_velocity_file_object()

type(ncfile) function, pointer mod_ncdio::wind_velocity_file_object

(

)

Definition at line 2871 of file mod_ncdio.f90.

    IMPLICIT NONE

    INTEGER :: status
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT

    character(len=100)    :: timestamp, temp, netcdf_convention

    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START WIND_VELOCITY_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(uuwind(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:UUWIND")
       uuwind = 0.0_sp

       allocate(vvwind(ngl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:VVWIND")
       vvwind = 0.0_sp

    END IF


  ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()


    ! UUWIND
    var  => nc_make_avar(name='uwind_speed',&
         & values=uuwind, dim1= dim_nele, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Eastward Wind Velocity') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='eastward wind') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='meters s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values='time latc lonc') 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    att  => nc_make_att(name='mesh',values='fvcom_mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='location',values='face') 
    var  => add(var,att)

    ncf  => add(ncf,var)

    ! VVWIND
    var  => nc_make_avar(name='vwind_speed',&
         & values=vvwind, dim1= dim_nele, dim2= dim_time)

    att  => nc_make_att(name='long_name',values='Northward Wind Velocity') 
    var  => add(var,att)

    att  => nc_make_att(name='standard_name',values='northward wind') 
    var  => add(var,att)

    att  => nc_make_att(name='units',values='meters s-1') 
    var  => add(var,att)

    att  => nc_make_att(name='grid',values='fvcom_grid') 
    var  => add(var,att)

    att  => nc_make_att(name='coordinates',values='time latc lonc') 
    var  => add(var,att)
    
    att  => nc_make_att(name='type',values='data') 
    var  => add(var,att)

    att  => nc_make_att(name='mesh',values='fvcom_mesh') 
    var  => add(var,att)

    att  => nc_make_att(name='location',values='face') 
    var  => add(var,att)

    ncf  => add(ncf,var)


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END WIND_VELOCITY_FILE_OBJECT"
    

Here is the call graph for this function:

Here is the caller graph for this function:

zero_average()

subroutine mod_ncdio::zero_average

(

)

Definition at line 920 of file mod_ncdio.f90.

    IMPLICIT NONE      
    TYPE(NCVARP),POINTER :: CURRENT
    TYPE(NCVAR),POINTER :: VAR
    REAL(DP) :: avg_steps

    avg_steps = seconds(nc_avg%FTIME%INTERVAL)/seconds(imdti)

    current => nc_avg_sum%VARS%NEXT

    DO
       IF(.NOT. ASSOCIATED(current)) THEN
          EXIT ! END OF VAR LIST
       END IF

       IF(.NOT. ASSOCIATED(current%VAR)) THEN
          CALL fatal_error("ALLOCATE_ASSOCIATED_VARS: FOUND NULL VAR POINTER IN THE LIST")
       END IF

       var => current%VAR


       IF(Associated(var%SCL_INT)) var%SCL_INT=0
       IF(Associated(var%VEC_INT)) var%VEC_INT=0
       IF(Associated(var%ARR_INT)) var%ARR_INT=0
       IF(Associated(var%CUB_INT)) var%CUB_INT=0
       
       IF(Associated(var%SCL_FLT)) var%SCL_FLT=0.0_spa
       IF(Associated(var%VEC_FLT)) var%VEC_FLT=0.0_spa
       IF(Associated(var%ARR_FLT)) var%ARR_FLT=0.0_spa
       IF(Associated(var%CUB_FLT)) var%CUB_FLT=0.0_spa
       
       IF(Associated(var%SCL_DBL)) var%SCL_DBL=0.0_dp
       IF(Associated(var%VEC_DBL)) var%VEC_DBL=0.0_dp
       IF(Associated(var%ARR_DBL)) var%ARR_DBL=0.0_dp
       IF(Associated(var%CUB_DBL)) var%CUB_DBL=0.0_dp


       current => current%NEXT
    END DO
 

Here is the call graph for this function:

Here is the caller graph for this function:

zeta_file_object()

type(ncfile) function, pointer mod_ncdio::zeta_file_object

(

)

Definition at line 1666 of file mod_ncdio.f90.

    IMPLICIT NONE
    
    INTEGER :: status, I
    LOGICAL, SAVE :: IOPROC_ALLOCATED = .false.
    TYPE(NCFILE), POINTER :: NCF
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCATT),  POINTER :: ATT
    
    
    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "START ZETA_FILE_OBJECT"
    
    ! IO PROC MUST ALLOCATE SPACE FOR THE ARRAYS 
    ! THESE ARRAYS MUST HAVE THE ATTRIBUTE SAVE AND FOR CLARITY
    ! SHOULD HAVE THE SAME NAME AS THOSE USED ON THE OTHER PROCESSORS!
    IF(ioproc .AND. .NOT. ioproc_allocated) THEN

       ioproc_allocated = .true.

       allocate(el(mgl),stat=status)
       IF (status /=0 ) CALL fatal_error("COULD NOT ALLOCATE MEMORY ON IO PROC FOR OUTPUT DATA:EL")
       el = 0.0_sp


    END IF

    ! ALLOCATE THE NEW FILE OBJECT
    ncf => new_file()

  
    IF (ALLOCATED(el)) THEN
       ! zeta
       var  => nc_make_avar(name='zeta',&
            & values=el, dim1= dim_node, dim2= dim_time)

       att  => nc_make_att(name='long_name',values='Water Surface Elevation') 
       var  => add(var,att)
       
       att  => nc_make_att(name='units',values='meters') 
       var  => add(var,att)
       
       att  => nc_make_att(name='positive',values='up') 
       var  => add(var,att)
       
       att  => nc_make_att(name='standard_name',values='sea_surface_height_above_geoid') 
       var  => add(var,att)
              
       att  => nc_make_att(name='grid',values='Bathymetry_Mesh') 
       var  => add(var,att)

!!$       ATT  => NC_MAKE_ATT(name='coordinates',values=CoordVar) 
       att  => nc_make_att(name='coordinates',values="time lat lon") 
       var  => add(var,att)

       att  => nc_make_att(name='type',values='data') 
       var  => add(var,att)

       att  => nc_make_att(name='location',values='node') 
       var  => add(var,att)
       
       ncf  => add(ncf,var)
    END IF


    IF(dbg_set(dbg_sbr)) WRITE(ipt,*) "END ZETA_FILE_OBJECT"

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

coordvar

character(len=50) mod_ncdio::coordvar

Definition at line 109 of file mod_ncdio.f90.

  Character(LEN=50) :: CoordVar 

dim_datestrlen

type(ncdim), pointer mod_ncdio::dim_datestrlen

Definition at line 124 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_DateStrLen

dim_four

type(ncdim), pointer mod_ncdio::dim_four

Definition at line 117 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_four

dim_grid

type(ncdim), pointer mod_ncdio::dim_grid

Definition at line 132 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_GRID

dim_maxelem

type(ncdim), pointer mod_ncdio::dim_maxelem

Definition at line 130 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_MaxElem

dim_maxnode

type(ncdim), pointer mod_ncdio::dim_maxnode

Definition at line 129 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_MaxNode

dim_ncat

type(ncdim), pointer mod_ncdio::dim_ncat

Definition at line 133 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_NCAT

dim_nele

type(ncdim), pointer mod_ncdio::dim_nele

Definition at line 114 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_nele

dim_nlsf

type(ncdim), pointer mod_ncdio::dim_nlsf

Definition at line 127 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_nlsf

dim_nobc

type(ncdim), pointer mod_ncdio::dim_nobc

Definition at line 126 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_nobc

dim_node

type(ncdim), pointer mod_ncdio::dim_node

Definition at line 115 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_node

dim_ntilay

type(ncdim), pointer mod_ncdio::dim_ntilay

Definition at line 134 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_ntilay

dim_siglay

type(ncdim), pointer mod_ncdio::dim_siglay

Definition at line 119 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_siglay

dim_siglev

type(ncdim), pointer mod_ncdio::dim_siglev

Definition at line 120 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_siglev

dim_three

type(ncdim), pointer mod_ncdio::dim_three

Definition at line 116 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_three

dim_time

type(ncdim), pointer mod_ncdio::dim_time

Definition at line 123 of file mod_ncdio.f90.

  TYPE(NCDIM), POINTER :: DIM_time

nc_avg_data

type(ncfile), pointer mod_ncdio::nc_avg_data

Definition at line 138 of file mod_ncdio.f90.

  TYPE(NCFILE), POINTER :: NC_AVG_DATA

nc_avg_grids

type(grid), dimension(:), pointer mod_ncdio::nc_avg_grids

Definition at line 145 of file mod_ncdio.f90.

  TYPE(GRID), POINTER :: NC_AVG_GRIDS(:)

nc_avg_sum

type(ncfile), pointer mod_ncdio::nc_avg_sum

Definition at line 139 of file mod_ncdio.f90.

  TYPE(NCFILE), POINTER :: NC_AVG_SUM

nc_dat_grids

type(grid), dimension(:), pointer mod_ncdio::nc_dat_grids

Definition at line 143 of file mod_ncdio.f90.

  TYPE(GRID), POINTER :: NC_DAT_GRIDS(:)

ncnest_cmd_dump

logical mod_ncdio::ncnest_cmd_dump

Definition at line 106 of file mod_ncdio.f90.

  LOGICAL :: NCNEST_CMD_DUMP

visit_cmd_dump

logical mod_ncdio::visit_cmd_dump

Definition at line 105 of file mod_ncdio.f90.

  LOGICAL :: VISIT_CMD_DUMP