mod_startup Module Reference

Functions/Subroutines
subroutine, public	startup
subroutine, public	read_ssh
subroutine, public	read_wetdry
subroutine	read_atmo
subroutine, public	read_ts
subroutine, public	read_uv
subroutine, public	read_turb

Function/Subroutine Documentation

read_atmo()

subroutine mod_startup::read_atmo

(

)

Definition at line 415 of file mod_startup.f90.

    IMPLICIT NONE
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCDIM),  POINTER :: DIM
    LOGICAL :: FOUND
    INTEGER :: STKCNT
    
    IF(dbg_set(dbg_sbr)) write(ipt,*) "START: READ_ATMO" 

    stkcnt = nc_start%FTIME%PREV_STKCNT

    ! LOAD ATMO
    var => find_var(nc_start,'el_atmo',found)
    IF(.not. found) CALL fatal_error&
         &("COULD NOT FIND VARIABLE 'el_atmo' IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, el_atmo)
    CALL nc_read_var(var,stkcnt)

    IF(dbg_set(dbg_sbr)) write(ipt,*) "End: READ_ATMO"

Here is the call graph for this function:

read_ssh()

subroutine, public mod_startup::read_ssh

(

)

Definition at line 312 of file mod_startup.f90.

    IMPLICIT NONE
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCDIM),  POINTER :: DIM
    LOGICAL :: FOUND
    INTEGER :: STKCNT

    IF(dbg_set(dbg_sbr)) write(ipt,*) "Start: READ_SSH"
    
    stkcnt = nc_start%FTIME%PREV_STKCNT

    ! LOAD EL
    var => find_var(nc_start,'zeta',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'zeta'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, el)
    CALL nc_read_var(var,stkcnt)

    ! LOAD ET
    var => find_var(nc_start,'et',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'et'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, et)
    CALL nc_read_var(var,stkcnt)

    !----------------------------------------------------------------
    ! Read the most recent bathymetry if Morphodynamics is Active
    !----------------------------------------------------------------


    !----------------------------------------------------------------
    ! Given SSH and Bathy, Update the Bathymetry 
    !----------------------------------------------------------------
    d  = h + el
    dt = h + et

    
    CALL n2e2d(h,h1)
    CALL n2e2d(el,el1)
    CALL n2e2d(d,d1)
    CALL n2e2d(dt,dt1)

    IF(dbg_set(dbg_sbr)) write(ipt,*) "Start: READ_SSH"

Here is the call graph for this function:

Here is the caller graph for this function:

read_ts()

subroutine, public mod_startup::read_ts

(

)

Definition at line 464 of file mod_startup.f90.

    IMPLICIT NONE
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCDIM),  POINTER :: DIM
    LOGICAL :: FOUND
    INTEGER :: STKCNT, K
    REAL(SP), DIMENSION(0:MT,KB) :: PRESSURE
    
    IF(dbg_set(dbg_sbr)) write(ipt,*) "Start: READ_TS" 
   
    stkcnt = nc_start%FTIME%PREV_STKCNT


    ! LOAD TEMPERATURE
    var => find_var(nc_start,'temp',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'temp'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, t1)
    CALL nc_read_var(var,stkcnt)


    ! LOAD MEAN INITIAL TEMPERATURE
    var => find_var(nc_start,'tmean1',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'tmean1'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, tmean1)
    CALL nc_read_var(var)

    ! LOAD SALINITY
    var => find_var(nc_start,'salinity',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'saltinity'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, s1)
    CALL nc_read_var(var,stkcnt)

    ! LOAD MEAN INITIAL SALINITY
    var => find_var(nc_start,'smean1',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'smean1'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, smean1)
    CALL nc_read_var(var)

    ! LOAD DENSITY
    var => find_var(nc_start,'rho1',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'rho1'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, rho1)
    CALL nc_read_var(var,stkcnt)

    ! LOAD MEAN DENSITY
    var => find_var(nc_start,'rmean1',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'rmean1'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, rmean1)
    CALL nc_read_var(var)


    ! AVERAGE FROM CELLS TO FACE CENTERS


!JQI    SELECT CASE(SEA_WATER_DENSITY_FUNCTION)
!JQI    CASE(SW_DENS1)

