search

E3SM-Ocean-Discussion / E3SM

Ocean discussion repository, for ocean issues and longer-term pull requests for E3SM source code. Please make pull requests that are ready to merge into https://github.com/E3SM-Project/E3SM
https://e3sm.org
Other
1 stars 0 forks source link

Update descriptions of dcEdge and dvEdge #99

Closed xylar closed 6 months ago

xylar commented 6 months ago

The existing descriptions were not clear to developers.

xylar commented 6 months ago

@mark-petersen, @proteanplanet, @matthewhoffman, as representatives form each affected component, could you let me know if you're okay with these changes to the descriptions of dcEdge and dvEdge?

<var name="dvEdge" type="real" dimensions="nEdges" units="m"
    description="The great circle distance between vertices bordering a given edge.  It is the length of the edge on the primal mesh."
/>
<var name="dcEdge" type="real" dimensions="nEdges" units="m"
    description="The great circle distance between cell centers bordering a given edge.  It is the length of the edge on the dual mesh."
/>
matthewhoffman commented 6 months ago

@xylar , thanks for tackling this. If we are adjusting these definitions, I would prefer some additional elaboration:

dvEdge: The distance (great circle distance for spherical meshes, Euclidean distance for planar meshes) between the two vertices (defined by verticesOnEdge) located at the endpoints of a given edge. It is the length of the edge on the primal mesh.

dcEdge The distance (great circle distance for spherical meshes, Euclidean distance for planar meshes) between the centers of the two cells (defined by cellsOnEdge) neighboring a given edge. It is the length of the edge on the primal mesh.

xylar commented 6 months ago

The second one should be "dual", rather than "primal", right?

xylar commented 6 months ago

Good point about planar vs. spherical.

matthewhoffman commented 6 months ago

The second one should be "dual", rather than "primal", right?

Yes, oops, good catch. Copy-and-paste error. :)

xylar commented 6 months ago

@matthewhoffman, could you take a careful look at the update I just made? I want to make sure it's what you wanted.

xylar commented 6 months ago

Taking @mark-petersen off as he's away.

xylar commented 6 months ago

I need to update the respective E3SM namelist files using https://github.com/MPAS-Dev/MPAS-Tools/blob/master/source_code_processing/e3sm_namelist_file_generator/generate_e3sm_namelist_files.py

xylar commented 6 months ago

Never mind, there's nothing to update with generate_e3sm_namelist_files.py. Moving to E3SM...

xylar commented 6 months ago

Closing in favor of https://github.com/E3SM-Project/E3SM/pull/6427