doxygen cleanup

NOAA-GFDL · Jan 28, 2022 · e91c966 · e91c966
1 parent cf1d296
commit e91c966
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/config_src/external/OCEAN_stochastic_phyiscs/MOM_stochastics.F90 b/config_src/external/OCEAN_stochastic_phyiscs/MOM_stochastics.F90
@@ -29,6 +29,7 @@ module MOM_stochastics
 
 public stochastics_init, update_stochastics
 
+!> This control structure holds parameters for the MOM_stochastics module
 type, public:: stochastic_CS
   logical :: do_sppt                 !< If true, stochastically perturb the diabatic
   logical :: pert_epbl       !! If true, then randomly perturb the KE dissipation and genration terms
@@ -105,8 +106,8 @@ subroutine stochastics_init(dt, grid, GV, CS, param_file, diag, Time)
      allocate(pelist(num_procs))
      call Get_PElist(pelist,commID = mom_comm)
      master=root_PE()
-     nx=grid%ied-grid%isd+1
-     ny=grid%jed-grid%jsd+1
+     nx = grid%ied - grid%isd + 1
+     ny = grid%jed - grid%jsd + 1
      call init_stochastic_physics_ocn(dt,grid%geoLonT,grid%geoLatT,nx,ny,GV%ke, &
                                       CS%pert_epbl,CS%do_sppt,master,mom_comm,iret)
      if (iret/=0)  then

diff --git a/config_src/external/OCEAN_stochastic_phyiscs/MOM_stochastics_stub.F90 b/config_src/external/OCEAN_stochastic_phyiscs/MOM_stochastics_stub.F90
@@ -28,11 +28,14 @@ module MOM_stochastics
 
 public stochastics_init, update_stochastics
 
+!> This control structure holds parameters for the MOM_stochastics module
 type, public:: stochastic_CS
-  logical :: do_sppt                 !< If true, stochastically perturb the diabatic
-  logical :: pert_epbl       !! If true, then randomly perturb the KE dissipation and genration terms
+  logical :: do_sppt         !< If true, stochastically perturb the diabatic
+  logical :: pert_epbl       !< If true, then randomly perturb the KE dissipation and genration terms
+  !>@{ Diagnostic IDs
   integer :: id_sppt_wts  = -1
   integer :: id_epbl1_wts=-1,id_epbl2_wts=-1
+  !>@}
   ! stochastic patterns
   real, allocatable :: sppt_wts(:,:)  !< Random pattern for ocean SPPT
                                      !! tendencies with a number between 0 and 2

diff --git a/src/parameterizations/vertical/MOM_energetic_PBL.F90 b/src/parameterizations/vertical/MOM_energetic_PBL.F90
@@ -301,7 +301,6 @@ subroutine energetic_PBL(h_3d, u_3d, v_3d, tv, fluxes, dt, Kd_int, G, GV, US, CS
                  optional, pointer       :: Waves  !< Wave CS
   type(stochastic_CS),  pointer       :: stoch_CS  !< The control structure returned by a previous
 
-
 !    This subroutine determines the diffusivities from the integrated energetics
 !  mixed layer model.  It assumes that heating, cooling and freshwater fluxes
 !  have already been applied.  All calculations are done implicitly, and there