!JQI       ! SET MEAN DENSITY
!JQI       DO K=1,KBM1
!JQI          PRESSURE(:,K) = -GRAV_N*1.025_SP*(ZZ(:,K)*D(:))*0.1_SP
!JQI       END DO
!JQI       CALL FOFONOFF_MILLARD(SMEAN1,TMEAN1,PRESSURE,0.0_SP,RMEAN1)
!JQI       RMEAN1(0,:)=0.0_SP
!JQI       RMEAN1(:,KB)=0.0_SP

!JQI       ! SET REAL DENSITY
!JQI       CALL DENS1 ! GENERIC CALL TO FOFONOFF_MILLARD FOR S1,T1...
       
!JQI    CASE(SW_DENS2)
!JQI       ! SET MEAN DENSITY
!JQI       CALL DENS2G(SMEAN1,TMEAN1,RMEAN1)
!JQI       RMEAN1(0,:)=0.0_SP
!JQI       RMEAN1(:,KB)=0.0_SP

!JQI       ! SET REAL DENSITY
!JQI       CALL DENS2 ! GENERIC CALL TO DENS2G FOR S1,T1...

!JQI    CASE(SW_DENS3)

!JQI       ! SET MEAN DENSITY
!JQI       DO K=1,KBM1
!JQI          PRESSURE(:,K) = -GRAV_N*1.025_SP*(ZZ(:,K)*D(:))*0.01_SP
!JQI       END DO
!JQI       CALL JACKET_MCDOUGALL(SMEAN1,TMEAN1,PRESSURE,RMEAN1)
!JQI       RMEAN1(0,:)=0.0_SP
!JQI       RMEAN1(:,KB)=0.0_SP

!JQI       ! SET REAL DENSITY
!JQI       CALL DENS3 ! GENERIC CALL TO JACKET_MCDOUGALL FOR S1,T1.

!JQI    CASE DEFAULT
!JQI       CALL FATAL_ERROR("INVALID DENSITY FUNCTION SELECTED:",&
!JQI            & "   "//TRIM(SEA_WATER_DENSITY_FUNCTION) )
!JQI    END SELECT

!J. GE
    t0=t1
    s0=s1
!J. GE    
    CALL n2e3d(t1,t)
    CALL n2e3d(s1,s)
    CALL n2e3d(rho1,rho)
    CALL n2e3d(tmean1,tmean)
    CALL n2e3d(smean1,smean)
    CALL n2e3d(rmean1,rmean)

   
   IF(dbg_set(dbg_sbr)) write(ipt,*) "End: READ_TS" 
   

Here is the call graph for this function:

Here is the caller graph for this function:

read_turb()

subroutine, public mod_startup::read_turb

(

)

Definition at line 960 of file mod_startup.f90.

    IMPLICIT NONE
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCDIM),  POINTER :: DIM
    LOGICAL :: FOUND
    INTEGER :: STKCNT

    IF(dbg_set(dbg_sbr)) write(ipt,*) "START: READ_TURB" 

    stkcnt = nc_start%FTIME%PREV_STKCNT


    var => find_var(nc_start,'q2',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'q2'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, q2)
    CALL nc_read_var(var,stkcnt)

    var => find_var(nc_start,'q2l',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'q2l'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, q2l)
    CALL nc_read_var(var,stkcnt)

    var => find_var(nc_start,'l',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'l'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, l)
    CALL nc_read_var(var,stkcnt)


    var => find_var(nc_start,'km',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'km'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, km)
    CALL nc_read_var(var,stkcnt)

    var => find_var(nc_start,'kq',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'kq'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, kq)
    CALL nc_read_var(var,stkcnt)

    var => find_var(nc_start,'kh',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'kh'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, kh)
    CALL nc_read_var(var,stkcnt)


    CALL n2e3d(km,km1)

    IF(dbg_set(dbg_sbr)) write(ipt,*) "END: READ_TURB" 

Here is the call graph for this function:

Here is the caller graph for this function:

read_uv()

subroutine, public mod_startup::read_uv

(

)

