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

Should we rename the model option coriolis to background_rotation? #1905

Closed
tomchor opened this issue Jul 28, 2021 · 3 comments
Closed

Should we rename the model option coriolis to background_rotation? #1905

tomchor opened this issue Jul 28, 2021 · 3 comments
Labels
abstractions 🎨 Whatever that means

Comments

@tomchor
Copy link
Collaborator

tomchor commented Jul 28, 2021

Related to #1904, but I didn't wanna distract from the main discussion there.

It might make sense to rename the model constructor option coriolis to background_rotation, since that's really what it is. If we're running a rotating GFD simulation then coriolis is an appropriate term. But one could envision using Oceananigans for more idealized simulations with a rotating domain where calling the rotation coriolis wouldn't really make much sense.

Thoughts?

CC: @glwagner @francispoulin

@glwagner
Copy link
Member

One thought I had during that discussion is that "background rotation" is a physical concept, while "Coriolis" is more or less the name of the terms we add to a momentum equation to describe that physical concept.

Most of the keyword arguments for models refer to the math (rather than the physics), which might be preferred because in a sense its more precise. In other words, Oceananigans solves a discretization of a partial differential equations; it's up to users to interpret the solution in light of some physical problem that's being modeled.

@glwagner glwagner added the abstractions 🎨 Whatever that means label Jul 28, 2021
@francispoulin
Copy link
Collaborator

Since Coriolis is very much a common term in the field and it describes the terms in the equation, I would vote for keeping it, even though I agree that background_rotation is more descriptive.

@navidcy
Copy link
Collaborator

navidcy commented Aug 1, 2021

Coriolis is widely used... Let's keep it!

@tomchor tomchor closed this as completed Aug 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
abstractions 🎨 Whatever that means
Projects
None yet
Development

No branches or pull requests

4 participants