Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Doxygen comments to src/core #524

Merged
merged 11 commits into from
Jun 19, 2017
Merged

Added Doxygen comments to src/core #524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
e22cdeb
added Doxygen comments to MOM_checksum_packages.F90
CarolineCardinale Jun 15, 2017
76a8484
Merge remote-tracking branch 'refs/remotes/origin/dev/gfdl' into dev/…
CarolineCardinale Jun 15, 2017
73380f5
added Doxygen comments to MOM_checksum_packages.F90
CarolineCardinale Jun 15, 2017
a06258f
Added Doxygen comments to MOM_dynamics_legacy_split.F90
CarolineCardinale Jun 15, 2017
e216c50
Added Doxygen comments to MOM_dynamics_unsplit.F90
CarolineCardinale Jun 15, 2017
22827d0
Added doxygen comments to MOM_dynamics_unsplit_RK2.F90
CarolineCardinale Jun 16, 2017
ced9786
Added doxygen comments to MOM_interface_heights.F90
CarolineCardinale Jun 16, 2017
869be3c
Added doxygen comments to MOM_verticalGrid.F90
CarolineCardinale Jun 16, 2017
c929a77
Added Doxygen comments to MOM_checksum_packages.F90
CarolineCardinale Jun 19, 2017
8abf4af
Added Doxygen comments to MOM_dynamics_legacy_split.F90
CarolineCardinale Jun 19, 2017
a74868f
Added doxygen comments to MOM_verticalGrid.F90
CarolineCardinale Jun 19, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 83 additions & 41 deletions src/core/MOM_checksum_packages.F90
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,16 +52,23 @@ module MOM_checksum_packages
! =============================================================================

subroutine MOM_state_chksum_5arg(mesg, u, v, h, uh, vh, G, GV, haloshift, symmetric)
character(len=*), intent(in) :: mesg
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure
type(verticalGrid_type), intent(in) :: GV !< The ocean's vertical grid structure
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), intent(in) :: u !< The zonal velocity, in m s-1
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), intent(in) :: v !< The meridional velocity, in m s-1
real, dimension(SZI_(G),SZJ_(G),SZK_(G)), intent(in) :: h !< Layer thicknesses, in H (usually m or kg m-2)
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), intent(in) :: uh
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), intent(in) :: vh
integer, optional, intent(in) :: haloshift
logical, optional, intent(in) :: symmetric
character(len=*), &
intent(in) :: mesg !< A message that appears on the chksum lines.
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure.
type(verticalGrid_type), intent(in) :: GV !< The ocean's vertical grid structure.
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
intent(in) :: u !< The zonal velocity, in m s-1.
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
intent(in) :: v !< The meridional velocity, in m s-1.
real, dimension(SZI_(G),SZJ_(G),SZK_(G)), &
intent(in) :: h !< Layer thicknesses, in H (usually m or kg m-2).
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
intent(in) :: uh !< Volume flux through zonal faces = u*h*dy, m3 s-1.
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
intent(in) :: vh !< Volume flux through meridional
!! faces = v*h*dx, in m3 s-1.
integer, optional, intent(in) :: haloshift
logical, optional, intent(in) :: symmetric
! This subroutine writes out chksums for the model's basic state variables.
! Arguments: mesg - A message that appears on the chksum lines.
! (in) u - Zonal velocity, in m s-1.
Expand Down Expand Up @@ -89,14 +96,17 @@ end subroutine MOM_state_chksum_5arg
! =============================================================================

subroutine MOM_state_chksum_3arg(mesg, u, v, h, G, GV, haloshift, symmetric)
character(len=*), intent(in) :: mesg
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure
type(verticalGrid_type), intent(in) :: GV !< The ocean's vertical grid structure
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), intent(in) :: u !< The zonal velocity, in m s-1
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), intent(in) :: v !< The meridional velocity, in m s-1
real, dimension(SZI_(G),SZJ_(G),SZK_(G)), intent(in) :: h !< Layer thicknesses, in H (usually m or kg m-2)
integer, optional, intent(in) :: haloshift
logical, optional, intent(in) :: symmetric
character(len=*), intent(in) :: mesg !< A message that appears on the chksum lines.
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure.
type(verticalGrid_type), intent(in) :: GV !< The ocean's vertical grid structure.
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
intent(in) :: u !< Zonal velocity, in m s-1.
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
intent(in) :: v !< Meridional velocity, in m s-1.
real, dimension(SZI_(G),SZJ_(G),SZK_(G)), &
intent(in) :: h !< Layer thicknesses, in H (usually m or kg m-2).
integer, optional, intent(in) :: haloshift
logical, optional, intent(in) :: symmetric
! This subroutine writes out chksums for the model's basic state variables.
! Arguments: mesg - A message that appears on the chksum lines.
! (in) u - Zonal velocity, in m s-1.
Expand All @@ -122,9 +132,10 @@ end subroutine MOM_state_chksum_3arg
! =============================================================================

subroutine MOM_thermo_chksum(mesg, tv, G, haloshift)
character(len=*), intent(in) :: mesg
type(thermo_var_ptrs), intent(in) :: tv !< A structure pointing to various thermodynamic variables
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure
character(len=*), intent(in) :: mesg !< A message that appears on the chksum lines.
type(thermo_var_ptrs), intent(in) :: tv !< A structure pointing to various
!! thermodynamic variables.
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure.
integer, optional, intent(in) :: haloshift
! This subroutine writes out chksums for the model's thermodynamic state
! variables.
Expand All @@ -147,19 +158,39 @@ end subroutine MOM_thermo_chksum

subroutine MOM_accel_chksum(mesg, CAu, CAv, PFu, PFv, diffu, diffv, G, GV, pbce, &
u_accel_bt, v_accel_bt, symmetric)
character(len=*), intent(in) :: mesg
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure
type(verticalGrid_type), intent(in) :: GV !< The ocean's vertical grid structure
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), intent(in) :: CAu
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), intent(in) :: CAv
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), intent(in) :: PFu
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), intent(in) :: PFv
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), intent(in) :: diffu
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), intent(in) :: diffv
real, dimension(SZI_(G),SZJ_(G),SZK_(G)), optional, intent(in) :: pbce
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), optional, intent(in) :: u_accel_bt
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), optional, intent(in) :: v_accel_bt
logical, optional, intent(in) :: symmetric
character(len=*), intent(in) :: mesg !< A message that appears on the chksum lines.
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure.
type(verticalGrid_type), intent(in) :: GV !< The ocean's vertical grid structure.
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
intent(in) :: CAu !< Zonal acceleration due to Coriolis
!! and momentum advection terms, in m s-2.
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
intent(in) :: CAv !< Meridional acceleration due to Coriolis
!! and momentum advection terms, in m s-2.
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
intent(in) :: PFu !< Zonal acceleration due to pressure gradients
!! (equal to -dM/dx) in m s-2.
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
intent(in) :: PFv !< Meridional acceleration due to pressure gradients
!! (equal to -dM/dy) in m s-2.
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
intent(in) :: diffu !< Zonal acceleration due to convergence of the
!! along-isopycnal stress tensor, in m s-2.
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
intent(in) :: diffv !< Meridional acceleration due to convergence of
!! the along-isopycnal stress tensor, in m s-2.
real, dimension(SZI_(G),SZJ_(G),SZK_(G)), &
optional, intent(in) :: pbce !< The baroclinic pressure anomaly in each layer
!! due to free surface height anomalies, in
!! m s-2.pbce points to a space with nz layers
!! or NULL. !! NULL.
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
optional, intent(in) :: u_accel_bt !< The zonal acceleration from terms in the
!! barotropic solver,in m s-2.
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
optional, intent(in) :: v_accel_bt !< The meridional acceleration from terms in
!! the barotropic solver,in m s-2.
logical, optional, intent(in) :: symmetric

! This subroutine writes out chksums for the model's accelerations.
! Arguments: mesg - A message that appears on the chksum lines.
Expand Down Expand Up @@ -205,13 +236,24 @@ end subroutine MOM_accel_chksum
! =============================================================================

subroutine MOM_state_stats(mesg, u, v, h, Temp, Salt, G, allowChange, permitDiminishing)
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure
character(len=*), intent(in) :: mesg
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), intent(in) :: u !< The zonal velocity, in m s-1
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), intent(in) :: v !< The meridional velocity, in m s-1
real, dimension(SZI_(G),SZJ_(G),SZK_(G)), intent(in) :: h !< Layer thicknesses, in H (usually m or kg m-2)
real, pointer, dimension(:,:,:), intent(in) :: Temp, Salt
logical, optional, intent(in) :: allowChange, permitDiminishing
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure.
character(len=*), intent(in) :: mesg !< A message that appears on the chksum lines.
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
intent(in) :: u !< The zonal velocity, in m s-1.
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
intent(in) :: v !< The meridional velocity, in m s-1.
real, dimension(SZI_(G),SZJ_(G),SZK_(G)), &
intent(in) :: h !< Layer thicknesses, in H (usually m or kg m-2).
real, pointer, dimension(:,:,:), &
intent(in) :: Temp !< Temperature in degree C.
real, pointer, dimension(:,:,:), &
intent(in) :: Salt !< Salinity, in ppt.

logical, optional, intent(in) :: allowChange !< do not flag an error
!! if the statistics change.
logical, optional, &
intent(in) :: permitDiminishing !< do not flag error
!!if the extrema are diminishing.
! This subroutine monitors statistics for the model's state variables.
! Arguments: mesg - A message that appears on the chksum lines.
! (in) u - Zonal velocity, in m s-1.
Expand Down
Loading