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

Update Coord system and Notation page in docs #1779

Open
tomchor opened this issue Jun 28, 2021 · 6 comments
Open

Update Coord system and Notation page in docs #1779

tomchor opened this issue Jun 28, 2021 · 6 comments
Labels
documentation 📜 The sacred scrolls

Comments

@tomchor
Copy link
Collaborator

tomchor commented Jun 28, 2021

I think Coordinate system and notation page in the docs needs to be updated.

First, we don't only use a Cartesian grid anymore (we don't even use the word Cartesian for the RegularRectilinearGrid anymore). I'm not sure how you guys wanna adapt this page and notation for the spherical coordinate grid though.

Second, a part of the math isn't rendering and I'm not sure why.

@tomchor tomchor added the documentation 📜 The sacred scrolls label Jun 28, 2021
@glwagner
Copy link
Member

Just one clarification --- I think we are still almost always locally Cartesian (the main exception being the lack of a "global" native coordinate system for cubed sphere stuff), because we still describe locations with a 3 tuple (eg we use three orthogonal coordinates). However it's true that on RegularLatitudeLongitudeGrid we use longitude, latitude, and altitude as coordinates rather than x, y, z.

With the current software design we probably need to describe the coordinate system for each AbstractGrid separately.

@francispoulin
Copy link
Collaborator

I think this does need some improvement. Outside of Oceananigans I would have said the two grids are Cartesian and Spherical but I know that there was a long discussion and we settled on Rectangular, which makes sense.

I wonder whether we want to continue to have RegularLatitudeLongitudeGrid or perhaps RegularSphericalGrid. It is a bit shorter and maybe more similar to RegularRectangularGrid?

@glwagner
Copy link
Member

glwagner commented Jun 28, 2021

@francispoulin is it ok if we limit the discussion in this issue to the documentation and discuss naming for grid types elsewhere?

It looks like I've been confused about the definition of "Cartesian" ever since we changed the name of the grid type from Cartesian to Rectilinear.

I think the important point is that a "grid" specifies both a coordinate system (implicitly) and a mesh (via nodal points, grid spacings, areas, volumes, etc).

We don't really have full support for spherical coordinate systems yet, because to support a coordinate system on the cubed sphere we need to have an abstraction for vectors that can translate user input in some global coordinate system to the local coordinate system (different on each facet of the cubed sphere).

@navidcy
Copy link
Collaborator

navidcy commented Jul 1, 2021

I agree: updates are indeed in order but only when spherical coordinate grids are fully supported out there.

@navidcy
Copy link
Collaborator

navidcy commented May 29, 2022

Perhaps it's time for this ;)

@glwagner
Copy link
Member

Also, is the label "Physics" the best one for this category?

Side note: "Model setup" should definitely come right after "Examples"...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📜 The sacred scrolls
Projects
None yet
Development

No branches or pull requests

4 participants