Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clean up orography code #987

Open
wants to merge 57 commits into
base: develop
Choose a base branch
from
Open

Clean up orography code #987

wants to merge 57 commits into from

Conversation

GeorgeGayno-NOAA
Copy link
Collaborator

@GeorgeGayno-NOAA GeorgeGayno-NOAA commented Sep 24, 2024 •
edited
Loading

DESCRIPTION OF CHANGES:

Clean up orography code.

  • Remove unused subroutines and logic.
  • Move utility routines to their own module.
  • Move i/o routines to their own module.
  • Remove dependency on IP and SP libraries
  • Add some unit testing.

TESTS CONDUCTED:

  • Compile branch on all Tier 1 machines using Intel (Orion, Jet, Hera, Hercules and WCOSS2). Done using 2de84bc.
  • Compile branch on Hera using GNU. Done using 2de84bc.
  • Compile branch in 'Debug' mode on WCOSS2. Done using 2de84bc.
  • Run unit tests locally on any Tier 1 machine. Done on Hera using 2de84bc. All tests passed, including the three new orog tests. Tests were done using both Intel and Gnu.
  • Run grid_gen consistency tests locally on all Tier 1 machines (using Intel). Done using 2de84bc on Jet, Hera, Hercules, Orion and WCOSS2. All tests passed.

Additional tests:

  • The branch at 2de84bc was compiled in 'debug' mode (using Intel) on WCOSS2. All grid_gen consistency tests failed, but differences were considered 'round-off'.
  • The branch at 2de84bc was compiled in 'release' mode (using Intel) on Hercules. A global uniform C1152 grid was successfully created.
  • The branch at 2de84bc was compiled in 'debug' mode (using Intel) on Hercules. A global uniform C1152 grid was successfully created.
  • The branch at 2de84bc was compiled in 'release' mode using Gnu on Hera. A global uniform C768 grid was successfully created.

DEPENDENCIES:

None.

DOCUMENTATION:

Doxygen was built (with no warnings) on Hera using 2de84bc.

ISSUE:

Fixes #970.

GeorgeGayno-NOAA and others added 30 commits June 27, 2024 19:53
@GeorgeGayno-NOAA
Remove spectral filtering of topography.
a4b7d50 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Cleanup related to the removal of the spectral terrain
09928c7 
filter step.

Fixes ufs-community#970.
@GeorgeGayno-NOAA
Remove filtered orography array, which is no longer needed.
a350cb0 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Remove computation of latitude for obsolete gaussian grids.
a052eef 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
More clean up.
14c0faf 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Remove some logic associated with obsolete routine makeoa3.
c848aeb 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Remove obsolete routine MAKEOA3 and some functions.
65c9ece 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Remove obsolete routine makeoa.
40b3114 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Remove dependency on IPLIB.
54a0a3e 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Remove obsolete routine MAKEPC.
320b8f8 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Remove unused routine minmaxj.
b29d87c 
Fixes ufs-community#970
@GeorgeGayno-NOAA
Remove unused function 'spherical_distance'.
5e5503c 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Add formal 'end' statements for all subroutines and functions.
168c0b3 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Remove obsolete routine makemt and related logic.
549d2b6 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Remove read of gaussian ocean mask file, which is not
15bbc85 
used anymore. Remove associated logic.

Fixes ufs-community#970.
@GeorgeGayno-NOAA
Merge branch 'develop' into cleanup/orog3
b88a58e 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Move read of model 'grid' file in the driver to its own
6b4568e 
subroutine - read_mdl_dims.

Fixes ufs-community#970.
@GeorgeGayno-NOAA
Remove obsolete calls to sp library routines.
2725c69 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Place logic that find i/j indices of the n/s poles in its
fae9d8c 
own routine.

Fixes ufs-community#970.
@GeorgeGayno-NOAA
Move logic that finds the model points which surround the pole
b149255 
to its own subroutine.

Fixes ufs-community#970.
@GeorgeGayno-NOAA
Remove some unneeded diagnostic print.
c4f10c2 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Move transpose of orography data to its own routine. Remove
b62cc65 
uneeded routine maxmin. Some general clean up.

Fixes ufs-community#970.
@GeorgeGayno-NOAA
Place read of global mask data and its transpose in
428f6d6 
new routines.

Fixes ufs-community#970.
@GeorgeGayno-NOAA
Remove unused variable GLAT from routine TERSUB. Remove some
67a7df2 
old diagnostic print.

Fixes ufs-community#970.
@GeorgeGayno-NOAA
Move read of RAMP data and the QC of the global data to
030203f 
its own routine.

Fixes ufs-community#970.
@GeorgeGayno-NOAA
Move read of model grid file to its own routine.
dd3dcc4 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Update argument list for inside_a_polygon to eliminate warnings
d78a42d 
when running in debug mode.

Fixes ufs-community#970.
@GeorgeGayno-NOAA
General clean up.
1b9707b 
Fixes ufs-community#970.
Move logic that removes isolated model points to its
a4d0b30 
own subroutine.

Fixes ufs-community#970.
Clean up print statements and general clean up.
0836573 
Fixes ufs-community#970.
George Gayno and others added 27 commits July 26, 2024 10:14
Standardize print statements.
e2681c1 
Fixes ufs-community#970.
Move routine latlon2xyz to a new module that will host
b3da945 
most utility routines. Create unit test for that routine.

Fixes ufs-community#970.
Update prolog. Change name of 'merge_file' to a more descriptive
5d93187 
'external_mask_file'.

Fixes ufs-community#970.
Combine routine minmxj and mnmxja into a single routine called
be2a680 
minmax. Write unit test for this new routine.

Fixes ufs-community#970.
Move function get_lat_angle to the orog_utils module and
fde1c2e 
create a unit test for it.

Fixes ufs-community#970.
Move function get_lon_angle to the orog_utils module. Add logic
79426f4 
to prevent divide by zero at poles. Add unit testing for
this function.

Fixes ufs-community#970.
Merge branch 'develop' into cleanup/orog3
0045fcb 
Fixes ufs-community#970.
Merge branch 'develop' into cleanup/orog3
6d317e9 
Fixes ufs-community#970.
Move routines 'timef', 'transpose_mask' and 'spherical_angle'
f94d149 
to orog_utils.F90.

Fixes ufs-community#970.
Move 'transpose_orog' and 'inside_a_polygon' to new
e51a6dc 
module orog_utils.F90.

Fixes ufs-community#970.
Move 'find_poles' and 'find_nearest_pole_points' to
ddc2d1c 
orog_utils.F90.

Fixes ufs-community#970.
Make routine 'latlon2xyz' public so it may be used by the
ddf02d9 
unit tests.

Fixes ufs-community#970.
Move routine 'remove_isolated_pts' to the orog_utils module.
653e704 
Fixes ufs-community#970.
Move routines 'read_global_mask', 'read_global_orog' and
0171cc0 
'qc_orog_by_ramp' to netcdf_io.F90.

Fixes ufs-community#970.
Move routine 'get_index' to module orog_utils.
753a8d7 
Fixes ufs-community#970.
Move function get_xnsum to orog_utils module.
5e0b350 
Fixes ufs-community#970.
Move 'get_xnsum2' and 'get_xnsum3' to orog_utils module.
856a3c7 
Fixes ufs-community#970.
Rename netcdf_io.F90 to a more descriptive io_utils.F90.
d477f17 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Update the doxygen.
a4b1434 
Fixes ufs-community#970.
Convert io_utils.F90 into a Fortran module.
71b0779 
Fixes ufs-community#970.
Fix intent attribute hc in routine get_xnsum3.
e54edb9 
Fixes ufs-community#970.
Remove space from variable XMSUM_ALL.
a0eb44c 
Regression tests all passed.

Fixes ufs-community#970.
Update driver routine to be Fortran 90.
9b698ea 
Fixes ufs-community#970.
Add intent attributes to all routines in mtnlm7_oclsm.F90.
39db5c5 
Fixes ufs-community#970.
Remove some unused variables.
f8a5626 
Fixes ufs-community#970.
Remove unused logic.
2e84186 
Fixes ufs-community#970.
@GeorgeGayno-NOAA
Remove a debugging compiler flag.
2de84bc 
Fixes ufs-community#970.
@GeorgeGayno-NOAA GeorgeGayno-NOAA marked this pull request as ready for review September 24, 2024 19:58
sanatcumar
sanatcumar approved these changes Sep 26, 2024
View reviewed changes
Copy link
Collaborator

@sanatcumar sanatcumar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Compiled and tested the default (C96.mx100) case on Hera. Works as expected .

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sanatcumar sanatcumar sanatcumar approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

More clean up of orog code
2 participants
@GeorgeGayno-NOAA @sanatcumar