Port merry-go-round testcase from compass #284

andrewdnolan · 2025-03-07T23:29:47Z

The merry-go-round test group is used for testing the vertical advection scheme only using tracers. This PR ports the Default test case from the merry_go_round test group from compass. This PR also adds convergence tests in space and both space and time.

Checklist

User's Guide has been updated
Developer's Guide has been updated
API documentation in the Developer's Guide (api.md) has any new or modified class, method and/or functions listed
Documentation has been built locally and changes look as expected
Testing comment in the PR documents testing used to verify the changes
New tests have been added to a test suite

polaris/ocean/tasks/merry_go_round/__init__.py

polaris/ocean/tasks/merry_go_round/init.py

cbegeman · 2025-03-20T17:01:56Z

@andrewdnolan Looking great so far! Just a few minor suggestions

andrewdnolan · 2025-05-09T01:21:22Z

Analysis task now works as of bd2fc01 and achieves a convergence of ~1.74:

polaris/tasks/ocean/merry_go_round/init.py

polaris/tasks/ocean/merry_go_round/forward.yaml

polaris/tasks/ocean/merry_go_round/viz.py

Not per se correct, but needed to that the area calculation for error norm has correct dimensions. Stopped computing converg. rates for tracers 2 & 3 following compass.

Needed for specifiying the culled mesh, as compared to the base mesh as used in all the previous test cases.

The number of vertical layers, for the base resolution, is now read from the config file. Then that's scaled by the refinement factor.

Run the viz step first, so that even if convergence fail the viz step is run. Usefull for diagnosing problems if not converged

Co-authored-by: Carolyn Begeman <[email protected]>

More detailed plotting for default task. Includes cross sections of verticala and horizontal velocity, in addition to the tracer and difference in the tracer.

andrewdnolan · 2025-06-20T15:45:41Z

Sorry about the delay in this. But I have now ported the documentation, which can be viewed here: https://portal.nersc.gov/cfs/fanssie/anolan/merry_go_round/html/test/index.html

@cbegeman you might be able to help with a better description of the vertical coordinate in the user guide. Sorry my description is so brief, I'm don't have the best grasp of the vertical coordinate details in mpas-ocean.

andrewdnolan · 2025-06-20T15:56:20Z

Testing

Testing and development have been done on perlmutter:

polaris setup --clean -n 96 97 98 99 -w $PSCRATCH/merry_go_round

cd $PSCRATCH/merry_go_round
salloc --nodes 1 --qos interactive --time 00:30:00 --constraint cpu --account e3sm
source load_polaris_env.sh
polaris serial

Output

polaris.log

ocean/planar/merry_go_round/default                                                                       
  * step: init_5m                                                                                         
          execution:        SUCCESS                                                                       
          runtime:          0:00:07                                                                       
  * step: forward_5m_360s                                                                                 
          execution:        SUCCESS                                                                       
          runtime:          0:00:03                                                                       
  * step: viz                                                                                             
          execution:        SUCCESS                                                                       
          runtime:          0:00:02                                                                       
  task execution:   SUCCESS                                                                               
  task runtime:     0:00:12         
ocean/planar/merry_go_round/convergence_space/
  * step: init_5m
          already completed
  * step: forward_5m_360s
          already completed
  * step: init_2.5m
          execution:        SUCCESS
          runtime:          0:00:02
  * step: forward_2.5m_360s
          execution:        SUCCESS
          runtime:          0:00:04
  * step: init_1.25m
          execution:        SUCCESS
          runtime:          0:00:03
  * step: forward_1.25m_360s
          execution:        SUCCESS
          runtime:          0:00:07
  * step: viz
          execution:        SUCCESS
          runtime:          0:00:10
  * step: analysis
          execution:        SUCCESS
          runtime:          0:00:01
  task execution:   SUCCESS
  task runtime:     0:00:27
ocean/planar/merry_go_round/convergence_time/
  * step: init_5m
          already completed
  * step: forward_5m_360s
          already completed
  * step: forward_5m_180s
          execution:        SUCCESS
          runtime:          0:00:04
  * step: forward_5m_90s
          execution:        SUCCESS
          runtime:          0:00:08
  * step: viz
          execution:        SUCCESS
          runtime:          0:00:04
  * step: analysis
          execution:        ERROR
  task execution:   ERROR
  see: case_outputs/ocean_planar_merry_go_round_convergence_time_.log
  task runtime:     0:00:17
ocean/planar/merry_go_round/convergence_both/
  * step: init_5m
          already completed
  * step: forward_5m_360s
          already completed
  * step: init_2.5m
          already completed
  * step: forward_2.5m_180s
          execution:        SUCCESS
          runtime:          0:00:07
  * step: init_1.25m
          already completed
  * step: forward_1.25m_90s
          execution:        SUCCESS
          runtime:          0:00:26
  * step: viz
          execution:        SUCCESS
          runtime:          0:00:09
  * step: analysis
          execution:        SUCCESS
          runtime:          0:00:01
  task execution:   SUCCESS
  task runtime:     0:00:43
Task Runtimes:
0:00:12 PASS ocean/planar/merry_go_round/default
0:00:27 PASS ocean/planar/merry_go_round/convergence_space/
0:00:17 FAIL ocean/planar/merry_go_round/convergence_time/
0:00:43 PASS ocean/planar/merry_go_round/convergence_both/
Total runtime: 0:01:46
FAIL: 1 task failed, see above.

@cbegeman I'm still unable to get convergence in just time, per the failure in the convergence_time.analysis step. I can't recall how we decided we wanted to deal with this?

cbegeman · 2025-06-20T23:38:42Z

docs/users_guide/ocean/tasks/merry_go_round.md

+The mesh is planar and the resolution is specified by config option
+`convergence:base_resolution`, which defaults to 5 m. The horizontal


I think it might be confusing for folks that in order to change the resolution for the default task they need to change options in the convergence section. I would prefer that we have a new section merry_go_round_default that has any options that are used only by the default case (which may be just resolution).

Thanks for suggestion! I totally agree, that seems less confusing.

cbegeman · 2025-06-20T23:41:42Z

@cbegeman I'm still unable to get convergence in just time, per the failure in the convergence_time.analysis step. I can't recall how we decided we wanted to deal with this?

I don't think it's your responsibility to debug this. I think we just add only the tests that pass to the test suites. I think we minimally need the default test in the pr suite and the convergence_both test in the convergence suite.

cbegeman · 2025-07-28T18:24:55Z

Compass contained some x offsets in the function that defines the initial velocity. These led to artifacts:

I have changed the IC to remove those artifacts and receive much smaller errors:
bb60c5b

And convergence that is close to the theoretical value of 2:

cbegeman

Now that the initial condition is fixed, this is ready to go in. Thanks for all your work on this @andrewdnolan!

andrewdnolan added in progress This PR is not ready for review or merging ocean Related to the ocean component labels Mar 7, 2025

cbegeman reviewed Mar 20, 2025

View reviewed changes

polaris/ocean/tasks/merry_go_round/__init__.py Outdated Show resolved Hide resolved

cbegeman reviewed Mar 20, 2025

View reviewed changes

polaris/ocean/tasks/merry_go_round/init.py Outdated Show resolved Hide resolved

cbegeman reviewed Mar 20, 2025

View reviewed changes

polaris/ocean/tasks/merry_go_round/init.py Outdated Show resolved Hide resolved

cbegeman reviewed Mar 20, 2025

View reviewed changes

polaris/ocean/tasks/merry_go_round/init.py Outdated Show resolved Hide resolved

andrewdnolan force-pushed the merry_go_round branch from 2989d96 to 03aaea4 Compare May 8, 2025 23:45

andrewdnolan self-assigned this May 9, 2025

andrewdnolan commented May 9, 2025

View reviewed changes

polaris/tasks/ocean/merry_go_round/init.py Outdated Show resolved Hide resolved

cbegeman reviewed May 22, 2025

View reviewed changes

polaris/tasks/ocean/merry_go_round/forward.yaml Outdated Show resolved Hide resolved

cbegeman reviewed May 22, 2025

View reviewed changes

polaris/tasks/ocean/merry_go_round/forward.yaml Outdated Show resolved Hide resolved

cbegeman reviewed May 22, 2025

View reviewed changes

polaris/tasks/ocean/merry_go_round/forward.yaml Outdated Show resolved Hide resolved

