[Dart-dev] DART/branches Revision: 11775

dart at ucar.edu dart at ucar.edu
Tue Jun 27 12:04:54 MDT 2017


hendric at ucar.edu
2017-06-27 12:04:54 -0600 (Tue, 27 Jun 2017)
52

updating comments to be consistent with the code.




Modified: DART/branches/rma_par_single_file/assimilation_code/modules/io/direct_netcdf_mod.f90
===================================================================
--- DART/branches/rma_par_single_file/assimilation_code/modules/io/direct_netcdf_mod.f90	2017-06-27 17:23:25 UTC (rev 11774)
+++ DART/branches/rma_par_single_file/assimilation_code/modules/io/direct_netcdf_mod.f90	2017-06-27 18:04:54 UTC (rev 11775)
@@ -160,13 +160,12 @@
 !=================================================
 
 !-------------------------------------------------
-!> Read and transpose variables in cyclic-cyclic
-!> distribution (round robbin)
+!> Read and transpose variables in cyclic-cyclic distribution (round robbin)
 
 subroutine read_transpose(state_ens_handle, name_handle, domain, dart_index, read_single_vars)
 
-type(ensemble_type),       intent(inout) :: state_ens_handle
-type(stage_metadata_type), intent(in)    :: name_handle
+type(ensemble_type),       intent(inout) :: state_ens_handle !< Ensemble handle
+type(stage_metadata_type), intent(in)    :: name_handle      !< Name handle
 integer,                   intent(in)    :: domain           !< Which domain to read
 integer,                   intent(inout) :: dart_index       !< This is for multiple domains
 logical,                   intent(in)    :: read_single_vars !< Read one variable at a time
@@ -209,11 +208,8 @@
 !=================================================
 
 !-------------------------------------------------
-! Routines that were in assim_model_mod.
-!-------------------------------------------------
-!> Creates a diagnostic file(s).
+!> Creates a template file for single file io
 !> Calls the model for any model specific attributes to be written
-!> Leaves the diagnostic file open and passes out a handle: ncFileID (netcdf_file_type)
 
 subroutine initialize_single_file_io(ens_handle, file_handle)
 
@@ -650,11 +646,8 @@
 
 
 !-----------------------------------------------------------
-!> several options for diagnostic files:
-!>  * dart writes the diagnostic file      (all copies, all output time steps in one file)
-!>  * dart writes the diagnostic files     (one copy, all timesteps per file)
-!> 
-!> for single file IO only SINGLE_IO_TASK_ID will write out diagnostic and restart files 
+!> write all variable to a single file including all member,
+!> and optionally inflation, mean, sd
 
 subroutine write_single_file(ens_handle, file_handle)
 
@@ -749,7 +742,6 @@
 !> insert the mean and sd into the input file if the user requests
 !> this assumes that the files has already been closed and the
 !> variables read in.
-!>
 
 subroutine write_augmented_state(ens_handle, file_handle)
 
@@ -820,7 +812,6 @@
 end subroutine write_augmented_state
 
 
-
 !-------------------------------------------------------------------------------
 !> Read in variables from start_var to end_var
 !>@todo FIXME: At the moment, this code is assuming that the variables in the state start
@@ -2160,12 +2151,7 @@
 
 
 !-------------------------------------------------------------------------------
-! DART writing model variables
-!-------------------------------------------------------------------------------
-!> Write state to the last time slice of a file
-!> This routine is called from write_single_file if the model_mod
-!> nc_write_model_vars has returned 
-!> model_mod_will_write_state_varaibles = .false.
+!> Write state to the last time slice of a file when using "single file io".
 
 subroutine write_model_variables(ncFileID, model_state, memindex, curr_ens_time, timeindex)
 
@@ -2226,14 +2212,7 @@
 
 
 !-------------------------------------------------------------------------------
-!> Called if the model_mod is NOT going to write the state variables to
-!> the diagnostic file.
-!> This routine defines the state variables in the ncFileID
-!> Time and copy dimensions are already defined by initialize_single_file_io
-!> State variables are defined:
-!>   variable(dim1, dim2, ...,  copy, time)
-!> If there are multiple domains the variables and dimensions are
-!> given the suffix _d0*, where * is the domain number.
+!> Write model attributes to for each variable when using "single file io" 
 
 subroutine write_model_attributes(ncFileID, member_dimID, time_dimId, file_handle)
 
@@ -2320,7 +2299,8 @@
 
 
 !-----------------------------------------------------------
-!> write out a single variable appending time stamp curr_ens_time
+!> Write out extra copies (if specified in the filter_nml) in the
+!> last time slot.  This is only used for the "single file io"


More information about the Dart-dev mailing list