rft: eddy diffusivity docstrings #4107
Open
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 pull request refactors and improves the implementation and documentation of the eddy diffusivity coefficient calculation and its application in the vertical diffusion boundary layer tendency routines. The main changes include moving coefficient helper functions to a more appropriate file, enhancing documentation, simplifying function signatures, and improving code clarity and maintainability.
Refactoring and code organization:
eddy_diffusivity_coefficient_Handeddy_diffusivity_coefficientfromprecomputed_quantities.jltoeddy_diffusivity_coefficient.jl, consolidating all eddy diffusivity logic in one place. [1] [2]Documentation and interface improvements:
ᶜcompute_eddy_diffusivity_coefficientfor bothDecayWithHeightDiffusionandVerticalDiffusionmodels, explaining the formulas, arguments, and usage.vertical_diffusion_boundary_layer_tendency!, removing unnecessary arguments and improving readability.Boundary layer tendency routine enhancements: