[Dart-dev] DART/branches Revision: 12632

[dart at ucar.edu]

nancy at ucar.edu
2018-06-05 14:26:18 -0600 (Tue, 05 Jun 2018)
335
reorder the functions to group similiar ones together;
add the binary sort routine; start to funnel output through
the 'log_it()' routine which writes a string to both 
the logfile and standard output with a single call;
try to consolidate replicated code; and begin to convert
to our style guide for separators and doxygen comments.




Modified: DART/branches/recam/assimilation_code/modules/utilities/utilities_mod.f90
===================================================================
--- DART/branches/recam/assimilation_code/modules/utilities/utilities_mod.f90	2018-06-05 20:22:44 UTC (rev 12631)
+++ DART/branches/recam/assimilation_code/modules/utilities/utilities_mod.f90	2018-06-05 20:26:18 UTC (rev 12632)
@@ -6,134 +6,6 @@
 
 module utilities_mod
 
-!-----------------------------------------------------------------------
-!
-!   A collection of simple useful routines:
-!
-!      file_exist       Function that returns if a given
-!                       file name exists
-!
-!      get_unit         Function that returns an available 
-!                       Fortran unit number
-!
-!      error_handler    Print warning and error messages, 
-!                       terminates program for error messages.
-!
-!      open_file        Opens a given file name for i/o and returns
-!                       a unit number.  If the file is already open
-!                       the unit number is returned.
-!
-!      close_file       Closes the given unit_number. If the file is 
-!                       already closed, nothing happens.
-!
-!      initialize_utilities    Call this routine once before using any
-!                              of the other routines in this file.  If you
-!                              are using the MPI library, do not call this
-!                              routine -- call mpi_initialize_utilities instead.
-!                              It will call this routine as part of initializing
-!                              the MPI code.
-!
-!      finalize_utilities      Call this routine at the end of a program to close
-!                              the log file and flush pending output.  For an MPI
-!                              program, call mpi_finalize_utilities instead.
-!
-!      dump_unit_attributes    A debug routine that dumps out a long list of
-!                              attributes that can be queried from an open file unit.
-!
-!      set_output       Set the status of printing.  Can be set on a per-task
-!                       basis if you are running with multiple tasks.
-!                       By default all warnings and errors print no matter
-!                       which task executes the code; messages only print
-!                       from task 0 to avoid N copies of identical messages.
-!
-!      do_output        Logical function which returns whether informational
-!                       messages should be output.  Controlled by the setting
-!                       made from set_output.  Useful for messages which cannot
-!                       go through the normal error handler (e.g. namelists).
-!
-!      find_namelist_in_file   Opens the namelist file and verifies the given
-!                              namelist name exists.  If found, rewind the file
-!                              and return true.  Then a F90 namelist read command
-!                              can be used to read in the namelist values.
-!                              Otherwise, print an error message and terminate.
-!
-!      check_namelist_read    Confirms that a namelist read was successful. 
-!                             If it failed print an error message and terminate.
-!
-!      set_nml_output   Set the status of printing namelist data.  By default,
-!                       only print to the nml log file.  Can be set to print
-!                       to stdout, both, or none.  Argument is a string; valid
-!                       values are 'none', 'file', 'terminal', or 'both'.
-!
-!      do_nml_file      Logical function which returns whether informational
-!                       messages should be output to the file.  Controlled
-!                       by a call to set_nml_output().
-!                     
-!      do_nml_term      Logical function which returns whether informational
-!                       messages should be output to * (unit 6?).  Controlled
-!                       by a call to set_nml_output().
-!
-!      set_tasknum      Only called for an MPI job with multiple tasks.
-!                       Sets the 'multi-task' flag and records the local task
-!                       number for later error and info messages.
-!
-!      nc_check         Check netcdf return codes, and if not ok, extract
-!                       the netcdf error string and pass that to the error
-!                       handler routine.  Two optional strings allow the caller
-!                       to provide the subroutine name and some context.
-!
-!      write_time       Writes a timestamp in a standard format.
-!
-!      logfileunit      Global integer unit numbers for the log file and
-!      nmlfileunit      for the namelist file (which defaults to same as log)
-!
-!      to_upper         converts a character string to uppercase.
-!
-!      find_textfile_dims    finds number of lines and max line length in a 
-!                            text file. Used so we can record the namelist 
-!                            file content in the netcdf output files.
-!
-!      file_to_text     converts the contents of a (hopefully small) file to
-!                       a single text variable ... to record in the
-!                       netcdf output files.
-!
-!      get_next_filename     returns the next filename, given the name of
-!                            an ascii file which contains a filename per line.