Version 2020.01

[2020.01] - 2020-03-13

Added

• Adds the modules axis_utils2, mosaic2, and time_interp_external2 that use fms2_io
• Adds unit tests for thread affinity in test_fms/affinity
• Autotools unit tests are now run with srun, mpirun, or aprun (whichever is present on your system)
• fms2_io provides three new derived types, which target the different I/O paradigms used in GFDL GCMs:
  • type(FmsNetcdfFile_t) - This type provides a thin wrapper over the netCDF4 library, but allows the user to assign a “pelist” to the file. If a pelist is assigned, only the first rank on the list directly interacts with the netCDF library, and performs broadcasts to relay the information to the rest of the ranks on the list. This derived type also allows the user to perform “compressed” reads/writes and restart variable “registration” (i.e. the ability to store pointers to user-defined/allocated buffers) and reads/writes in a manner similar to the existing calls in fms_io.
  • type(FmsNetcdfUnstructuredDomainFile_t) - This type extends the FmsNetcdfFile_t type to support “domain-decomposed” reads/writes on a user defined mpp_domains unstructured grid. Users are required to inform the FMS2_io module which dimensions correspond to the unstructured grid using the appropriate register_axis call before any domain-decomposed reads/writes can be performed.
  • type(FmsNetcdfDomainFile_t) - This type extends the FmsNetcdfFile_t type to support “domain-decomposed” reads/writes on a user-defined mpp_domains two-dimensional lon-lat or cubed-sphere grid. Users are required to inform the fms2_io module which dimensions (‘x’ or ‘y’) correspond to the two-dimensional grid using the appropriate register_axis calls before any domain-decomposed reads/writes can be performed.
• fms2_io requires the user to manage objects of the types described above. Calls to open_file (close_file) act as constructors (destructors) for each of the objects, and must be explicitly made by the user. Each object must be constructed before any I/O can be performed. Examples describing how to use these new types are available in test_fms/fms2_io
• fms2_io treats _FillValue attributes as valid_max or valid_min range specifiers if none of valid_range, valid_min, and valid_max are specified as described in these netcdf conventions

Changed

• The diag_manager IO is handled by fms2_io instead of mpp_io. Default behavior assumes that the mpp_io namelist variable is set to cf_compliant = .true.
• The user must specify the diagnostic attributes that they want to write to the output files. Example: If there is no units attribute, then the variable metadata will not include units, and it will not automatically add units = “none”.
• Calls to register_diag_axis for an X or Y axis that is shifted from the CENTER position need to include the optional argument domain_position and should be equal to EAST or NORTH based on the position relative to the domain. EAST and NORTH are exposed through diag_manager_mod.
• Changed the handling of average_T and time_bnds variables so that they are set to values that are sent in and are not manipulated as was the case in mpp_io.
• interpolator, xgrid, data_override, and amip_interp now call fms2_io routines
• Support for enabling/disabling quad-precision (used in certain calculations) has been changed to a hard on/off switch. Default behavior is quad-precision disabled. To enable, add the following CPP macro -DENABLE_QUAD_PRECISION. This change was necessary to remove guessing at the proper setting via a mix of compiler vendor and system-defined environment variables which resulted in different behaviors on machines unbeknownst to the user.

Deprecated

• fms2_io does NOT use the scale_factor, add_offset, or other attributes to manipulate the data. The variable/data is returned to the caller as it appears in the file. All post-read data manipulations should be handled by the caller.

Removed

• Removes the use of bats when running unit tests

Known Issues

• Axis for regional diagnostics are not written correctly.