Skip to content

Add a design documents for the unified base mesh#521

Open
xylar wants to merge 22 commits intoE3SM-Project:mainfrom
xylar:add-unified-base-mesh-design-doc
Open

Add a design documents for the unified base mesh#521
xylar wants to merge 22 commits intoE3SM-Project:mainfrom
xylar:add-unified-base-mesh-design-doc

Conversation

@xylar
Copy link
Copy Markdown
Collaborator

@xylar xylar commented Apr 10, 2026

This mesh is intended to work for the E3SM land, river, ocean and sea-ice components.

This PR also adds design docs for 4 shared steps related to the unified base mesh, tentatively named :

  • prepare_coastline
  • prepare_river_network
  • build_sizing_field
  • create_base_mesh

Checklist

  • Documentation has been built locally and changes look as expected

@xylar xylar self-assigned this Apr 10, 2026
@xylar xylar added documentation Improvements or additions to documentation ocean Related to the ocean component sea ice Related to the sea-ice component mesh Related to the mesh component e3sm/init Related to the e3sm/init component labels Apr 10, 2026
@xylar
Copy link
Copy Markdown
Collaborator Author

xylar commented Apr 10, 2026

This is a draft, but feel free to comment and give feedback.

@xylar
Copy link
Copy Markdown
Collaborator Author

xylar commented Apr 13, 2026

I'm going to fold #522 into this branch. It is too much effort to keep the designs separate.

@xylar xylar force-pushed the add-unified-base-mesh-design-doc branch from b25da60 to 2a8cc8f Compare April 13, 2026 14:25
Copy link
Copy Markdown

@changliao1025 changliao1025 left a comment

Choose a reason for hiding this comment

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

Since buffer zone will be introduced "land-ward" during the coastline preprocessing, we might need to record both the raw and buffered spacing rasters for coastline.

@xylar
Copy link
Copy Markdown
Collaborator Author

xylar commented Apr 18, 2026

Since buffer zone will be introduced "land-ward" during the coastline preprocessing, we might need to record both the raw and buffered spacing rasters for coastline.

I don't quite follow what you mean. But we can easily recover a mask from the signed distance function that includes all cells that are a given distance or further from the coastline in either direction. For example, signed_distance > 0 would recover the ocean mask. signed_distance < -buffer_distance would recover the land that is further inland than buffer_distance. So I believe everything we need should be available.

@xylar xylar added unified-mesh and removed ocean Related to the ocean component sea ice Related to the sea-ice component labels Apr 19, 2026
@xylar xylar force-pushed the add-unified-base-mesh-design-doc branch 2 times, most recently from e12adeb to 0378e56 Compare April 19, 2026 10:25
@changliao1025
Copy link
Copy Markdown

Since buffer zone will be introduced "land-ward" during the coastline preprocessing, we might need to record both the raw and buffered spacing rasters for coastline.

I don't quite follow what you mean. But we can easily recover a mask from the signed distance function that includes all cells that are a given distance or further from the coastline in either direction. For example, signed_distance > 0 would recover the ocean mask. signed_distance < -buffer_distance would recover the land that is further inland than buffer_distance. So I believe everything we need should be available.

I assume you meant geodesic distance?
In a raster based buffer calculation, the distance can mean pixel and the actual distance varies with latitude.

@xylar
Copy link
Copy Markdown
Collaborator Author

xylar commented Apr 21, 2026

I assume you meant geodesic distance?
In a raster based buffer calculation, the distance can mean pixel and the actual distance varies with latitude.

It actually uses Cartesian distance but you have to be very far from the coastline for that to make a difference.

@xylar xylar changed the title Add a design document for the unified base mesh Add a design documents for the unified base mesh Apr 22, 2026
Comment thread docs/design_docs/unified_base_mesh.md Outdated
@xylar xylar force-pushed the add-unified-base-mesh-design-doc branch from ada159a to e890d22 Compare April 25, 2026 12:27
xylar added 4 commits April 27, 2026 14:25
This mesh is intended to work for the E3SM land, river, ocean
and sea-ice components
Also, clarify a bit what the scope of build_sizing_field actually
is.
@xylar xylar force-pushed the add-unified-base-mesh-design-doc branch from 55c838d to c2fc31e Compare April 27, 2026 12:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation e3sm/init Related to the e3sm/init component mesh Related to the mesh component unified-mesh

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants