Area index in aux

[kmdeck]

Purpose

• Removes LAI and h_c from SharedCanopyParameters as those are duplicated in the PlantHydraulicsParameters
• Allows LAI to vary in time
• Builds some infrastructure for future parameters that vary in space and time.

To-do

• future PR: LAI(t) from Ozark data.

Content

1. LAI and h_c are removed from SharedCanopyParameters. The height of the canopy is now obtained from the last element of "compartment_surfaces" [plant hydraulics compartment surfaces, in the hydraulics model] and LAI is now obtained from the area_index. This removes duplication of parameter definition.
2. Replace the area_index (the constant named tuple of floats for SAI, RAI, and LAI) in PlantHydraulicsParameters with an area_index "model" (prescribed function for LAI(t), SAI::FT, RAI::FT, or eventually reading from a map).
3. Adds a field of NamedTuples to the auxiliary state: p.canopy.hydraulics.area_index
4. adds a "set initial aux state" method for the canopy which sets globally varying parameters (just area_index for now) with their initial values
5. adds an "update parameter fields" function which can be called in update aux which updates the area index (and eventually any other globally varying fields that change in time).
6. Adds a utils function for indexing fields of NamedTuples by symbol.

Discussion items

It may be that in the long run, these globally varying fields should be stored in p.canopy directly. we can build that when we need it? distiniguish between prescribed parameters in p and diagnostic params that depend on state? [currently not doing this]

One downside is that for some models (bucket, now canopy too and any model involving the canopy) we need to call "set_initial_aux_state!" and for some we dont. perhaps this should be a standard step in tutorials even if it isnt needed for all models? it could be confusing. [ we decided offline that all models will call this, even if not strictly required]

Review checklist

I have:

• followed the codebase contribution guide: https://clima.github.io/ClimateMachine.jl/latest/Contributing/
• followed the style guide: https://clima.github.io/ClimateMachine.jl/latest/DevDocs/CodeStyle/
• followed the documentation policy: https://github.com/CliMA/policies/wiki/Documentation-Policy
• checked that this PR does not duplicate an open PR.

In the Content, I have included

• relevant unit tests, and integration tests,
• appropriate docstrings on all functions, structs, and modules, and included relevant documentation.

---

• I have read and checked the items on the review checklist.

[juliasloan25]

Looks good! I think this is quite in line with what we've discussed. I just had a couple of small suggestions

[juliasloan25]

Also, for discussion item #2, I agree that all models should call set_initial_aux_state! for consistency, even if they don't need it for their functionality. They can maybe just use the default which calls update_aux (as we discussed earlier today)

[AlexisRenchon]

I just had a few food for thoughts comment, but it looks good to me!

[kmdeck]

Also, for discussion item #2, I agree that all models should call set_initial_aux_state! for consistency, even if they don't need it for their functionality. They can maybe just use the default which calls update_aux (as we discussed earlier today)

ok! Im going to open an issue for this (to add this to our tests/experiments/docs)

[kmdeck]

I just had a few food for thoughts comment, but it looks good to me!

thank you! Ill address your comments.

Do you think you could take on this issue? #275 related to our discussion last week.

[kmdeck]

bors r+

[bors]

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

• buildkite/climalsm-ci
• ci 1.9 - macOS-latest
• ci 1.9 - ubuntu-latest
• docbuild
• format