+Revise MOM_IceShelf available diags file format

  Revised the MOM_ice_shelf_diag_mediator code that creates the
MOM_IceShelf.available_diags file to follow the same pattern of logging as the
rest of MOM6.  The specific changes include moving the module name(s) to their
own line, adding static diagnostics to the variables that are logged in the
available_diags file (however, the ice shelf code does not have any static
diagnostics yet), logging the axes of the diagnostic, and adding cell metrics to
describe how a diagnostic might be reduced and logging these as well.  All
solutions are bitwise identical, but there are new entries and added information
in the MOM_IceShelf.available_diags files.

Author: Hallberg-NOAA

src/ice_shelf/MOM_ice_shelf_diag_mediator.F90

@@ -715,7 +715,8 @@ function register_MOM_IS_diag_field(module_name, field_name, axes_in, init_time,
   type(diag_ctrl), pointer :: diag_cs => NULL() ! A structure that is used to regulate diagnostic output
   type(axes_grp), pointer :: axes
   integer :: dm_id
-  character(len=256) :: msg, cm_string
+  character(len=256) :: msg
+  character(len=256) :: cm_string ! A string describing the cell methods returned from attach_cell_methods.
   character(len=256) :: new_module_name
   character(len=480) :: module_list, var_list
   character(len=24)  :: dimensions
@@ -775,9 +776,7 @@ function register_MOM_IS_diag_field(module_name, field_name, axes_in, init_time,
   if (is_root_pe() .and. (diag_CS%available_diag_doc_unit > 0)) then
     msg = ''
     if (present(cmor_field_name)) msg = 'CMOR equivalent is "'//trim(cmor_field_name)//'"'
-    cm_string = ''
-    !### Uncoment this to add cell methods:
-    ! call attach_cell_methods(-1, axes, cm_string, cell_methods, x_cell_method, y_cell_method)
+    call attach_cell_methods(-1, axes, cm_string, cell_methods, x_cell_method, y_cell_method)
     module_list = trim(module_list)//"}"
     if (num_modnm <= 1) module_list = module_name
     if (num_varnm <= 1) var_list = ''
@@ -839,7 +838,8 @@ logical function register_diag_field_expand_cmor(dm_id, module_name, field_name,
   type(diag_ctrl), pointer :: diag_cs => null()
   type(diag_type), pointer :: this_diag => null()
   integer :: fms_id
-  character(len=256) :: posted_cmor_units, posted_cmor_standard_name, posted_cmor_long_name, cm_string
+  character(len=256) :: posted_cmor_units, posted_cmor_standard_name, posted_cmor_long_name
+  character(len=256) :: cm_string ! A string describing the cell methods returned from attach_cell_methods.
 
   MOM_missing_value = axes%diag_cs%missing_value
   if (present(missing_value)) MOM_missing_value = missing_value
@@ -854,9 +854,7 @@ logical function register_diag_field_expand_cmor(dm_id, module_name, field_name,
              verbose=verbose, do_not_log=do_not_log, err_msg=err_msg, &
              interp_method=interp_method, tile_count=tile_count)
   if (.not. diag_cs%diag_as_chksum) &
-    cm_string = ''
-    !### Uncoment this to add cell methods:
-    ! call attach_cell_methods(fms_id, axes, cm_string, cell_methods, x_cell_method, y_cell_method)
+    call attach_cell_methods(fms_id, axes, cm_string, cell_methods, x_cell_method, y_cell_method)
 
   this_diag => null()
   if (fms_id /= DIAG_FIELD_NOT_FOUND) then
@@ -888,9 +886,7 @@ logical function register_diag_field_expand_cmor(dm_id, module_name, field_name,
                missing_value=MOM_missing_value, range=range, mask_variant=mask_variant,               &
                standard_name=trim(posted_cmor_standard_name), verbose=verbose, do_not_log=do_not_log, &
                err_msg=err_msg, interp_method=interp_method, tile_count=tile_count)
-    cm_string = ''
-    !### Uncoment this to add cell methods:
-    ! call attach_cell_methods(fms_id, axes, cm_string, cell_methods, x_cell_method, y_cell_method)
+    call attach_cell_methods(fms_id, axes, cm_string, cell_methods, x_cell_method, y_cell_method)
 
     this_diag => null()
     if (fms_id /= DIAG_FIELD_NOT_FOUND) then
@@ -1378,8 +1374,7 @@ function register_MOM_IS_static_field(module_name, field_name, axes, &
   if (len_trim(dimensions) > 0) dimensions = trim_trailing_commas(dimensions)
 
   ! Document diagnostics in list of available diagnostics
-  !### if (is_root_pe() .and. diag_CS%available_diag_doc_unit > 0) then
-  if (is_root_pe() .and. .false.) then  ! Replace this to work like MOM6.
+  if (is_root_pe() .and. diag_CS%available_diag_doc_unit > 0) then
     if (present(cmor_field_name)) then
       call log_available_diag(associated(diag), module_name, field_name, '', '', diag_CS, &
                               long_name, units, standard_name, &
@@ -1728,34 +1723,25 @@ subroutine log_available_diag(used, module_name, field_name, cell_methods_string
   character(len=240) :: mesg
 
   if (used) then
-    mesg = '"'//trim(module_name)//'", "'//trim(field_name)//'"  [Used]'
+    mesg = '"'//trim(field_name)//'"  [Used]'
   else
-    mesg = '"'//trim(module_name)//'", "'//trim(field_name)//'"  [Unused]'
+    mesg = '"'//trim(field_name)//'"  [Unused]'
   endif
-  !### This form of output agrees with MOM_diag_manager:
-!  if (used) then
-!    mesg = '"'//trim(field_name)//'"  [Used]'
-!  else
-!    mesg = '"'//trim(field_name)//'"  [Unused]'
-!  endif
   if (len(trim((comment)))>0) then
     write(diag_CS%available_diag_doc_unit, '(a,1x,"(",a,")")') trim(mesg),trim(comment)
   else
     write(diag_CS%available_diag_doc_unit, '(a)') trim(mesg)
   endif
-  !### These should be uncommented later to align with MOM_diag_manager:
-! call describe_option("modules", module_name, diag_CS)
-! if (present(dimensions)) then
-!   if (len(trim(dimensions)) > 0) then
-!     call describe_option("dimensions", dimensions, diag_CS)
-!   endif
-! endif
+  call describe_option("modules", module_name, diag_CS)
+  if (present(dimensions)) then ; if (len(trim(dimensions)) > 0) then
+    call describe_option("dimensions", dimensions, diag_CS)
+  endif ; endif
   if (present(long_name)) call describe_option("long_name", long_name, diag_CS)
   if (present(units)) call describe_option("units", units, diag_CS)
   if (present(standard_name)) &
     call describe_option("standard_name", standard_name, diag_CS)
-! if (len(trim((cell_methods_string)))>0) &
-!   call describe_option("cell_methods", trim(cell_methods_string), diag_CS)
+  if (len(trim((cell_methods_string)))>0) &
+    call describe_option("cell_methods", trim(cell_methods_string), diag_CS)
   if (present(variants)) then ; if (len(trim(variants)) > 0) then
     call describe_option("variants", variants, diag_CS)
   endif ; endif