mod_ncll::add Interface Reference

Public Member Functions
type(ncvar) function, pointer	var_plus_dim (VAR, DIM)
type(ncvar) function, pointer	var_plus_att (VAR, ATT)
type(ncfile) function, pointer	ncf_plus_var (NCF, VAR)
type(ncfile) function, pointer	ncf_plus_att (NCF, ATT)
type(ncfile) function, pointer	ncf_plus_dim (NCF, DIM)
type(ncfile) function, pointer	ncf_plus_ncf (NCF1, NCF2)
type(ncfilelist) function, pointer	ncflist_plus_ncf (NCFLIST, NCF)

Detailed Description

Definition at line 341 of file mod_ncll.f90.

Member Function/Subroutine Documentation

ncf_plus_att()

type(ncfile) function, pointer mod_ncll::add::ncf_plus_att	(	type(ncfile), pointer	NCF,
		type(ncatt), pointer	ATT
	)

Definition at line 3732 of file mod_ncll.f90.

    IMPLICIT NONE
    type(NCATT),  POINTER       :: ATT
    type(NCFILE), POINTER       :: RET
    type(NCFILE), POINTER       :: NCF
    LOGICAL FOUND
    if(dbg_set(dbg_sbr)) &
       & write(ipt,*) "START NCF_PLUS_ATT"

    IF(.NOT. ASSOCIATED(ncf)) CALL fatal_error &
         & ("NCF_PLUS_ATT: THE FILE OBJECT ARGUMENT IS NOT ASSOC&
         &IATED. THIS IS ILLEGAL.","THE DEPARTMENT OF FVCOM SECURITY HAS BEEN CONTACTED")

    IF(.NOT. ASSOCIATED(att)) CALL fatal_error &
         & ("NCF_PLUS_ATT: THE ATT OBJECT ARGUMENT IS NOT ASSOC&
         &IATED. THIS IS ILLEGAL.","THE DEPARTMENT OF FVCOM SECURITY HAS BEEN CONTACTED")

    IF(ncf%CONNECTED) CALL fatal_error&
         ("CAN NOT ADD ATTRIBUTE TO FILE OBJECTS ALREADY CONNECTED TO A NETCDF FILE")

    CALL insert_att_link(ncf,att,found)
    ! ADD ERROR HANDLING LATER FOR MERGING ATTS
    IF(found) CALL fatal_error("ERROR ADDIND ATTRIBUTE TO FILE",&
         & "THE ATTRIBUTE: "//trim(att%ATTNAME)//"; ALREADY EXISTS",&
         & "IN THE FILE: "//trim(ncf%FNAME))


    !ALL MEMORY NOW BELONGS TO RET
    ret => ncf
    NULLIFY(ncf)
    NULLIFY(att)
    if(dbg_set(dbg_sbr)) &
       & write(ipt,*) "END NCF_PLUS_ATT"

ncf_plus_dim()

type(ncfile) function, pointer mod_ncll::add::ncf_plus_dim	(	type(ncfile), pointer	NCF,
		type(ncdim), pointer	DIM
	)

Definition at line 3768 of file mod_ncll.f90.

    IMPLICIT NONE
    type(NCDIM),  POINTER       :: DIM
    type(NCFILE), POINTER       :: RET
    type(NCFILE), POINTER       :: NCF
    LOGICAL FOUND
    if(dbg_set(dbg_sbr)) &
       & write(ipt,*) "START NCF_PLUS_DIM"

    IF(.NOT. ASSOCIATED(ncf)) CALL fatal_error &
         & ("NCF_PLUS_DIM: THE FILE OBJECT ARGUMENT IS NOT ASSOC&
         &IATED. THIS IS ILLEGAL.","THE DEPARTMENT OF FVCOM SECURITY HAS BEEN CONTACTED")

    IF(.NOT. ASSOCIATED(dim)) CALL fatal_error &
         & ("NCF_PLUS_DIM: THE DIM OBJECT ARGUMENT IS NOT ASSOC&
         &IATED. THIS IS ILLEGAL.","THE DEPARTMENT OF FVCOM SECURITY HAS BEEN CONTACTED")


    IF(ncf%CONNECTED) CALL fatal_error&
         ("CAN NOT ADD DIMENSION TO FILE OBJECTS ALREADY CONNECTED TO A NETCDF FILE")

    CALL insert_dim_link(ncf,dim,found)

    ! ADDING DUPLICATE DIMENSIONS TO A FILE IS NOT IS OKAY
    IF(found) CALL fatal_error("ERROR ADDIND DIMENSION TO FILE",&
         & "THE DIMENSION: "//trim(dim%DIMNAME)//"; ALREADY EXISTS",&
         & "IN THE FILE: "//trim(ncf%FNAME))


    !ALL MEMORY NOW BELONGS TO RET
    ret => ncf
    NULLIFY(ncf)
    NULLIFY(dim)

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

ncf_plus_ncf()

type(ncfile) function, pointer mod_ncll::add::ncf_plus_ncf	(	type(ncfile), pointer	NCF1,
		type(ncfile), pointer	NCF2
	)

Definition at line 3807 of file mod_ncll.f90.

    ! ADD EACH VARIABLE FROM NCF2 TO NCF1
    ! THE VARIABLES WILL TAKE THEIR DIMENSIONS WITH THEM AS NEEDED
    !
    ! ADD ANY ATTRIBUTES THAT DO NOT ALREADY EXIST IN NCF1

    IMPLICIT NONE
    type(NCFILE), POINTER       :: NCF1
    type(NCFILE), POINTER       :: NCF2
    type(NCFILE), POINTER       :: RET

    type(NCVARP), POINTER       :: CURRENT_VAR
    type(NCVAR), POINTER        :: VAR

    type(NCDIMP), POINTER       :: CURRENT_DIM
    type(NCDIM), POINTER        :: DIM1
    type(NCDIM), POINTER        :: DIM2

    TYPE(NCATTP), POINTER       :: CURRENT_ATT
!!$
    TYPE(NCATT),  POINTER       :: ATTT
!!$    

    CHARACTER(LEN=NF90_MAX_NAME+1):: NAME
    LOGICAL FOUND1, FOUND2

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


    IF(.NOT. ASSOCIATED(ncf1)) CALL fatal_error &
         & ("NCF_PLUS_NCF: THE FIRST FILE OBJECT ARGUMENT IS NOT ASSOC&
         &IATED. THIS IS ILLEGAL.","THE DEPARTMENT OF FVCOM SECURITY HAS BEEN CONTACTED")

    IF(.NOT. ASSOCIATED(ncf2)) CALL fatal_error &
         & ("NCF_PLUS_NCF: THE SECOND FILE OBJECT ARGUMENT IS NOT ASSOC&
         &IATED. THIS IS ILLEGAL.","THE DEPARTMENT OF FVCOM SECURITY HAS BEEN CONTACTED")
    
    IF(ncf1%CONNECTED .OR. ncf2%CONNECTED) CALL fatal_error&
         ("CAN NOT COMBINE FILE OBJECTS ALREADY CONNECTED TO A NETCDF FILE")
    
    current_var => ncf2%VARS%NEXT

    DO
       IF(.NOT. ASSOCIATED(current_var)) EXIT
       
       IF (.NOT. ASSOCIATED(current_var%VAR)) &
            & CALL fatal_error("NCF_PLUS_NCF: ATTEMPT TO ADD A FILE &
            &THAT HAS UNASSOCIATED VAR POINTER IN ITS LINK LIST!")
       
       ! Variable from the second file
       var =>copy_var(current_var%VAR)
       !DISCONECT THE VARIABLE MOMENTARILY
       var%CONNECTED=.false.


       current_dim=>var%DIMS%NEXT
       DO
          IF(.NOT. ASSOCIATED(current_dim)) EXIT
          
          IF (.NOT. ASSOCIATED(current_dim%DIM)) &
               & CALL fatal_error("NCF_PLUS_NCF: ATTEMPT TO ADD VARIABLE &
               &THAT HAS UNASSOCIATED DIM POINTERS IN ITS LINK LIST!")
          
          !DIM from the variable of the second file
          dim2 => current_dim%DIM
          
          CALL insert_dim_link(ncf1,dim2,found1)
          ! THIS WILL ADD THE VARIABLES DIMENSION IF IT IS NOT THERE ALREADY
          ! IN THE FILE. THERE IS SOME BASIC CONSISTANCY CHECKING.
          
          ! IF WE JUST ADDED IT, GREAT! NOW THE FILE'S DIM LINK LIST AND
          ! THE VARIABLE'S DIM LINK LIST ALREADY POINT TO THE SAME MEMORY
          
          ! IF WE FOUND IT IN THE FILE TO WHICH THE VARIABLE IS BEING
          ! ADDED MOVE THE POINTER OVER
          IF (found1) THEN
             current_dim%DIM => find_dim(ncf1,dim2%DIMNAME,found2)
             IF (.NOT. found2) CALL fatal_error("NCF_PLUS_NCF: CAN'T FIN&
                  &D DIMENSION IN FILE BUT IT WAS HERE A SECOND AGO?")
             CALL kill_dim(dim2)

          END IF
          
          current_dim => current_dim%NEXT
       END DO

       ! NOW ADD THE VARIABLE TO THE FILE
       
       CALL insert_var_link(ncf1,var,found1)
       IF(found1) CALL fatal_error("NCF_PLUS_VAR: THIS VARIABLE ALREADY EX&
            &ISTS IN THE FILE. YOU CAN'T ADD IT AGAIN!", &
            & "VARIABLE NAME: "//trim(var%VARNAME))
       
       
       var%NCID => ncf1%NCID
       var%CONNECTED=.true.
       
       current_var => current_var%NEXT
    END DO
    

!!$    ! NOW GO THROUGH DIMENSION LIST IN BOTH FILES AND DELETE DUPLICATES!
!!$    CURRENT_DIM=>NCF2%DIMS%NEXT
!!$    DO
!!$       IF(.NOT. ASSOCIATED(CURRENT_DIM)) EXIT
!!$       
!!$       IF (.NOT. ASSOCIATED(CURRENT_DIM%DIM)) &
!!$            & CALL FATAL_ERROR("NCF_PLUS_NCF: ATTEMPT TO ADD VARIABLE &
!!$            &THAT HAS UNASSOCIATED DIM POINTERS IN ITS LINK LIST!")
!!$              
!!$       !DIM from the second file
!!$       DIM2 => CURRENT_DIM%DIM
!!$       
!!$       DIM1 => FIND_DIM(NCF1,DIM2%DIMNAME,FOUND1)
!!$       IF (.NOT. FOUND1) THEN
!!$          CALL FATAL_ERROR("NCF_PLUS_NCF: ALL DIMENSIO&
!!$               &NS FROM FILE TWO SHOULD ALREADY BE ADDED TO FILE ONE:",&
!!$               &"FOUND DIMNAME: "//DIM2%DIMNAME//" IN FILE 2 BUT NOT IN 1&
!!$               & ?")
!!$       ELSE
!!$          IF(.not. associated(DIM1,target = DIM2)) CALL KILL_DIM(DIM2)
!!$       END IF
!!$
!!$       CURRENT_DIM => CURRENT_DIM%NEXT
!!$
!!$    END DO


   current_att => ncf2%ATTS%NEXT
    DO
       IF(.NOT. ASSOCIATED(current_att)) EXIT
 
       IF (.NOT. ASSOCIATED(current_att%ATT)) &
            & CALL fatal_error("NCF_PLUS_NCF: ATTEMPT TO ADD A FILE &
            &THAT HAS UNASSOCIATED ATT POINTER IN ITS LINK LIST!")

       attt => copy_att(current_att%ATT)
       ncf1 => ncf_plus_att(ncf1,attt)
!!$       NCF1 => NCF_PLUS_ATT(NCF1,Copy_Att(CURRENT_ATT%ATT))
       !ALREADY INCRIMENTED NATTS

       current_att => current_att%NEXT
    END DO



    ret => ncf1
    NULLIFY(ncf1)
    CALL kill_file(ncf2)
    NULLIFY(ncf2)

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

ncf_plus_var()

type(ncfile) function, pointer mod_ncll::add::ncf_plus_var	(	type(ncfile), pointer	NCF,
		type(ncvar), pointer	VAR
	)

Definition at line 3626 of file mod_ncll.f90.

    ! ADD THE VARIABLE TO THE FILE LIST IF IT DOES NOT ALREADY EXIST
    !
    ! ADD THE VARIABLES DIMENSIONS IF THEY DO NOT EXIST IN THE FILE LIST
    ! OR POINT TO THE FILES DIMENSIONS AND USE THE FILES DIMIDS IF THE
    ! DIMENSION ALREADY EXISTS IN THE FILE'S LIST
    !
    ! ATTRIBUTES BELONG TO THE VARIABLE, JUST ADD THEM WITH THE VARIABLE
    IMPLICIT NONE
    type(NCVAR),  POINTER       :: VAR
    type(NCFILE), POINTER       :: RET
    type(NCFILE), POINTER       :: NCF
    type(NCDIM),  POINTER       :: VDIM, GDIM
    type(NCDIMP), POINTER       :: CURRENT
    
    LOGICAL :: FOUND, F
    CHARACTER(LEN=NF90_MAX_NAME+1):: NAME
    if(dbg_set(dbg_sbr)) &
       & write(ipt,*) "START NCF_PLUS_VAR"

    IF(.NOT. ASSOCIATED(ncf)) CALL fatal_error &
         & ("NCF_PLUS_VAR: THE FILE OBJECT ARGUMENT IS NOT ASSOC&
         &IATED. THIS IS ILLEGAL.","THE DEPARTMENT OF FVCOM SECURITY HAS BEEN CONTACTED")

    IF(.NOT. ASSOCIATED(var)) CALL fatal_error &
         & ("NCF_PLUS_VAR: THE VAR OBJECT ARGUMENT IS NOT ASSOC&
         &IATED. THIS IS ILLEGAL.","THE DEPARTMENT OF FVCOM SECURITY HAS BEEN CONTACTED")


    IF(ncf%CONNECTED) CALL fatal_error&
         ("CAN NOT ADD VARIABLE TO FILE OBJECTS ALREADY CONNECTED TO A NETCDF FILE")

    IF(var%CONNECTED) CALL fatal_error&
         ("CAN NOT ADD VARIABLE TO A FILE OBJECT WHEN IT IS ALREADY CONNECTED")


    ! LOOK TO SEE IF WE NEED TO ADD ANY NEW DIMENSIONS TO THE FILE
    current=>var%DIMS%NEXT
    DO
       IF(.NOT. ASSOCIATED(current)) EXIT

       IF (.NOT. ASSOCIATED(current%DIM)) &
            & CALL fatal_error("NCF_PLUS_VAR: ATTEMPT TO ADD VARIABLE &
            &THAT HAS UNASSOCIATED DIM POINTERS IN ITS LINK LIST!")

       vdim => current%DIM

       CALL insert_dim_link(ncf,vdim,found)
       ! THIS WILL ADD THE VARIABLES DIMENSION IF IT IS NOT THERE ALREADY
       ! IN THE FILE. THERE IS SOME BASIC CONSISTANCY CHECKING.

       ! IF WE JUST ADDED IT, GREAT! NOW THE FILE'S DIM LINK LIST AND
       ! THE VARIABLE'S DIM LINK LIST ALREADY POINT TO THE SAME MEMORY
       
       IF(found) THEN ! THE DIMENSION IS ALREADY THERE. 

          name = vdim%DIMNAME
          gdim => find_dim(ncf,name,f)
          IF(.NOT. f) CALL fatal_error("NCF_PLUS_VAR: CAN'T FIND D&
               &IMENSION BUT IT WAS THERE A MINUTE AGO?")

          IF (.not. associated(vdim,target = gdim)) THEN ! CHECKS TO SEE IF IT IS
             ! POINTING TO THE SAME MEMORY OR TRUELY A DUPLICATE
             
             ! DELETE THE DUPLICATE AND POINT TO THE FILES DIM LINK LIST
             
             ! THIS ALLOWS THE FILE TO SET THE DIMIDS. DIMIDS SET IN THE
             ! VARIABLES DIM LIST ARE IGNORED
             CALL kill_dim(vdim)

             ! MOVE NOW EMPTY VARIABLE'S DIM LINK LIST POINTER TO FILE'S DIM LINK LIST
             current%DIM => gdim
          END IF
       END IF
       current => current%NEXT
    END DO

    ! NOW ADD THE VARIABLE TO THE FILE

    CALL insert_var_link(ncf,var,found)
    IF(found) CALL fatal_error("NCF_PLUS_VAR: THIS VARIABLE ALREADY EX&
         &ISTS IN THE FILE. YOU CAN'T ADD IT AGAIN!", &
         & "VARIABLE NAME: "//trim(var%VARNAME))


!    IF(ASSOCIATED(VAR%NCID)) THEN
      ! IF(VAR%NCID /= NCF%NCID) &
!            CALL FATAL_ERROR&
!            &("CAN'T ADD VARIABLE TO A FILE WITH A DIFFERENT NCID")
!    ELSE
    
!    END IF

    var%NCID => ncf%NCID
    var%CONNECTED=.true.

    !ALL MEMORY NOW BELONGS TO RET
    ret => ncf
    NULLIFY(ncf)
    NULLIFY(var)
    if(dbg_set(dbg_sbr)) &
       & write(ipt,*) "END NCF_PLUS_VAR"

ncflist_plus_ncf()

type(ncfilelist) function, pointer mod_ncll::add::ncflist_plus_ncf	(	type(ncfilelist), pointer	NCFLIST,
		type(ncfile), pointer	NCF
	)

Definition at line 3965 of file mod_ncll.f90.

    IMPLICIT NONE
    type(NCFILELIST), POINTER   :: NCFLIST
    type(NCFILELIST), POINTER   :: RET
    type(NCFILE),     POINTER   :: NCF
    LOGICAL FOUND

    IF (.NOT. ASSOCIATED(ncflist))THEN
       ALLOCATE(ncflist)
       ncflist%FIRST => new_filep()
    END IF

    CALL insert_file_link(ncflist,ncf,found)
    IF(found) CALL fatal_error("NCFLIST_PLUS_NCF: THIS FILE ALREADY EX&
         &ISTS IN THE FILELIST. YOU CAN'T ADD IT AGAIN!", &
         & "FILE NAME: "//trim(ncf%FNAME))

    !ALL MEMORY IN NCFLIST NOW BELONGS TO RET
    ret => ncflist
    NULLIFY(ncflist)
    NULLIFY(ncf)

var_plus_att()

type(ncvar) function, pointer mod_ncll::add::var_plus_att	(	type(ncvar), pointer	VAR,
		type(ncatt), pointer	ATT
	)

Definition at line 3589 of file mod_ncll.f90.

    ! ADD THE ATTRIBUTE TO THE VARIABLE ATT LIST IF IT DOES NOT EXIST
    IMPLICIT NONE
    type(NCVAR), POINTER        :: VAR
    type(NCATT), POINTER        :: ATT
    type(NCVAR), POINTER        :: RET
    LOGICAL FOUND
    if(dbg_set(dbg_sbr)) &
       & write(ipt,*) "START VAR_PLUS_ATT"

    IF(.NOT. ASSOCIATED(var)) CALL fatal_error &
         & ("VAR_PLUS_ATT: THE VAR OBJECT ARGUMENT IS NOT ASSOC&
         &IATED. THIS IS ILLEGAL.","THE DEPARTMENT OF FVCOM SECURITY HAS BEEN CONTACTED")

    IF(.NOT. ASSOCIATED(att)) CALL fatal_error &
         & ("VAR_PLUS_ATT: THE ATT OBJECT ARGUMENT IS NOT ASSOC&
         &IATED. THIS IS ILLEGAL.","THE DEPARTMENT OF FVCOM SECURITY HAS BEEN CONTACTED")

    IF(var%CONNECTED) CALL fatal_error&
         ("CAN NOT ADD ATTRIBUTES TO A VARIABLE OBJECT ALREADY IN A FILE")

    CALL insert_att_link(var,att,found)
    ! ADD ERROR HANDLING LATER FOR MERGING ATTS
    IF(found) CALL fatal_error("ERROR ADDIND ATTRIBUTE TO VARIABLE",&
         & "THE ATTRIBUTE: "//trim(att%ATTNAME)//"; ALREADY EXISTS",&
         & "IN THE VARIABLE: "//trim(var%VARNAME))


    !ALL MEMORY NOW BELONGS TO RET
    ret => var
    NULLIFY(var)
    NULLIFY(att)
    if(dbg_set(dbg_sbr)) &
       & write(ipt,*) "END VAR_PLUS_ATT"

var_plus_dim()

type(ncvar) function, pointer mod_ncll::add::var_plus_dim	(	type(ncvar), pointer	VAR,
		type(ncdim), pointer	DIM
	)

Definition at line 3551 of file mod_ncll.f90.

    ! ADD THE DIMENSION TO THE VARIABLE DIM LIST IF IT DOES NOT EXIST
    IMPLICIT NONE
    type(NCVAR), POINTER        :: VAR
    type(NCVAR), POINTER        :: RET
    type(NCDIM), POINTER        :: DIM
    LOGICAL FOUND
    if(dbg_set(dbg_sbr)) &
       & write(ipt,*) "START VAR_PLUS_DIM"

    IF(.NOT. ASSOCIATED(var)) CALL fatal_error &
         & ("VAR_PLUS_DIM: THE VAR OBJECT ARGUMENT IS NOT ASSOC&
         &IATED. THIS IS ILLEGAL.","THE DEPARTMENT OF FVCOM SECURITY HAS BEEN CONTACTED")

    IF(.NOT. ASSOCIATED(dim)) CALL fatal_error &
         & ("VAR_PLUS_DIM: THE DIM OBJECT ARGUMENT IS NOT ASSOC&
         &IATED. THIS IS ILLEGAL.","THE DEPARTMENT OF FVCOM SECURITY HAS BEEN CONTACTED")

    IF(var%CONNECTED) CALL fatal_error&
         ("CAN NOT ADD DIMENSIONS TO A VARIABLE OBJECT ALREADY IN A FILE")

    CALL insert_dim_link(var,dim,found)
    

!     IF(FOUND) CALL FATAL_ERROR("ERROR ADDIND DIMENSION TO VARIABLE",&
!         & "THE DIMENSION: "//TRIM(DIM%DIMNAME)//"; ALREADY EXISTS",&
!         & "IN THE VARIABLE: "//TRIM(VAR%VARNAME))


    !ALL MEMORY NOW BELONGS TO RET
    ret => var
    NULLIFY(var)
    NULLIFY(dim) 
    if(dbg_set(dbg_sbr)) &
         & write(ipt,*) "END VAR_PLUS_DIM"

---

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

• FVCOMg01/mod_ncll.f90