Add Tutorial Chapter 3: Multiple grid cells MICM box model#509
Merged
boulderdaze merged 10 commits intomainfrom Sep 5, 2025
Merged
Add Tutorial Chapter 3: Multiple grid cells MICM box model#509boulderdaze merged 10 commits intomainfrom
boulderdaze merged 10 commits intomainfrom
Conversation
… MICM box model Co-authored-by: mattldawson <[email protected]>
Co-authored-by: mattldawson <[email protected]>
Copilot
AI
changed the title
[WIP] Tutorial Ch 3: Expand box-model to handle multiple grid cells with one call to MICM solver
Add Tutorial Chapter 3: Multiple grid cells MICM box model
Jul 28, 2025
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #509 +/- ##
==========================================
- Coverage 84.23% 81.14% -3.09%
==========================================
Files 49 54 +5
Lines 4777 6015 +1238
==========================================
+ Hits 4024 4881 +857
- Misses 753 1134 +381 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
K20shores
requested changes
Jul 29, 2025
Collaborator
There was a problem hiding this comment.
@copilot this needs to be added to the CMakeLists.txt file that builds the other tests
docs/source/tutorials/chapter3.rst
Outdated
| for multiple independent air masses simultaneously. | ||
|
|
||
| Each grid cell represents an independent set of well-mixed air masses, | ||
| allowing us to model different atmospheric conditions (temperature, pressure, initial concentrations) |
Collaborator
There was a problem hiding this comment.
Suggested change
| allowing us to model different atmospheric conditions (temperature, pressure, initial concentrations) | |
| allowing us to model different atmospheric conditions (temperature, pressure, concentrations) |
docs/source/tutorials/chapter3.rst
Outdated
Comment on lines
+74
to
+84
| The key advantage is that a single call to ``micm%solve`` processes all grid cells: | ||
|
|
||
| .. code-block:: fortran | ||
|
|
||
| call micm%solve(time_step, state, solver_state, solver_stats, error) | ||
|
|
||
| This is much more efficient than calling the solver separately for each grid cell, | ||
| especially when dealing with large numbers of atmospheric grid cells in climate or weather models. | ||
|
|
||
| To build and run the example, follow the same build instructions as in Chapter 1 and 2. | ||
| The compilation command would be: |
Collaborator
There was a problem hiding this comment.
Suggested change
| The key advantage is that a single call to ``micm%solve`` processes all grid cells: | |
| .. code-block:: fortran | |
| call micm%solve(time_step, state, solver_state, solver_stats, error) | |
| This is much more efficient than calling the solver separately for each grid cell, | |
| especially when dealing with large numbers of atmospheric grid cells in climate or weather models. | |
| To build and run the example, follow the same build instructions as in Chapter 1 and 2. | |
| The compilation command would be: | |
| A call to ``micm%solve`` with a state that represents multiple grid cells is only required once per time step; all grid cells are solved simultaneously in a multi-grid cell micm state. | |
| .. code-block:: fortran | |
| call micm%solve(time_step, state, solver_state, solver_stats, error) | |
| This is much more efficient than calling the solver separately for each grid cell, | |
| especially when dealing with large numbers of atmospheric grid cells in climate or weather models. | |
| To build and run the example, follow the same build instructions as in Chapter 1 and 2. | |
| The compilation command would be: |
boulderdaze
reviewed
Sep 3, 2025
docs/source/tutorials/chapter3.rst
Outdated
Comment on lines
+128
to
+143
| **Analysis of Results:** | ||
|
|
||
| Notice how each grid cell evolves differently: | ||
|
|
||
| - **Grid Cell 1** (273K): Starting with concentrations of 1.0, the cooler temperature leads to slower reaction rates | ||
| - **Grid Cell 2** (283K): Starting with higher concentrations (2.0), shows proportionally similar evolution patterns but at roughly double the scale | ||
| - **Grid Cell 3** (293K): Starting with lower concentrations (0.5), the warmer temperature leads to faster reaction rates but proportionally similar patterns | ||
|
|
||
| The chemical mechanism responds to both the initial concentrations and the temperature conditions. | ||
| You can observe that Grid Cell 2, which starts with twice the concentration of Grid Cell 1, | ||
| maintains roughly twice the final concentrations, demonstrating the linear scaling behavior of the system. | ||
| Meanwhile, the different temperatures lead to slightly different reaction efficiencies across the cells. | ||
|
|
||
| This multiple grid cell approach is essential for atmospheric modeling applications | ||
| where hundreds or thousands of grid cells need to be processed simultaneously | ||
| while maintaining computational efficiency. |
Collaborator
There was a problem hiding this comment.
Hi @mattldawson, @K20shores, should we remove this paragraph or keep it? The values are fabricated, so the analysis is not meaningful, but I don't know. What do you think?
Collaborator
There was a problem hiding this comment.
I’m actually thinking of removing this. It feels too AI-generated.
Collaborator
There was a problem hiding this comment.
Oh yeah, I don't think we need an analysis. All we need to say is that the results differ in each grid cell due to the varying conditions.
K20shores
approved these changes
Sep 4, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a new Tutorial Chapter 3 that extends the MICM box model from Chapter 2 to demonstrate handling multiple grid cells simultaneously with a single call to the MICM solver.
What's Added
New Tutorial Documentation (
docs/source/tutorials/chapter3.rst)New Fortran Example Program (
fortran/test/fetch_content_integration/test_micm_multiple_grid_cells.F90)cell_strideandvar_stridefor multi-cell data accessUpdated Tutorial Index (
docs/source/tutorials/tutorials.rst)Key Features
The tutorial demonstrates several important concepts:
micm%solve()call handles all grid cells simultaneouslystate%concentrations(1 + (cell_id - 1) * cell_stride + (species_index - 1) * var_stride)Example Usage
This tutorial provides essential foundation knowledge for atmospheric modeling applications where hundreds or thousands of grid cells need efficient chemical mechanism processing.
Fixes #205.
Warning
Firewall rules blocked me from connecting to one or more addresses
I tried to connect to the following addresses, but was blocked by firewall rules:
ncar.github.io/usr/bin/python3 /home/REDACTED/.local/bin/sphinx-build -b html source build(dns block)If you need me to access, download, or install something from one of these locations, you can either:
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.