Update cfe.c

[fred-ogden]

Fixed major bug in xinanjiang function. One minor bass balance fix. Refactored. Verified code against NWM Fortran Xinanjiang function. Changed "infiltation_excess_params_struct" to "infiltration_excess_params_structure". Added "#ifdef DEBUG #endif around mass balance warning print statement at end of xinanjiang scheme function.

[Short description explaining the high-level reason for the pull request]

Additions

• None

Removals

• none

Changes

• Major bug fix: if ( ( W / Wmax ) <= (0.5 - a)) {
  // THIS LINE IN ORIGINAL CFE XINANJIANG CODE IS A BUG
  // f_over_F = (pow((0.5 - a),(1.0 - b)) * pow((1.0 - (tension_water_m/max_tension_water_m)) , b));

  // FLO correct comparing against Eqn. 2a in Jayawardena & Zhou (2000)
  f_over_F = (pow((0.5 - a),(1.0 - b)) * pow( W / Wmax , b)); // Eqn. 2a in Jayawardena & Zhue

  } else { // if ( (0.5-a) < W / Wmax )
  f_over_F = 1.0 - pow((0.5 + a), (1.0 - b)) * pow((1.0 - W / Wmax) , b); // Eqn. 2b in Jayawardena & Zhue
  }

Minor bass balance bug fix: //edited by RLM; added logic block to handle what happens when porosity or field capacity = 0
//FLO changed from 0.95 to 1.0 because what happens to the other 5% ?
if (max_free_water_m <= 0.0 || max_tension_water_m <=0.0) {
*infiltration_excess_m = 1.0 * water_input_pervious_fraction_m + impervious_runoff_m;
*infiltration_excess_m += impervious_runoff_m; // must add impervious runoff back in
*infiltration_depth_m = 0.0; //added by FLO
return; // this is an unusual situation and should only happen when one or both parameters are zero
}

Testing

Screenshots

Notes

• Verified with Xinanjiang() Fortran routine in NWM3.0 within 1.0e-05.

Todos

• None

Checklist

• PR has an informative and human-readable title
• Changes are limited to a single goal (no scope creep)
• Code can be automatically merged (no conflicts)
• Code follows project standards (link if applicable)
• Passes all existing automated tests
• Any change in functionality is tested
• New functions are documented (with a description, list of inputs, and expected output)
• Placeholder code is flagged / future todos are captured in comments
• Visually tested in supported browsers and devices (see checklist below 👇)
• Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
• Reviewers requested with the Reviewers tool ➡️

Testing checklist

Target Environment support

• Windows
• Linux
• Browser

Accessibility

• Keyboard friendly
• Screen reader friendly

Other

• Is useable without CSS
• Is useable without JS
• Flexible from small to large screens
• No linting errors or warnings
• JavaScript tests are passing

[ajkhattak]

Looks good! Thanks @fred-ogden for finding and fixing the bug