Additional checks for crown depth allometry parameters

[mpaiao]

Description:

This pull request intends to address the discussion in #1308, by adding multiple sanity checks on the parameters for height to crown depth allometry in subroutine PRTCheckParams. With this revision, it will issue either an error or a warning, depending on the severity of the problem.

1. Fatal errors

• When fates_allom_h2cd1 ≤ 0.
• When fates_allom_dmode = 1 and fates_allom_h2cd1 > 1.
• When fates_allom_dmode = 2, fates_allom_h2cd2 = 1 and fates_allom_h2cd1 > 1 (which is identical to previous case).

2. Warning.

• When fates_allom_dmode = 2, fates_allom_h2cd1 < 1 and fates_allom_h2cd1 is such that crown depth would exceed height for small cohorts.
• When fates_allom_dmode = 2, fates_allom_h2cd1 > 1 and fates_allom_h2cd1 is such that crown depth would exceed height for large cohorts.

In the warning cases, FATES was already applying a cap to prevent crown depth to exceed height, but this was done quietly. The code now issues a warning during initialisation.

Collaborators:

@glemieux @rgknox @ekluzek

Expectation of Answer Changes:

No change in the results expected, except that now the code will not even run if the parameters are out of bounds, or at least issue a warning when some potentially unwanted behaviour occurs.

Checklist

If this is your first time contributing, please read the CONTRIBUTING document.

All checklist items must be checked to enable merging this pull request:

Contributor

• The in-code documentation has been updated with descriptive comments
• The documentation has been assessed to determine if updates are necessary

Integrator

• FATES PASS/FAIL regression tests were run
• Evaluation of test results for answer changes was performed and results provided

Documentation

• Technical Note update:
• User's Guide update:

Test Results:

CTSM (or) E3SM (specify which) test hash-tag:

CTSM (or) E3SM (specify which) baseline hash-tag:

FATES baseline hash-tag:

Test Output: