Skip to content

Commit

Permalink
Documented miscellaneous variable units
Browse files Browse the repository at this point in the history 
  Changed comments to use the square bracket notation to document the units of
about 500 additional variables.  Also corrected the name of bad_val_col_thick.
Also eliminated several redundant argument documentation blocks.  Only comments
have been changed and all answers are bitwise identical.
  • Loading branch information
@Hallberg-NOAA
Hallberg-NOAA committed Dec 21, 2018
1 parent 00a8cdc commit 78e9659
Show file tree
Hide file tree
Showing 55 changed files with 485 additions and 522 deletions.
133 changes: 66 additions & 67 deletions config_src/coupled_driver/MOM_surface_forcing.F90
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion config_src/ice_solo_driver/user_surface_forcing.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ subroutine USER_buoyancy_forcing(sfc_state, fluxes, day, dt, G, CS)
type(forcing), intent(inout) :: fluxes !< A structure containing thermodynamic forcing fields
type(time_type), intent(in) :: day !< The time of the fluxes
real, intent(in) :: dt !< The amount of time over which
!! the fluxes apply, in s
!! the fluxes apply [s]
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure
type(user_surface_forcing_CS), pointer :: CS !< A pointer to the control structure returned
!! by a previous call to user_surface_forcing_init
Expand Down
2 changes: 1 addition & 1 deletion config_src/solo_driver/MESO_surface_forcing.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ subroutine MESO_buoyancy_forcing(sfc_state, fluxes, day, dt, G, CS)
type(forcing), intent(inout) :: fluxes !< A structure containing thermodynamic forcing fields
type(time_type), intent(in) :: day !< The time of the fluxes
real, intent(in) :: dt !< The amount of time over which
!! the fluxes apply, in s
!! the fluxes apply [s]
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure
type(MESO_surface_forcing_CS), pointer :: CS !< A pointer to the control structure returned by
!! a previous call to MESO_surface_forcing_init
Expand Down
10 changes: 5 additions & 5 deletions config_src/solo_driver/MOM_driver.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -127,14 +127,14 @@ program MOM_main
type(time_type) :: restart_time ! The next time to write restart files.
type(time_type) :: Time_step_ocean ! A time_type version of dt_forcing.

real :: elapsed_time = 0.0 ! Elapsed time in this run in seconds.
real :: elapsed_time = 0.0 ! Elapsed time in this run [s].
logical :: elapsed_time_master ! If true, elapsed time is used to set the
! model's master clock (Time). This is needed
! if Time_step_ocean is not an exact
! representation of dt_forcing.
real :: dt_forcing ! The coupling time step in seconds.
real :: dt ! The baroclinic dynamics time step, in seconds.
real :: dt_off ! Offline time step in seconds
real :: dt_forcing ! The coupling time step [s].
real :: dt ! The baroclinic dynamics time step [s].
real :: dt_off ! Offline time step [s].
integer :: ntstep ! The number of baroclinic dynamics time steps
! within dt_forcing.
real :: dt_therm
Expand All @@ -150,7 +150,7 @@ program MOM_main
! restart file is saved at the end of a run segment
! unless Restart_control is negative.

real :: Time_unit ! The time unit in seconds for the following input fields.
real :: Time_unit ! The time unit for the following input fields [s].
type(time_type) :: restint ! The time between saves of the restart file.
type(time_type) :: daymax ! The final day of the simulation.

Expand Down
12 changes: 6 additions & 6 deletions config_src/solo_driver/MOM_surface_forcing.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -226,7 +226,7 @@ subroutine set_forcing(sfc_state, forces, fluxes, day_start, day_interval, G, US
type(surface_forcing_CS), pointer :: CS !< pointer to control struct returned by
!! a previous surface_forcing_init call
! Local variables
real :: dt ! length of time in seconds over which fluxes applied
real :: dt ! length of time over which fluxes applied [s]
type(time_type) :: day_center ! central time of the fluxes.
integer :: isd, ied, jsd, jed
isd = G%isd ; ied = G%ied ; jsd = G%jsd ; jed = G%jed
Expand Down Expand Up @@ -735,7 +735,7 @@ subroutine buoyancy_forcing_from_files(sfc_state, fluxes, day, dt, G, CS)
type(forcing), intent(inout) :: fluxes !< A structure containing thermodynamic forcing fields
type(time_type), intent(in) :: day !< The time of the fluxes
real, intent(in) :: dt !< The amount of time over which
!! the fluxes apply, in s
!! the fluxes apply [s]
type(ocean_grid_type), intent(inout) :: G !< The ocean's grid structure
type(surface_forcing_CS), pointer :: CS !< pointer to control struct returned by
!! a previous surface_forcing_init call
Expand Down Expand Up @@ -1013,7 +1013,7 @@ subroutine buoyancy_forcing_from_data_override(sfc_state, fluxes, day, dt, G, CS
type(forcing), intent(inout) :: fluxes !< A structure containing thermodynamic forcing fields
type(time_type), intent(in) :: day !< The time of the fluxes
real, intent(in) :: dt !< The amount of time over which
!! the fluxes apply, in s
!! the fluxes apply [s]
type(ocean_grid_type), intent(inout) :: G !< The ocean's grid structure
type(surface_forcing_CS), pointer :: CS !< pointer to control struct returned by
!! a previous surface_forcing_init call
Expand Down Expand Up @@ -1179,7 +1179,7 @@ subroutine buoyancy_forcing_zero(sfc_state, fluxes, day, dt, G, CS)
type(forcing), intent(inout) :: fluxes !< A structure containing thermodynamic forcing fields
type(time_type), intent(in) :: day !< The time of the fluxes
real, intent(in) :: dt !< The amount of time over which
!! the fluxes apply, in s
!! the fluxes apply [s]
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure
type(surface_forcing_CS), pointer :: CS !< pointer to control struct returned by
!! a previous surface_forcing_init call
Expand Down Expand Up @@ -1222,7 +1222,7 @@ subroutine buoyancy_forcing_const(sfc_state, fluxes, day, dt, G, CS)
type(forcing), intent(inout) :: fluxes !< A structure containing thermodynamic forcing fields
type(time_type), intent(in) :: day !< The time of the fluxes
real, intent(in) :: dt !< The amount of time over which
!! the fluxes apply, in s
!! the fluxes apply [s]
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure
type(surface_forcing_CS), pointer :: CS !< pointer to control struct returned by
!! a previous surface_forcing_init call
Expand Down Expand Up @@ -1264,7 +1264,7 @@ subroutine buoyancy_forcing_linear(sfc_state, fluxes, day, dt, G, CS)
type(forcing), intent(inout) :: fluxes !< A structure containing thermodynamic forcing fields
type(time_type), intent(in) :: day !< The time of the fluxes
real, intent(in) :: dt !< The amount of time over which
!! the fluxes apply, in s
!! the fluxes apply [s]
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure
type(surface_forcing_CS), pointer :: CS !< pointer to control struct returned by
!! a previous surface_forcing_init call
Expand Down
2 changes: 1 addition & 1 deletion config_src/solo_driver/user_surface_forcing.F90
View file
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ subroutine USER_buoyancy_forcing(sfc_state, fluxes, day, dt, G, CS)
type(forcing), intent(inout) :: fluxes !< A structure containing thermodynamic forcing fields
type(time_type), intent(in) :: day !< The time of the fluxes
real, intent(in) :: dt !< The amount of time over which
!! the fluxes apply, in s
!! the fluxes apply [s]
type(ocean_grid_type), intent(in) :: G !< The ocean's grid structure
type(user_surface_forcing_CS), pointer :: CS !< A pointer to the control structure returned
!! by a previous call to user_surface_forcing_init
Expand Down
Loading

0 comments on commit 78e9659

Please sign in to comment.