Feature/doc phys - #560
Conversation
There was a problem hiding this comment.
🟡 Not ready to approve
There are several concrete documentation issues (typos/grammar and at least one likely equation-moment typo in the radiation derivation) that should be corrected before merging.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
This PR updates the SCALE-DG documentation to address Issue #552 by adding/expanding descriptions of key physical parameterizations (MYNN level-2 PBL turbulence, simplified radiation schemes, and a slab ocean model), along with supporting references and cross-references.
Changes:
- Add new documentation chapters for radiation, boundary-layer turbulence (MYNN L2.0), and a slab ocean model.
- Expand turbulence documentation and improve cross-referencing across the physics description chapters.
- Add BibTeX entries needed to cite the added/updated documentation.
File summaries
| File | Description |
|---|---|
| doc/reference.bib | Adds citations used by the new/updated physics documentation sections. |
| doc/description/turbulence.tex | Adds LES/SGS intro text, a subsection label, and a shared “Common formulation” discussion. |
| doc/description/surface_flux.tex | Adds a label for the simple bulk flux subsection so it can be referenced elsewhere. |
| doc/description/scale_dg_description.tex | Integrates the new physics documentation chapters into the main description document. |
| doc/description/radiation.tex | New radiation chapter describing simplified radiative transfer and implemented schemes. |
| doc/description/pbl_turbulence.tex | New PBL turbulence chapter describing MYNN level 2.0 and common diffusion formulation. |
| doc/description/ocean.tex | New slab ocean chapter documenting the single-layer SST prognostic model. |
| doc/description/dynamics_spatial_discretization.tex | Adds a section label for cross-referencing the diffusion/DG discretization discussion. |
Review details
Suppressed comments (1)
doc/description/ocean.tex:65
- This \eqref uses the misspelled label name "eq:goevern_eq_slab_ocean"; it should match the corrected label so references resolve consistently.
Therefore, the governing equation (Eq.\,\eqref{eq:goevern_eq_slab_ocean}) is integrated using the forward Euler method.
- Files reviewed: 8/8 changed files
- Comments generated: 6
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
close #552