cbegeman reviewed May 22, 2025

View reviewed changes

polaris/tasks/ocean/merry_go_round/viz.py Outdated Show resolved Hide resolved

andrewdnolan added 15 commits June 19, 2025 13:33

Add merry_go_round task, with init task only for now.

a1a6dca

Add config file and init step for various resolutions

32f644f

Add forward step for convergence task

1d9ec47

format Forward Task call

d912ef6

Cleanup unused imports.

b243ab8

Move tasks to new location and fix import paths.

792cbaa

fix errors in intial condition generation

5b14330

Add first pass at an Analysis step.

257583b

correct component name in docs string

5fd3199

Write the culled mesh as base mesh.

6549482

Not per se correct, but needed to that the area calculation for error norm has correct dimensions. Stopped computing converg. rates for tracers 2 & 3 following compass.

Add shared viz step.

1279afb

Add mesh_filename attribute to analysis step.

7bde60c

Needed for specifiying the culled mesh, as compared to the base mesh as used in all the previous test cases.

Apply suggestions from code review.

a14db89

The number of vertical layers, for the base resolution, is now read from the config file. Then that's scaled by the refinement factor.

Add default task. And task for just time and space convergence

0257cee

Reorder viz and analysis steps.

cfd9441

Run the viz step first, so that even if convergence fail the viz step is run. Usefull for diagnosing problems if not converged

andrewdnolan and others added 8 commits June 19, 2025 13:35

Fix docstring.

07dd542

Add annotation for vertical spacing

0e516d0

Reduce reference timestep to avoid instability

d23d032

Apply suggestions from code review

5a628af

Co-authored-by: Carolyn Begeman <[email protected]>

Switch to using transect utilites for plotting.

df740fb

Remove settings that are equal to registry defaults

3954fce

Add viz step for default task

00f99ed

More detailed plotting for default task. Includes cross sections of verticala and horizontal velocity, in addition to the tracer and difference in the tracer.

First pass at user guide documentation.

764ee71

andrewdnolan force-pushed the merry_go_round branch from e99b707 to 764ee71 Compare June 19, 2025 22:15

andrewdnolan added 5 commits June 19, 2025 15:17

Fix import order

d84c82c

Update docstrings and add merry-go-round to api docs

4def02c

Resize default fig for more legiable labels

19e4521

Add developer documentation

3b4d5cb

Proof read and correct the merry-go-round docs

6784e0d

andrewdnolan marked this pull request as ready for review June 20, 2025 16:01

andrewdnolan removed the in progress This PR is not ready for review or merging label Jun 20, 2025

cbegeman reviewed Jun 20, 2025

View reviewed changes

andrewdnolan and others added 6 commits June 23, 2025 13:54

Move base resolution to default config section

7287b23

Remove time only convergence test

0a8bea7

Add merry-go-round tests to pr and convergence suites

312c9e9

Turn off visualization steps by default

7ae13f1

Correct vertCoordMovementWeights

6269d79

Fixup IC

bb60c5b

cbegeman approved these changes Jul 28, 2025

View reviewed changes

cbegeman merged commit 08d929a into E3SM-Project:main Jul 28, 2025
5 checks passed

cbegeman added the enhancement New feature or request label Jul 28, 2025

		The mesh is planar and the resolution is specified by config option
		`convergence:base_resolution`, which defaults to 5 m. The horizontal

Port merry-go-round testcase from compass #284

Port merry-go-round testcase from compass #284

Uh oh!

Conversation

andrewdnolan commented Mar 7, 2025 • edited by cbegeman Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cbegeman commented Mar 20, 2025

Uh oh!

andrewdnolan commented May 9, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

andrewdnolan commented Jun 20, 2025

Uh oh!

andrewdnolan commented Jun 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Testing

Output

Uh oh!

cbegeman Jun 20, 2025

Choose a reason for hiding this comment

Uh oh!

andrewdnolan Jun 23, 2025

Choose a reason for hiding this comment

Uh oh!

cbegeman commented Jun 20, 2025

Uh oh!

cbegeman commented Jul 28, 2025

Uh oh!

cbegeman left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

andrewdnolan commented Mar 7, 2025 •

edited by cbegeman

Loading

andrewdnolan commented Jun 20, 2025 •

edited

Loading