Merge bgc obc 3

config_src/external/GFDL_ocean_BGC/generic_tracer_utils.F90

@@ -25,6 +25,8 @@ module g_tracer_utils
     character(len=fm_string_len) :: src_var_name !< Tracer source variable name
     character(len=fm_string_len) :: src_var_unit !< Tracer source variable units
     character(len=fm_string_len) :: src_var_gridspec !< Tracer source grid file name
+    character(len=fm_string_len) :: obc_src_file_name !< Boundary condition tracer source filename
+    character(len=fm_string_len) :: obc_src_field_name !< Boundary condition tracer source fieldname
     integer :: src_var_record !< Unknown
     logical :: requires_src_info = .false. !< Unknown
     real    :: src_var_unit_conversion = 1.0 !< This factor depends on the tracer. Ask Jasmin
@@ -61,6 +63,7 @@ module g_tracer_utils
   public :: g_tracer_get_next
   public :: g_tracer_is_prog
   public :: g_diag_type
+  public :: g_tracer_get_obc_segment_props
 
   !> Set the values of various (array) members of the tracer node g_tracer_type
   !!
@@ -286,6 +289,14 @@ subroutine g_tracer_get_next(g_tracer,g_tracer_next)
     type(g_tracer_type), pointer :: g_tracer_next !< Pointer to the next tracer node in the list
   end subroutine g_tracer_get_next
 
+  subroutine g_tracer_get_obc_segment_props(g_tracer_list, name, obc_has, src_file, src_var_name)
+    type(g_tracer_type), pointer    :: g_tracer_list !< pointer to the head of the generic tracer list
+    type(g_tracer_type), pointer    :: g_tracer !< Pointer to tracer node
+    character(len=*),         intent(in) :: name
+    logical,                  intent(out):: obc_has                !<.true. if This tracer has OBC  
+    character(len=*),optional,intent(out):: src_file, src_var_name !<OBC source file and variable in file
+  end subroutine g_tracer_get_obc_segment_props
+
   !>Vertical Diffusion of a tracer node
   !!
   !! This subroutine solves a tridiagonal equation to find and set values of vertically diffused field

src/core/MOM.F90

@@ -278,6 +278,10 @@ module MOM
                                      !! calculated, and if it is 0, dtbt is calculated every step.
   type(time_type) :: dtbt_reset_interval !< A time_time representation of dtbt_reset_period.
   type(time_type) :: dtbt_reset_time !< The next time DTBT should be calculated.
+  real            :: dt_obc_seg_period!< The time interval between OBC segment updates for OBGC tracers
+  type(time_type) :: dt_obc_seg_interval !< A time_time representation of dt_obc_seg_period.
+  type(time_type) :: dt_obc_seg_time !< The next time OBC segment update is applied to OBGC tracers.
+
   real, dimension(:,:), pointer :: frac_shelf_h => NULL() !< fraction of total area occupied
                                      !! by ice shelf [nondim]
   real, dimension(:,:,:), pointer :: &
