Skip to content

Commit

Permalink
Cleaned up argument descriptions in MOM_continuity
Browse files Browse the repository at this point in the history 
  Cleaned up the argument descriptions in the MOM_continuity and
MOM_continuity_PPM modules, so a grep can now clearly show that all arguments
have dOxyGen comments.  All answers are bitwise identical.
  • Loading branch information
@Hallberg-NOAA
Hallberg-NOAA committed May 3, 2018
1 parent 073b223 commit 75b205c
Show file tree
Hide file tree
Showing 2 changed files with 197 additions and 163 deletions.
70 changes: 44 additions & 26 deletions src/core/MOM_continuity.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,44 +41,62 @@ module MOM_continuity
subroutine continuity(u, v, hin, h, uh, vh, dt, G, GV, CS, uhbt, vhbt, OBC, &
visc_rem_u, visc_rem_v, u_cor, v_cor, &
uhbt_aux, vhbt_aux, u_cor_aux, v_cor_aux, BT_cont)
type(ocean_grid_type), intent(inout) :: G !< Ocean grid structure.
type(verticalGrid_type), intent(in) :: GV !< Vertical grid structure.
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), intent(in) :: u !< Zonal velocity, in m/s.
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), intent(in) :: v !< Meridional velocity, in m/s.
real, dimension(SZI_(G),SZJ_(G),SZK_(G)), intent(in) :: hin !< Initial layer thickness, in m or kg/m2.
real, dimension(SZI_(G),SZJ_(G),SZK_(G)), intent(inout) :: h !< Final layer thickness, in m or kg/m2.
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), intent(out) :: uh !< Volume flux through zonal faces =
!! u*h*dy, in m3/s.
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), intent(out) :: vh !< Volume flux through meridional faces =
!! v*h*dx, in m3/s.
real, intent(in) :: dt !< Time increment, in s.
type(continuity_CS), pointer :: CS !< Control structure for mom_continuity.
real, dimension(SZIB_(G),SZJ_(G)), intent(in), optional :: uhbt !< The vertically summed volume
!! flux through zonal faces, in m3/s.
real, dimension(SZI_(G),SZJB_(G)), intent(in), optional :: vhbt !< The vertically summed volume
!! flux through meridional faces, in m3/s.
type(ocean_OBC_type), pointer, optional :: OBC !< Open boundaries control structure.
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), intent(in), optional :: visc_rem_u !< Both the fraction of
type(ocean_grid_type), intent(inout) :: G !< Ocean grid structure.
type(verticalGrid_type), intent(in) :: GV !< Vertical grid structure.
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
intent(in) :: u !< Zonal velocity, in m/s.
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
intent(in) :: v !< Meridional velocity, in m/s.
real, dimension(SZI_(G),SZJ_(G),SZK_(G)), &
intent(in) :: hin !< Initial layer thickness, in m or kg/m2.
real, dimension(SZI_(G),SZJ_(G),SZK_(G)), &
intent(inout) :: h !< Final layer thickness, in m or kg/m2.
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
intent(out) :: uh !< Volume flux through zonal faces =
!! u*h*dy, in m3/s.
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
intent(out) :: vh !< Volume flux through meridional faces =
!! v*h*dx, in m3/s.
real, intent(in) :: dt !< Time increment, in s.
type(continuity_CS), pointer :: CS !< Control structure for mom_continuity.
real, dimension(SZIB_(G),SZJ_(G)), &
optional, intent(in) :: uhbt !< The vertically summed volume
!! flux through zonal faces, in m3/s.
real, dimension(SZI_(G),SZJB_(G)), &
optional, intent(in) :: vhbt !< The vertically summed volume
!! flux through meridional faces, in m3/s.
type(ocean_OBC_type), &
optional, pointer :: OBC !< Open boundaries control structure.
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
optional, intent(in) :: visc_rem_u !< Both the fraction of
!! zonal momentum that remains after a time-step of viscosity, and the fraction of a time-step's
!! worth of a barotropic acceleration that a layer experiences after viscosity is applied.
!! Non-dimensional between 0 (at the bottom) and 1 (far above the bottom).
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), intent(in), optional :: visc_rem_v !< Both the fraction of
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
optional, intent(in) :: visc_rem_v !< Both the fraction of
!! meridional momentum that remains after a time-step of viscosity, and the fraction of a time-step's
!! worth of a barotropic acceleration that a layer experiences after viscosity is applied.
!! Non-dimensional between 0 (at the bottom) and 1 (far above the bottom).
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), intent(out), optional :: u_cor !< The zonal velocities that
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
optional, intent(out) :: u_cor !< The zonal velocities that
!! give uhbt as the depth-integrated transport, in m/s.
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), intent(out), optional :: v_cor !< The meridional velocities that
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
optional, intent(out) :: v_cor !< The meridional velocities that
!! give vhbt as the depth-integrated transport, in m/s.
real, dimension(SZIB_(G),SZJ_(G)), intent(in), optional :: uhbt_aux !< A second summed zonal
real, dimension(SZIB_(G),SZJ_(G)), &
optional, intent(in) :: uhbt_aux !< A second summed zonal
!! volume flux in m3/s.
real, dimension(SZI_(G),SZJB_(G)), intent(in), optional :: vhbt_aux !< A second summed meridional
real, dimension(SZI_(G),SZJB_(G)), &
optional, intent(in) :: vhbt_aux !< A second summed meridional
!! volume flux in m3/s.
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), intent(inout), optional :: u_cor_aux !< The zonal velocities
real, dimension(SZIB_(G),SZJ_(G),SZK_(G)), &
optional, intent(inout) :: u_cor_aux !< The zonal velocities
!! that give uhbt_aux as the depth-integrated transport, in m/s.
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), intent(inout), optional :: v_cor_aux !< The meridional velocities
real, dimension(SZI_(G),SZJB_(G),SZK_(G)), &
optional, intent(inout) :: v_cor_aux !< The meridional velocities
!! that give vhbt_aux as the depth-integrated transport, in m/s.
type(BT_cont_type), pointer, optional :: BT_cont !< A structure with elements
type(BT_cont_type), &
optional, pointer :: BT_cont !< A structure with elements
!! that describe the effective open face areas as a function of barotropic flow.

if (present(visc_rem_u) .neqv. present(visc_rem_v)) call MOM_error(FATAL, &
Expand Down
Loading

0 comments on commit 75b205c

Please sign in to comment.