Docs for zstar and nonlinear free surface #4588
Draft
+142
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
is there a preview? |
|
Always, at: https://clima.github.io/OceananigansDocumentation/previews/PR4588/ At the moment there is not much changes tho |
I could not find this page in the physics tabe but found it here, in case others want a quick link. https://clima.github.io/OceananigansDocumentation/previews/PR4588/physics/zstar_vertical_coordinate/ |
|
My bad! I put the wrong link! Fixed it now! |
… into ss/non-linear-docs
… into ss/non-linear-docs
navidcy
reviewed
Jun 10, 2025
| @@ -0,0 +1,128 @@ | |||
| # Generalized vertical coordinate | |||
|
|
|||
| For `HydrostaticFreeSurfaceModel()`, the user can choose between a `ZCoordinate` and a `ZStar` vertical coordinate. | |||
There was a problem hiding this comment.
given that this section is only relevant for HydrostaticFreeSurfaceModel() perhaps we move it a bit further down in the docs structure?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds docs for the derivation of the generalized vertical coordinate equations and their detailed numerical implementation including the formulation we use for a non-linear free surface