Definition at line 905 of file mod_startup.f90.

    IMPLICIT NONE
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCDIM),  POINTER :: DIM
    LOGICAL :: FOUND
    INTEGER :: STKCNT

    IF(dbg_set(dbg_sbr)) write(ipt,*) "START: READ_UV" 


    stkcnt = nc_start%FTIME%PREV_STKCNT

    var => find_var(nc_start,'u',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'u'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, u)
    CALL nc_read_var(var,stkcnt)


    var => find_var(nc_start,'v',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'v'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, v)
    CALL nc_read_var(var,stkcnt)

    var => find_var(nc_start,'omega',found)
    IF(found) THEN
       CALL nc_connect_avar(var, wts)
       CALL nc_read_var(var,stkcnt)
       
       CALL n2e3d(wts,w)
    ELSE
       var => find_var(nc_start,'w',found)
       IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'w' &
            & or 'omega' IN THE HOTSTART FILE OBJECT")
       CALL nc_connect_avar(var, w)
       CALL nc_read_var(var,stkcnt)
    END IF

    var => find_var(nc_start,'ua',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'ua'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, ua)
    CALL nc_read_var(var,stkcnt)

    var => find_var(nc_start,'va',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'va'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, va)
    CALL nc_read_var(var,stkcnt)

    IF(dbg_set(dbg_sbr)) write(ipt,*) "END: READ_UV" 

Here is the call graph for this function:

Here is the caller graph for this function:

read_wetdry()

subroutine, public mod_startup::read_wetdry

(

)

Definition at line 359 of file mod_startup.f90.

    USE mod_wd
    IMPLICIT NONE
    TYPE(NCVAR),  POINTER :: VAR
    TYPE(NCDIM),  POINTER :: DIM
    LOGICAL :: FOUND
    INTEGER :: STKCNT

    IF(dbg_set(dbg_sbr)) write(ipt,*) "Start: READ_WETDRY"

    stkcnt = nc_start%FTIME%PREV_STKCNT

    ! LOAD ISWETN
    var => find_var(nc_start,'wet_nodes',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'wet_nodes'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, iswetn)
    CALL nc_read_var(var,stkcnt)

    ! LOAD ISWETC
    var => find_var(nc_start,'wet_cells',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'wet_cells'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, iswetc)
    CALL nc_read_var(var,stkcnt)


    ! LOAD ISWETNT
    var => find_var(nc_start,'wet_nodes_prev_int',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'wet_nodes_prev_int'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, iswetnt)
    CALL nc_read_var(var,stkcnt)

    ! LOAD ISWETCT
    var => find_var(nc_start,'wet_cells_prev_int',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'wet_cells_prev_int'&
         & IN THE HOTSTART FILE OBJECT")
    CALL nc_connect_avar(var, iswetct)
    CALL nc_read_var(var,stkcnt)

    ! LOAD ISWETCE
    var => find_var(nc_start,'wet_cells_prev_ext',found)
    IF(.not. found) CALL fatal_error("COULD NOT FIND VARIABLE 'wet_cells_prev_ext'&
         & IN THE HOTSTART FILE OBJECT")
    ! ------ new: Karsten Lettmann, May 2016 -------------
    !CALL NC_CONNECT_AVAR(VAR, ISWETC)  ! original line
    CALL nc_connect_avar(var, iswetce)
    ! ------------- end new ------------------------------
    CALL nc_read_var(var,stkcnt)

    IF(dbg_set(dbg_sbr)) write(ipt,*) "End: READ_WETDRY"
    

Here is the call graph for this function:

Here is the caller graph for this function:

startup()

subroutine, public mod_startup::startup

(

)

Definition at line 71 of file mod_startup.f90.

    IMPLICIT NONE

    IF(dbg_set(dbg_sbr)) write(ipt,*) "Start: Startup"

    IF(dbg_set(dbg_log)) THEN
       WRITE(ipt,*  )'!'
       WRITE(ipt,*  )'!           SETTING INITIAL CONDITIONS '
       WRITE(ipt,*  )'!'
    END IF

    IF (ASSOCIATED(nc_start))THEN
       IF(dbg_set(dbg_log)) write(ipt,*) "! NC_START FILE INFO:"
       CALL print_file(nc_start)
    END IF
       
!    SET THE SEA SURFACE HEIGHT
    if (dbg_set(dbg_log)) write(ipt,*) &
         & "! INITIALIZING SEA SURFACE HEIGHT"
    SELECT CASE(startup_type)
! =================================================
    CASE(startup_type_hotstart)
! =================================================

       CALL read_ssh

       IF(wetting_drying_on) CALL read_wetdry





! ------- New: Karsten Lettmann, June 2016 -----------------------
! ---------- end  new --------------------------------------------

!    if (dbg_set(dbg_log)) write(ipt,*) &
!         & "! INITIALIZING SEA ICE"



!    if (dbg_set(dbg_log)) write(ipt,*) &
!         & "! INITIALIZING SEA ICE222"





! =================================================
    CASE(startup_type_crashrestart)
! =================================================
       CALL read_ssh
     
       IF(wetting_drying_on) CALL read_wetdry





! ------- New: Karsten Lettmann, June 2016 -----------------------
! ---------- end  new --------------------------------------------






! =================================================
    CASE(startup_type_coldstart)
! =================================================

       CALL set_water_depth
       IF(wetting_drying_on) CALL set_wd_data

! =================================================
    CASE DEFAULT
! =================================================
       CALL fatal_error("STARTUP: UNKNOWN STARTUP TYPE: "//trim(startup_type))
    END SELECT


    if (dbg_set(dbg_log)) write(ipt,*) &
         & "! INITIALIZING VELOCITY FIELDS"

! SET STARTUP VALUES FOR VELOCITY
    SELECT CASE (startup_uv_type)
    CASE (startup_type_observed)
       CALL fatal_error("I DON'T KNOW HOW TO DO THAT KIND OF STARTUP")
    CASE(startup_type_linear) 
       CALL fatal_error("I DON'T KNOW HOW TO DO THAT KIND OF STARTUP")
    CASE(startup_type_constant)
       !CALL FATAL_ERROR("I DON'T KNOW HOW TO DO THAT KIND OF STARTUP")
       CALL set_constant_uv
    CASE(startup_type_default)
       ! OKAY - it is zero
    CASE(startup_type_setvalues)

       CALL read_uv

    CASE DEFAULT
       CALL fatal_error("UNKNOWN STARTUP_UV_TYPE")
    END SELECT

    if (dbg_set(dbg_log)) write(ipt,*) &
         & "! INITIALIZING TURBULENCE FIELDS"

! SET STARTUP VALUES FOR TURBULENCE
    SELECT CASE(startup_turb_type)
    CASE(startup_type_observed) 
       CALL fatal_error("I DON'T KNOW HOW TO DO THAT KIND OF STARTUP")
    CASE(startup_type_linear)
       CALL fatal_error("I DON'T KNOW HOW TO DO THAT KIND OF STARTUP")
    CASE(startup_type_constant)
       CALL fatal_error("I DON'T KNOW HOW TO DO THAT KIND OF STARTUP")
    CASE(startup_type_default)

       CALL set_default_turb

    CASE(startup_type_setvalues)

       CALL read_turb

    CASE DEFAULT
       CALL fatal_error("UNKNOWN STARTUP_TURB_TYPE")
    END SELECT

    if (dbg_set(dbg_log)) write(ipt,*) &
         & "! INITIALIZING TEMPERATURE AND SALINITY"

! SET STARTUP VALUES FOR TEMPERATER AND SALINITY
    SELECT CASE(startup_ts_type)
    CASE(startup_type_observed) 

       CALL set_observed_ts

    CASE(startup_type_linear)

       CALL set_linear_ts

    CASE(startup_type_constant)

       CALL set_constant_ts

    CASE(startup_type_default)
       CALL fatal_error("There is no default startup for Temperature and Salinity")
    CASE(startup_type_setvalues)

       CALL read_ts

    CASE DEFAULT
       CALL fatal_error("UNKNOWN STARTUP_TS_TYPE")
    END SELECT



    ! ONCE WE HAVE STARTED THE MODEL POINT THE START FILE OBJECT TO
    ! ITS OWN OUTPUT TO RELOAD OLD TIME STATES
    IF(.not. associated(nc_start,nc_rst)) THEN
       
       ! SOME START UPS DO NOT HAVE A START FILE
       IF(Associated(nc_start)) CALL kill_file(nc_start)

       nc_start => nc_rst
    END IF

    IF(dbg_set(dbg_sbr)) write(ipt,*) "End: Startup"

Here is the call graph for this function:

Here is the caller graph for this function: