Rename to unambiguous pseudo- and geometric thickness and height names#327
Rename to unambiguous pseudo- and geometric thickness and height names#327xylar wants to merge 19 commits intoE3SM-Project:developfrom
Conversation
There was a problem hiding this comment.
This whole document needs some updating but I don't want to distract from the purpose of this PR to do it.
| | ZMid | Real | NCellsSize, NVertLayers | | ||
| | GeopotentialMid | Real | NCellsSize, NVertLayers | | ||
| | LayerThicknessPStar | Real | NCellsSize, NVertLayers| | ||
| | PseudoThicknessPStar | Real | NCellsSize, NVertLayers| |
There was a problem hiding this comment.
Here and in the user's guide, there's a reference to LayerThicknessPStar, now PseudoThicknessPStar, but I didn't see this in the code itself.
| | ZMid | z height of layer midpoint | m | | ||
| | GeopotentialMid | geopotential at layer mid points | m$^2$/s$^2$| | ||
| | LayerThicknessPStar | desired layer thickness based on total perturbation from the reference thickness | - | | ||
| | PseudoThicknessPStar | desired layer thickness based on total perturbation from the reference thickness | - | |
There was a problem hiding this comment.
Here and in the developer's guide, there's a reference to LayerThicknessPStar, now PseudoThicknessPStar, but I didn't see this in the code itself.
| NDims, // number of dimensions | ||
| DimNames // dimension names | ||
| ZInterfFldName, // field name | ||
| "Geometric height at layer interfaces", // long name or description |
There was a problem hiding this comment.
I feel pretty strongly that calling this the "Cartesian Z coordinate" is not correct -- the Cartesian coordinates for the MPAS mesh are in contrast to the spherical coordinates we usually use.
It also seems important to make clear that this is the geometric height (as opposed to the pseudo-height).
There was a problem hiding this comment.
The other changes here are just to make the formatting consistent with the rest of the file.
| NDims, // number of dimensions | ||
| DimNames // dimension names | ||
| ZMidFldName, // field name | ||
| "Geometric height at layer midpoints", // long name or description |
|
I know this will make for a rebasing nightmare for work in progress so I'll wait on this until we can coordinate a good time for it. I'll suck up the rebasing nightmare here, because it's a pretty simple search-and-replace job. |
| ## Ocean State | ||
|
|
||
| The `OceanState` class provides a container for the non-tracer prognostic variables in Omega, namely `normalVelocity` and `layerThickness`. | ||
| The `OceanState` class provides a container for the non-tracer prognostic variables in Omega, namely `normalVelocity` and `PseudoThickness`. |
There was a problem hiding this comment.
| The `OceanState` class provides a container for the non-tracer prognostic variables in Omega, namely `normalVelocity` and `PseudoThickness`. | |
| The `OceanState` class provides a container for the non-tracer prognostic variables in Omega, namely `NormalVelocity` and `PseudoThickness`. |
|
This needs to be tested in tandem with E3SM-Project/polaris#440, which is very much a work in progress. But CTests are passing as long as I use new meshes that include the |
931b9d5 to
dc8fea0
Compare
LayerThickness --> PseudoThicknessdc8fea0 to
40fcd42
Compare
These are geometric heights, not the Cartesian Z coordinate.
The new ones include as many Omega variable names as possible and have the `PseudoThickness` variable added.
40fcd42 to
54631fb
Compare
We rename many variables with ambiguous names to make clear if they refer to pseudo- or geometric thickness or height.
54631fb to
a9dfcc2
Compare
a9dfcc2 to
c713d0c
Compare
Checklist
Testingwith the following:have been run on and indicate that are all passing.
has passed, using the Polaris
e3sm_submodules/Omegabaseline-pfor both the baseline (Polarise3sm_submodules/Omega) and the PR build