add interface documentation

columnphysics/icepack_atmo.F90

@@ -797,6 +797,8 @@ subroutine neutral_drag_coeffs (apnd,     hpnd,     &
       end subroutine neutral_drag_coeffs
 
 !=======================================================================
+!autodocument_start icepack_atm_boundary
+! 
 
       subroutine icepack_atm_boundary(sfctype,                    &
                                      Tsf,         potT,          &
@@ -849,6 +851,10 @@ subroutine icepack_atm_boundary(sfctype,                    &
       real (kind=dbl_kind), optional, intent(out) :: &
          Uref         ! reference height wind speed (m/s)
 
+!autodocument_end
+
+      ! local variables
+
       real (kind=dbl_kind) :: &
          worku, workv, workr
 
@@ -901,9 +907,9 @@ subroutine icepack_atm_boundary(sfctype,                    &
 
       end subroutine icepack_atm_boundary
 
-      !------------------------------------------------------------
-      ! Define functions
-      !------------------------------------------------------------
+!------------------------------------------------------------
+! Define functions
+!------------------------------------------------------------
 
 !=======================================================================
 

columnphysics/icepack_brine.F90

@@ -910,7 +910,7 @@ subroutine calculate_drho (nblyr,     i_grid,     b_grid, &
      end subroutine calculate_drho
 
 !=======================================================================
-
+!autodocument_start icepack_init_hbrine
 !  Initialize brine height tracer
 
       subroutine icepack_init_hbrine(bgrid, igrid, cgrid, &
@@ -934,6 +934,10 @@ subroutine icepack_init_hbrine(bgrid, igrid, cgrid, &
          icgrid           , &  ! interface grid for CICE (shortwave variable)
          swgrid                ! grid for ice tracers used in dEdd scheme
 
+!autodocument_end
+
+      ! local variables
+
       integer (kind=int_kind) :: &
          k                 ! vertical index
 
@@ -1002,7 +1006,7 @@ subroutine icepack_init_hbrine(bgrid, igrid, cgrid, &
       end subroutine icepack_init_hbrine
 
 !=======================================================================
-
+!autodocument_start icepack_init_zsalinity
 !  Initialize zSalinity
 
       subroutine icepack_init_zsalinity(nblyr,ntrcr_o,  Rayleigh_criteria, &
@@ -1026,6 +1030,10 @@ subroutine icepack_init_zsalinity(nblyr,ntrcr_o,  Rayleigh_criteria, &
       real (kind=dbl_kind), dimension(:,:), intent(inout):: &
        trcrn ! bgc subset of trcrn
 
+!autodocument_end
+
+      ! local variables
+
       integer (kind=int_kind) :: &
         k, n
 

columnphysics/icepack_itd.F90

@@ -1669,6 +1669,7 @@ subroutine zerolayer_check (ncat,        nilyr,      &
       end subroutine zerolayer_check
 
 !=======================================================================
+!autodocument_start icepack_init_itd
 ! Initialize area fraction and thickness boundaries for the itd model
 !
 ! authors: William H. Lipscomb and Elizabeth C. Hunke, LANL
@@ -1682,6 +1683,8 @@ subroutine icepack_init_itd(ncat, hin_max)
       real (kind=dbl_kind), intent(out) :: &
            hin_max(0:ncat)  ! category limits (m)
 
+!autodocument_end
+
       ! local variables
 
       integer (kind=int_kind) :: &
@@ -1847,7 +1850,7 @@ subroutine icepack_init_itd(ncat, hin_max)
       end subroutine icepack_init_itd
 
 !=======================================================================
-
+!autodocument_start icepack_init_itd_hist
 ! Initialize area fraction and thickness boundaries for the itd model
 !
 ! authors: William H. Lipscomb and Elizabeth C. Hunke, LANL
@@ -1864,6 +1867,8 @@ subroutine icepack_init_itd_hist (ncat, hin_max, c_hi_range)
       character (len=35), intent(out) :: &
            c_hi_range(ncat) ! string for history output
 
+!autodocument_end
+
       ! local variables
 
       integer (kind=int_kind) :: &
@@ -1900,7 +1905,7 @@ subroutine icepack_init_itd_hist (ncat, hin_max, c_hi_range)
       end subroutine icepack_init_itd_hist
 
 !=======================================================================
-
+!autodocument_start icepack_aggregate
 ! Aggregate ice state variables over thickness categories.
 !
 ! authors: C. M. Bitz, UW
@@ -1950,6 +1955,8 @@ subroutine icepack_aggregate (ncat,               &
       real (kind=dbl_kind), dimension (:), intent(out) :: &
          trcr      ! ice tracers
 
+!autodocument_end
+
       ! local variables
 
       integer (kind=int_kind) :: &

columnphysics/icepack_mechred.F90

@@ -1558,7 +1558,7 @@ subroutine ridge_shift (ntrcr,       dt,              &
       end subroutine ridge_shift
 
 !=======================================================================
-
+!autodocument_start icepack_ice_strength
 ! Compute the strength of the ice pack, defined as the energy (J m-2)
 ! dissipated per unit area removed from the ice pack under compression,
 ! and assumed proportional to the change in potential energy caused
@@ -1594,6 +1594,8 @@ subroutine icepack_ice_strength (ncat,               &
       real (kind=dbl_kind), intent(inout) :: &
          strength   ! ice strength (N/m)
 
+!autodocument_end
+
       ! local variables
 
       real (kind=dbl_kind) :: &
@@ -1688,7 +1690,7 @@ subroutine icepack_ice_strength (ncat,               &
       end subroutine icepack_ice_strength
 
 !=======================================================================
-!
+!autodocument_start icepack_step_ridge
 ! Computes sea ice mechanical deformation
 !
 ! authors: William H. Lipscomb, LANL
@@ -1791,6 +1793,8 @@ subroutine icepack_step_ridge (dt,           ndtd,         &
       logical (kind=log_kind), dimension(:), intent(inout) :: &
          first_ice    ! true until ice forms
 
+!autodocument_end
+
       ! local variables
 
       real (kind=dbl_kind) :: &

columnphysics/icepack_ocean.F90

@@ -21,6 +21,7 @@ module icepack_ocean
 
 !=======================================================================
 !=======================================================================
+!autodocument_start icepack_ocn_mixed_layer
 ! Compute the mixed layer heat balance and update the SST.
 ! Compute the energy available to freeze or melt ice.
 ! NOTE: SST changes due to fluxes through the ice are computed in
@@ -70,6 +71,8 @@ subroutine icepack_ocn_mixed_layer (alvdr_ocn, swvdr,      &
          sst       , & ! sea surface temperature (C)
          frzmlt        ! freezing/melting potential (W/m^2)
 
+!autodocument_end
+
       ! local variables
 
       real (kind=dbl_kind), parameter :: &

columnphysics/icepack_orbital.F90

@@ -39,6 +39,7 @@ module icepack_orbital
 
 !=======================================================================
 
+!autodocument_start icepack_init_orbit
 ! Compute orbital parameters for the specified date.
 
       subroutine icepack_init_orbit(iyear_AD_in, eccen_in, obliqr_in, &
@@ -58,6 +59,8 @@ subroutine icepack_init_orbit(iyear_AD_in, eccen_in, obliqr_in, &
       real(kind=dbl_kind), optional, intent(in) :: eccf_in   ! earth orbit eccentricity factor
       logical(kind=log_kind), optional, intent(in) :: log_print_in ! Flags print of status/error
 
+!autodocument_end
+
       character(len=*),parameter :: subname='(icepack_init_orbit)'
 
       !call icepack_warnings_add(subname//'  ')
@@ -85,6 +88,7 @@ end subroutine icepack_init_orbit
 
 !=======================================================================
 
+!autodocument_start icepack_query_orbit
 ! Compute orbital parameters for the specified date.
 
       subroutine icepack_query_orbit(iyear_AD_out, eccen_out, obliqr_out, &
@@ -104,6 +108,8 @@ subroutine icepack_query_orbit(iyear_AD_out, eccen_out, obliqr_out, &
       real(kind=dbl_kind), optional, intent(out) :: eccf_out   ! earth orbit eccentricity factor
       logical(kind=log_kind), optional, intent(out) :: log_print_out ! Flags print of status/error
 
+!autodocument_end
+
       character(len=*),parameter :: subname='(icepack_query_orbit)'
 
       !call icepack_warnings_add(subname//'  ')

columnphysics/icepack_parameters.F90

@@ -341,6 +341,7 @@ module icepack_parameters
 
 !=======================================================================
 
+!autodocument_start icepack_init_parameters
 ! subroutine to set the column package internal parameters
 
       subroutine icepack_init_parameters(   &
@@ -644,6 +645,8 @@ subroutine icepack_init_parameters(   &
       real (kind=dbl_kind), intent(in), optional :: &
          hp1_in             ! critical parameter for pond ice thickness
 
+!autodocument_end
+
       character(len=*),parameter :: subname='(icepack_init_parameters)'
 
       if (present(rhos_in)              ) rhos             = rhos_in
@@ -792,6 +795,7 @@ end subroutine icepack_init_parameters
 
 !=======================================================================
 
+!autodocument_start icepack_query_parameters
 ! subroutine to query the column package internal parameters
 
       subroutine icepack_query_parameters(   &
@@ -1109,6 +1113,8 @@ subroutine icepack_query_parameters(   &
       real (kind=dbl_kind), intent(out), optional :: &
          hp1_out             ! critical parameter for pond ice thickness
 
+!autodocument_end
+
       character(len=*),parameter :: subname='(icepack_query_parameters)'
 
       if (present(puny_out)              ) puny_out         = puny
@@ -1301,13 +1307,16 @@ end subroutine icepack_query_parameters
 
 !=======================================================================
 
+!autodocument_start icepack_write_parameters
 ! subroutine to write the column package internal parameters
 
       subroutine icepack_write_parameters(iounit)
 
         integer (kind=int_kind), intent(in) :: &
              iounit   ! unit number for output
 
+!autodocument_end
+
         character(len=*),parameter :: subname='(icepack_write_parameters)'
 
         write(iounit,*) subname
@@ -1461,8 +1470,13 @@ end subroutine icepack_write_parameters
 
 !=======================================================================
 
+!autodocument_start icepack_recompute_constants
+! subroutine to reinitialize some derived constants
+
       subroutine icepack_recompute_constants()
 
+!autodocument_end
+
       character(len=*),parameter :: subname='(icepack_recompute_constants)'
 
         cprho  = cp_ocn*rhow

columnphysics/icepack_shortwave.F90

@@ -3732,7 +3732,7 @@ subroutine compute_shortwave_trcr(n_algae,  nslyr,  &
       end subroutine compute_shortwave_trcr
 
 !=======================================================================
-!
+!autodocument_start icepack_prep_radiation
 ! Scales radiation fields computed on the previous time step.
 !
 ! authors: Elizabeth Hunke, LANL
@@ -3781,6 +3781,8 @@ subroutine icepack_prep_radiation (ncat, nilyr, nslyr,    &
          Iswabsn     , & ! SW radiation absorbed in ice layers (W m-2)
          Sswabsn         ! SW radiation absorbed in snow layers (W m-2)
 
+!autodocument_end
+
       ! local variables
 
       integer (kind=int_kind) :: &
@@ -3832,7 +3834,7 @@ subroutine icepack_prep_radiation (ncat, nilyr, nslyr,    &
       end subroutine icepack_prep_radiation
 
 !=======================================================================
-!
+!autodocument_start icepack_step_radiation
 ! Computes radiation fields
 !
 ! authors: William H. Lipscomb, LANL
@@ -3990,6 +3992,8 @@ subroutine icepack_step_radiation (dt,       ncat,     &
       logical (kind=log_kind), optional :: &
          initonly         ! flag to indicate init only, default is false
 
+!autodocument_end
+
       ! local variables
 
       integer (kind=int_kind) :: &

columnphysics/icepack_therm_itd.F90

@@ -1493,6 +1493,7 @@ subroutine add_new_ice (ncat,      nilyr,    nblyr,  &
       end subroutine add_new_ice
 
 !=======================================================================
+!autodocument_start icepack_step_therm2
 ! Driver for thermodynamic changes not needed for coupling:
 ! transport in thickness space, lateral growth and melting.
 !
@@ -1603,6 +1604,8 @@ subroutine icepack_step_therm2 (dt, ncat, n_aero, nltrcr,           &
       real (kind=dbl_kind), intent(in), optional :: &
          yday         ! day of year
 
+!autodocument_end
+
       character(len=*),parameter :: subname='(icepack_step_therm2)'
 
       !-----------------------------------------------------------------