@@ -1032,7 +1036,6 @@ subroutine step_MOM_dynamics(forces, p_surf_begin, p_surf_end, dt, dt_thermo, &
 
   integer :: i, j, k, is, ie, js, je, Isq, Ieq, Jsq, Jeq, nz
   integer :: isd, ied, jsd, jed, IsdB, IedB, JsdB, JedB
-
   real, dimension(SZI_(CS%G),SZJ_(CS%G),SZK_(CS%G)+1) :: eta_por ! layer interface heights
                                                     !! for porous topo. [Z ~> m or 1/eta_to_m]
   G => CS%G ; GV => CS%GV ; US => CS%US ; IDs => CS%IDs
@@ -1078,6 +1081,17 @@ subroutine step_MOM_dynamics(forces, p_surf_begin, p_surf_end, dt, dt_thermo, &
     call disable_averaging(CS%diag)
   endif
 
+  !OBC segment data update for some fields can be less frequent than others 
+  if(associated(CS%OBC)) then
+    CS%OBC%update_OBC_seg_data = .false.
+    if (CS%dt_obc_seg_period == 0.0) CS%OBC%update_OBC_seg_data = .true.
+    if (CS%dt_obc_seg_period > 0.0) then
+     if (Time_local >= CS%dt_obc_seg_time) then  !### Change >= to > here.
+      CS%OBC%update_OBC_seg_data = .true.
+      CS%dt_obc_seg_time = CS%dt_obc_seg_time + CS%dt_obc_seg_interval
+     endif
+    endif
+  endif
 
   if (CS%do_dynamics .and. CS%split) then !--------------------------- start SPLIT
     ! This section uses a split time stepping scheme for the dynamic equations,
@@ -1996,6 +2010,14 @@ subroutine initialize_MOM(Time, Time_init, param_file, dirs, CS, restart_CSp, &
                  units="s", default=default_val, do_not_read=(dtbt > 0.0))
   endif
 
+  CS%dt_obc_seg_period = -1.0
+  call get_param(param_file, "MOM", "DT_OBC_SEG_UPDATE_OBGC", CS%dt_obc_seg_period, &
+               "The time between OBC segment data updates for OBGC tracers. "//&
+               "This must be an integer multiple of DT and DT_THERM. "//&
+               "The default is set to DT.", &
+               units="s", default=CS%dt)
+
+
   ! This is here in case these values are used inappropriately.
   use_frazil = .false. ; bound_salinity = .false.
   CS%tv%P_Ref = 2.0e7*US%kg_m3_to_R*US%m_s_to_L_T**2
@@ -2400,11 +2422,6 @@ subroutine initialize_MOM(Time, Time_init, param_file, dirs, CS, restart_CSp, &
            CS%dyn_unsplit_CSp)
   endif
 
-  ! This subroutine calls user-specified tracer registration routines.
-  ! Additional calls can be added to MOM_tracer_flow_control.F90.
-  call call_tracer_register(HI, GV, US, param_file, CS%tracer_flow_CSp, &
-                            CS%tracer_Reg, restart_CSp)
-
   call MEKE_alloc_register_restart(HI, param_file, CS%MEKE, restart_CSp)
   call set_visc_register_restarts(HI, GV, param_file, CS%visc, restart_CSp)
   call mixedlayer_restrat_register_restarts(HI, param_file, &
@@ -2433,7 +2450,16 @@ subroutine initialize_MOM(Time, Time_init, param_file, dirs, CS, restart_CSp, &
     ! could occur with the call to update_OBC_data or after the main initialization.
     if (use_temperature) &
       call register_temp_salt_segments(GV, CS%OBC, CS%tracer_Reg, param_file)
+  endif
 
+  ! This subroutine calls user-specified tracer registration routines.
+  ! Additional calls can be added to MOM_tracer_flow_control.F90.
+  ! Needs to be after registering temperature and salinity OBCs above,
+  ! or else the user-specified tracers will be first.
+  call call_tracer_register(HI, GV, US, param_file, CS%tracer_flow_CSp, &
+                            CS%tracer_Reg, restart_CSp, CS%OBC)
+
+  if (associated(CS%OBC)) then
     ! This needs the number of tracers and to have called any code that sets whether
     ! reservoirs are used.
     call open_boundary_register_restarts(HI, GV, CS%OBC, CS%tracer_Reg, &
@@ -2728,6 +2754,12 @@ subroutine initialize_MOM(Time, Time_init, param_file, dirs, CS, restart_CSp, &
             CS%ntrunc, cont_stencil=CS%cont_stencil)
   endif
 
+  !Set OBC segment data update period
+  if (associated(CS%OBC) .and. CS%dt_obc_seg_period > 0.0) then
+    CS%dt_obc_seg_interval = real_to_time(CS%dt_obc_seg_period)
+    CS%dt_obc_seg_time = Time + CS%dt_obc_seg_interval
+  endif
+
   call callTree_waypoint("dynamics initialized (initialize_MOM)")
 
   CS%mixedlayer_restrat = mixedlayer_restrat_init(Time, G, GV, US, param_file, diag, &