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.

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

Design Document: Omega-0 algorithm formulation #33

Conversation

mark-petersen
Copy link

@mark-petersen mark-petersen commented Aug 28, 2023

Add section 3, the algorithm formulation, to the design document. During this review, the documentation is available here for convenient viewing.

Checklist

  • Documentation:
    • Documentation has been built locally and changes look as expected

@xylar
Copy link

xylar commented Aug 28, 2023

@mark-petersen, as I mentioned in #32, please keep the checklist when you make new Omega PRs.

@mark-petersen
Copy link
Author

This PR is still under development. Early comments are welcome, but I will add reviewers and post again when the algorithm section is complete.

@mark-petersen mark-petersen force-pushed the mark-petersen/omega/design-omega0-sw-algorithms branch from 3e3776a to 27be3fd Compare September 1, 2023 19:20
@xylar
Copy link

xylar commented Sep 1, 2023

@mark-petersen, it doesn't look like you rebased onto the current develop, so you have redundant commits from #32 that I don't think we want.

@mark-petersen mark-petersen force-pushed the mark-petersen/omega/design-omega0-sw-algorithms branch from 27be3fd to 5286c80 Compare September 11, 2023 19:34
amametjanov pushed a commit that referenced this pull request Dec 5, 2023
Move constants from ice_constants_colpkg.F90 to mpas_seaice_constants.F
@mark-petersen mark-petersen force-pushed the mark-petersen/omega/design-omega0-sw-algorithms branch from e69b893 to a670ea0 Compare March 21, 2024 17:17
@mark-petersen mark-petersen force-pushed the mark-petersen/omega/design-omega0-sw-algorithms branch from 30ba0c0 to 69a0915 Compare April 1, 2024 18:40
@mark-petersen mark-petersen force-pushed the mark-petersen/omega/design-omega0-sw-algorithms branch from 663d824 to 62cec08 Compare April 26, 2024 18:11
@mark-petersen
Copy link
Author

During this review, the documentation is available here for convenient viewing.

@mark-petersen mark-petersen force-pushed the mark-petersen/omega/design-omega0-sw-algorithms branch from 1bc24ad to 6aab934 Compare June 17, 2024 17:57
@mark-petersen
Copy link
Author

Rebased and squashed. This is document is now done and ready for review.

@mark-petersen mark-petersen self-assigned this Jun 19, 2024
@mark-petersen
Copy link
Author

Please review when you get a chance: @sbrus89 @mwarusz @hyungyukang

I would like to make any revisions and merge this week.

Copy link

@sbrus89 sbrus89 left a comment

Choose a reason for hiding this comment

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

@mark-petersen, this looks great to me. I just had a couple really minor comments from reading through.

components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
Copy link
Member

@mwarusz mwarusz left a comment

Choose a reason for hiding this comment

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

Looks good @mark-petersen. I also only have minor comments.

components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
Copy link

@hyungyukang hyungyukang left a comment

Choose a reason for hiding this comment

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

@mark-petersen , changes look great. @sbrus89 and @mwarusz 's reviews covered my suggestions and improved the doc. Many thanks for your work!

components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
Copy link

@sbrus89 sbrus89 left a comment

Choose a reason for hiding this comment

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

Thanks for addressing those changes, @mark-petersen. This is a really nice resource to have!

@mark-petersen mark-petersen force-pushed the mark-petersen/omega/design-omega0-sw-algorithms branch from 982f4dd to 1a888d6 Compare July 8, 2024 18:57
@mark-petersen
Copy link
Author

@mwarusz I corrected based on your comments. The full document is here.

In particular, I expanded the section on the perpendicular gradient and the section on del2.

Please review again if you like, and I can merge in once you've approved.

Copy link
Member

@mwarusz mwarusz left a comment

Choose a reason for hiding this comment

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

@mark-petersen I found more minor things.

components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
@mark-petersen
Copy link
Author

@mwarusz, thank you for your detailed review. I addressed all of your comments, and the revised document is here.

@vanroekel
Copy link

@mark-petersen this is really nice. I think it is so great to have this all in one place. Thanks for all the work on it

Copy link
Member

@mwarusz mwarusz left a comment

Choose a reason for hiding this comment

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

@mark-petersen Thanks for addressing all of my previous comments. This looks almost ready, but I do have some new suggestions.

components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
$$
The normalization can be found through simple geometric arguments to be similar to above,
$$
A_v = \sum_{e\in EV(v)} \frac{{\bar A}_{e}}{4}.
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't this simply be {\hat A}_v ? I don't see this expression in MPAS-O code. It just uses areaTriangle.

Copy link
Author

Choose a reason for hiding this comment

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

Yes. I updated it to {\hat A}_v. I just meant to show here the equivalence of the two sides in area. I updated the words to make that more clear.

components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
@mark-petersen
Copy link
Author

mark-petersen commented Aug 24, 2024

@mwarusz thanks for your attention to detail, and sorry for the delay. The revised documentation is available here. I added a new figure to show exactly what each area region is to help future readers, below the variable definitions.

Copy link
Member

@mwarusz mwarusz left a comment

Choose a reason for hiding this comment

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

Thanks @mark-petersen for your hard work on this document. The added figure is very helpful. The only issue I found are two typos where c is used as cell index instead of i, so I think I can safely approve.

components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
components/omega/doc/design/OmegaV0ShallowWater.md Outdated Show resolved Hide resolved
@mark-petersen mark-petersen force-pushed the mark-petersen/omega/design-omega0-sw-algorithms branch from df80916 to 5b38158 Compare August 29, 2024 22:47
@mark-petersen
Copy link
Author

rebased to handle conflicts.

@mark-petersen mark-petersen merged commit 0cdb515 into E3SM-Project:develop Aug 29, 2024
2 checks passed
@mark-petersen mark-petersen deleted the mark-petersen/omega/design-omega0-sw-algorithms branch August 29, 2024 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants