Skip to content

Commit

Permalink
Final round of documentation clean-up
Browse files Browse the repository at this point in the history 
Used tex formatting for some of the equations in KPP descriptions, removed all
the "Only those used by entire module" USES blocks
  • Loading branch information
@mnlevy1981
mnlevy1981 committed Aug 14, 2024
1 parent db54c9d commit 0e119ea
Show file tree
Hide file tree
Showing 11 changed files with 24 additions and 327 deletions.
Binary file modified doc/protex_documentation.pdf
View file
Binary file not shown.
54 changes: 0 additions & 54 deletions src/cvmix_io.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,6 @@ subroutine cvmix_io_open(file_id, file_name, file_format, read_only)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
character(len=*), intent(in) :: file_name, file_format
logical, optional, intent(in) :: read_only
Expand Down Expand Up @@ -199,9 +196,6 @@ subroutine cvmix_input_read_1d_double(file_id, var_name, local_copy)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id
character(len=*), intent(in) :: var_name
Expand Down Expand Up @@ -288,9 +282,6 @@ subroutine cvmix_input_read_2d_integer(file_id, var_name, local_copy)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id
character(len=*), intent(in) :: var_name
Expand Down Expand Up @@ -378,9 +369,6 @@ subroutine cvmix_input_read_2d_double(file_id, var_name, local_copy)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id
character(len=*), intent(in) :: var_name
Expand Down Expand Up @@ -468,9 +456,6 @@ subroutine cvmix_input_read_3d_double(file_id, var_name, local_copy)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id
character(len=*), intent(in) :: var_name
Expand Down Expand Up @@ -559,9 +544,6 @@ subroutine cvmix_output_write_single_col(file_id, CVmix_vars, var_names, &
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id
type(cvmix_data_type) , intent(in) :: CVmix_vars
Expand Down Expand Up @@ -790,9 +772,6 @@ subroutine cvmix_output_write_multi_col(file_id, CVmix_vars, var_names)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id
type(cvmix_data_type), dimension(:), intent(in) :: CVmix_vars
Expand Down Expand Up @@ -985,9 +964,6 @@ subroutine cvmix_output_write_2d_double(file_id, var_name, dim_names, &
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id
character(len=*), intent(in) :: var_name
Expand Down Expand Up @@ -1060,9 +1036,6 @@ subroutine cvmix_output_write_3d_double(file_id, var_name, dim_names, &
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id
character(len=*), intent(in) :: var_name
Expand Down Expand Up @@ -1128,9 +1101,6 @@ subroutine cvmix_output_write_att_integer(file_id, att_name, att_val, &
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id
character(len=*), intent(in) :: att_name
Expand Down Expand Up @@ -1193,9 +1163,6 @@ subroutine cvmix_output_write_att_real(file_id, att_name, att_val, var_name)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id
character(len=*), intent(in) :: att_name
Expand Down Expand Up @@ -1258,9 +1225,6 @@ subroutine cvmix_output_write_att_string(file_id, att_name, att_val, var_name)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id
character(len=*), intent(in) :: att_name, att_val
Expand Down Expand Up @@ -1322,9 +1286,6 @@ subroutine cvmix_io_close(file_id)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id

Expand Down Expand Up @@ -1412,9 +1373,6 @@ subroutine cvmix_io_close_all
!\\
!\\
! !USES:
! Only those used by entire module.

! !LOCAL VARIABLES:
integer :: fid

Expand Down Expand Up @@ -1444,9 +1402,6 @@ function get_file_name(file_id)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id

Expand Down Expand Up @@ -1488,9 +1443,6 @@ function get_file_type(file_id)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id

Expand Down Expand Up @@ -1533,9 +1485,6 @@ function cvmix_input_get_netcdf_dim(file_id, dim_name)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id
character(len=*), intent(in) :: dim_name
Expand Down Expand Up @@ -1590,9 +1539,6 @@ function get_netcdf_varid(file_id, var_name, xtype, ndims)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: file_id
character(len=*), intent(in) :: var_name
Expand Down
45 changes: 0 additions & 45 deletions src/shared/cvmix_background.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,9 +120,6 @@ subroutine cvmix_init_bkgnd_scalar(bkgnd_Tdiff, bkgnd_Mdiff, old_vals, &
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
real(cvmix_r8), intent(in) :: bkgnd_Tdiff
real(cvmix_r8), intent(in) :: bkgnd_Mdiff
Expand Down Expand Up @@ -192,9 +189,6 @@ subroutine cvmix_init_bkgnd_1D(bkgnd_Tdiff, bkgnd_Mdiff, ncol, old_vals, &
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
real(cvmix_r8), dimension(:), intent(in) :: bkgnd_Tdiff
real(cvmix_r8), dimension(:), intent(in) :: bkgnd_Mdiff
Expand Down Expand Up @@ -293,9 +287,6 @@ subroutine cvmix_init_bkgnd_2D(bkgnd_Tdiff, bkgnd_Mdiff, ncol, &
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
real(cvmix_r8), dimension(:,:), intent(in) :: bkgnd_Tdiff
real(cvmix_r8), dimension(:,:), intent(in) :: bkgnd_Mdiff
Expand Down Expand Up @@ -373,9 +364,6 @@ subroutine cvmix_init_bkgnd_BryanLewis_wrap(CVmix_vars, bl1, bl2, bl3, bl4, &
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
! Contains depth and nlev
type(cvmix_data_type), intent(in) :: CVmix_vars
Expand Down Expand Up @@ -441,9 +429,6 @@ subroutine cvmix_init_bkgnd_BryanLewis_low(max_nlev, zw, bl1, bl2, bl3, bl4, &
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
integer, intent(in) :: max_nlev
real(cvmix_r8), dimension(max_nlev+1), intent(in) :: zw
Expand Down Expand Up @@ -527,9 +512,6 @@ subroutine cvmix_coeffs_bkgnd_wrap(CVmix_vars, colid, &
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:

! Need to know column for pulling data from static_[MT]diff
Expand Down Expand Up @@ -588,9 +570,6 @@ subroutine cvmix_coeffs_bkgnd_low(Mdiff_out, Tdiff_out, nlev, max_nlev, &
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:

! Need to know column for pulling data from static_[MT]diff
Expand Down Expand Up @@ -640,9 +619,6 @@ function cvmix_bkgnd_lvary_horizontal(CVmix_bkgnd_params_test)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
type(cvmix_bkgnd_params_type), intent(in) :: CVmix_bkgnd_params_test

Expand All @@ -669,9 +645,6 @@ function cvmix_bkgnd_static_Mdiff(CVmix_bkgnd_params_user,kw,colid)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
type(cvmix_bkgnd_params_type), target, optional, intent(in) :: &
CVmix_bkgnd_params_user
Expand Down Expand Up @@ -733,9 +706,6 @@ function cvmix_bkgnd_static_Tdiff(CVmix_bkgnd_params_user,kw,colid)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
type(cvmix_bkgnd_params_type), target, optional, intent(in) :: &
CVmix_bkgnd_params_user
Expand Down Expand Up @@ -797,9 +767,6 @@ subroutine cvmix_put_bkgnd_int(varname, val, CVmix_bkgnd_params_user)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
character(len=*), intent(in) :: varname
integer, intent(in) :: val
Expand Down Expand Up @@ -842,9 +809,6 @@ subroutine cvmix_put_bkgnd_real(varname, val, CVmix_bkgnd_params_user)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
character(len=*), intent(in) :: varname
real(cvmix_r8), intent(in) :: val
Expand Down Expand Up @@ -909,9 +873,6 @@ subroutine cvmix_put_bkgnd_real_1D(varname, val, CVmix_bkgnd_params_user, &
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
character(len=*), intent(in) :: varname
real(cvmix_r8), dimension(:), intent(in) :: val
Expand Down Expand Up @@ -1034,9 +995,6 @@ subroutine cvmix_put_bkgnd_real_2D(varname, val, ncol, nlev, &
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
character(len=*), intent(in) :: varname
real(cvmix_r8), dimension(:,:), intent(in) :: val
Expand Down Expand Up @@ -1122,9 +1080,6 @@ function cvmix_get_bkgnd_real_2D(varname, CVmix_bkgnd_params_user)
!\\
!\\
! !USES:
! Only those used by entire module.

! !INPUT PARAMETERS:
character(len=*), intent(in) :: varname
type(cvmix_bkgnd_params_type), target, optional, intent(in) :: &
Expand Down
Loading

0 comments on commit 0e119ea

Please sign in to comment.