Skip to content

Outdated comments in quad_utils #1161

Description

@mjs2369

There are a lot of comments that need updated in the quad_utils_mod. There are lots of notes/questions to ourselves, to-dos, etc.

Examples:

Comments in type quad_grid_options, starting at line 129.

! separate out the single logical 'spans' flag into two cases?
! case 1: the longitude grid is cyclic; either a global grid or a band between
! two latitude lines that circles the globe. all longitude values are valid.
! case 2: a regional grid that crosses the prime meridian.
! this will contain a discontinuity around 360 -> 0 that should be a valid region.
! can a single flag handle both of these cases?

! i don't want to know this, but apparently we might
! have to know if the points given are cell-centered or
! on the edges. (god forbid we need to know U stagger vs V stagger!)
! (for detecting if we are at the poles, for example)

Comment on line 210 - what are these good defaults for?

! the sizes of these depend on the grid size. these are good defaults for ?
integer :: num_reg_x = 180
integer :: num_reg_y = 180
real(r8) :: min_lon = 0.0_r8
real(r8) :: max_lon = 360.0_r8
real(r8) :: lon_width = 360.0_r8
real(r8) :: min_lat = -90.0_r8
real(r8) :: max_lat = 90.0_r8
real(r8) :: lat_width = 180.0_r8

Many more like this, out of date notes and comment blocks, etc. ......

Finally, there is a whole subroutine commented out in this module - init_dipole_interp

!> @todo FIXME: this is the original code, for reference.
!> the init_irreg_interp() routine above should replace it.
!%! subroutine init_dipole_interp()
!%!

Checked the git blame and it has not been used in 7 years. We don't need to keep this code actively in our repo, if we ever need it we could get it back with version control

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions