Memory leak: w3iorsmd.F90

[MatthewMasarik-NOAA]

Pull Request Summary

Fixes memory leaks in w3iorsmd.F90.

Description

Provide a detailed description of what this PR does.

• Fixes memory leaks in the restart module, w3iorsmd.F90, related to ALLOCATED arrays as well as OPENed file units (closing these releases associated IO buffers).
  • DEALLOCATE and CLOSE statements are added before a 'bail out' RETURN statement.
  • The same logic around the OPEN statement for the restart file unit, NDSR, is reproduced before the main RETURN statement.

What bug does it fix, or what feature does it add?

• This addresses (but does not close at this time) WW3 issue Memory Leak #579, which was created due to UFS issue #779. I believe Memory Leak #579 should remain open as two additional leaks reported by valgrind are investigated.

Is a change of answers expected from this PR?

• No.

Please also include the following information:

• Mention any labels that should be added:
  • bug
• Are answer changes expected from this PR?
  • No. This fix passed the UFS cpld_bmark_p7 regtest, as well as matrix.comp.

Issue(s) addressed

• Addresses (does not close) Memory Leak #579, as well as UFS issue #779.

Commit Message

w3iorsmd: fixes memory leaks

Check list

• Branch is up to date with the authoritative repository (NOAA-EMC) develop branch.
• Checked the checklist for a developer submitting to develop.
• [na] If a version number update is required, checked the updating version number checklist.
• [na] If a new feature was added, a regression test for testing the new feature is added.

Testing

• How were these changes tested?
  • UFS regression test cpld_bmark_p7 was run with the fix and passed.
  • The same test was also run with WW3 develop for comparison. Each of these runs had ESMF memory profiling turned on. This plot compares the mean memory use for both runs at each timestep.

• Lastly the full matrix was run for develop and fix. Matrix.comp returned only the expected differences for the non-identical cases.

• Are the changes covered by regression tests? (If not, why? Do new tests need to be added?)

  • Yes. A new feature is not being added. Memory leaks were fixed, so running these changes against develop in the full matrix confirms that answers have not changed.

• Have the matrix regression tests been run (if yes, please note HPC and compiler)?

  • Yes. Hera/Intel.

• Please provide the summary output of matrix.comp (matrix.Diff.txt, matrixCompFull.txt and matrixCompSummary.txt):

  • matrixCompSummary.txt
  • matrixCompFull.txt
  • matrixDiff.txt

• Please indicate the expected changes in the regression test output (Note the known list of non-identical tests).

  • The only changes are within the list of expected differences.

• Please provide the summary output of matrix.comp (matrix.Diff.txt, matrixCompFull.txt and matrixCompSummary.txt):

**********************************************************************
********************* non-identical cases ****************************
**********************************************************************
mww3_test_03/./work_PR2_UQ_MPI_d2                     (6 files differ)
mww3_test_03/./work_PR3_UNO_MPI_d2_c                     (8 files differ)
mww3_test_03/./work_PR3_UNO_MPI_d2                     (7 files differ)
mww3_test_03/./work_PR2_UNO_MPI_d2                     (6 files differ)
mww3_test_03/./work_PR1_MPI_d2                     (11 files differ)
mww3_test_03/./work_PR3_UQ_MPI_d2_c                     (8 files differ)
mww3_test_03/./work_PR3_UQ_MPI_d2                     (8 files differ)
ww3_tp2.10/./work_MPI_OMPH                     (7 files differ)
ww3_tp2.16/./work_MPI_OMPH                     (5 files differ)
ww3_ufs1.1/./work_d                     (0 files differ)
ww3_ufs1.2/./work_b                     (0 files differ)
ww3_ufs1.3/./work_a                     (1 files differ)
 
**********************************************************************
************************ identical cases *****************************
**********************************************************************

[JessicaMeixner-NOAA]

@aliabdolali have you run the regtests or do you need me to?

[aliabdolali]

The regtests ran successfully with pre-known non-b4b cases:

**********************************************************************
********************* non-identical cases ****************************
**********************************************************************
mww3_test_03/./work_PR2_UQ_MPI_d2                     (8 files differ)
mww3_test_03/./work_PR2_UNO_MPI_d2                     (6 files differ)
mww3_test_03/./work_PR3_UQ_MPI_d2_c                     (8 files differ)
mww3_test_03/./work_PR1_MPI_d2                     (7 files differ)
mww3_test_03/./work_PR3_UNO_MPI_d2_c                     (8 files differ)
mww3_test_03/./work_PR3_UNO_MPI_d2                     (6 files differ)
mww3_test_03/./work_PR3_UQ_MPI_d2                     (9 files differ)
ww3_tp2.10/./work_MPI_OMPH                     (6 files differ)
ww3_tp2.16/./work_MPI_OMPH                     (4 files differ)
ww3_ufs1.1/./work_d                     (0 files differ)
ww3_ufs1.2/./work_b                     (0 files differ)
ww3_ufs1.3/./work_a                     (1 files differ)

matrixCompFull.txt
matrixCompSummary.txt
matrixDiff.txt