Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CppCheck log to log1p to see what diffs look like #10687

Merged
merged 1 commit into from
Sep 10, 2024

Conversation

rraustad
Copy link
Contributor

Pull request overview

  • Fixes CppCheck suggestion of log to log1p
  • Uses CppCheck as guide

NOTE: ENHANCEMENTS MUST FOLLOW A SUBMISSION PROCESS INCLUDING A FEATURE PROPOSAL AND DESIGN DOCUMENT PRIOR TO SUBMITTING CODE

Pull Request Author

Add to this list or remove from it as applicable. This is a simple templated set of guidelines.

  • Title of PR should be user-synopsis style (clearly understandable in a standalone changelog context)
  • Label the PR with at least one of: Defect, Refactoring, NewFeature, Performance, and/or DoNoPublish
  • Pull requests that impact EnergyPlus code must also include unit tests to cover enhancement or defect repair
  • Author should provide a "walkthrough" of relevant code changes using a GitHub code review comment process
  • If any diffs are expected, author must demonstrate they are justified using plots and descriptions
  • If changes fix a defect, the fix should be demonstrated in plots and descriptions
  • If any defect files are updated to a more recent version, upload new versions here or on DevSupport
  • If IDD requires transition, transition source, rules, ExpandObjects, and IDFs must be updated, and add IDDChange label
  • If structural output changes, add to output rules file and add OutputChange label
  • If adding/removing any LaTeX docs or figures, update that document's CMakeLists file dependencies

Reviewer

This will not be exhaustively relevant to every PR.

  • Perform a Code Review on GitHub
  • If branch is behind develop, merge develop and build locally to check for side effects of the merge
  • If defect, verify by running develop branch and reproducing defect, then running PR and reproducing fix
  • If feature, test running new feature, try creative ways to break it
  • CI status: all green or justified
  • Check that performance is not impacted (CI Linux results include performance check)
  • Run Unit Test(s) locally
  • Check any new function arguments for performance impacts
  • Verify IDF naming conventions and styles, memos and notes and defaults
  • If new idf included, locally check the err file and other outputs

@rraustad rraustad added the DoNotPublish Includes changes that shouldn't be reported in the changelog label Aug 23, 2024
@rraustad rraustad changed the title log to log1p to see what diffs look like CppCheck log to log1p to see what diffs look like Aug 23, 2024
@rraustad rraustad added this to the EnergyPlus 24.2 milestone Aug 23, 2024
@@ -6299,7 +6299,7 @@ Real64 CalcClearRoof(EnergyPlusData &state,

Real64 Rf = RoughnessMultiplier[(int)RoughnessIndex];
if (Rex > 0.1) { // avoid zero and crazy small denominators
Real64 tmp = std::log(1.0 + GrLn / pow_2(Rex));
Real64 tmp = std::log1p(GrLn / pow_2(Rex));
Copy link
Contributor Author

@rraustad rraustad Aug 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Testing this suggestion, diffs are very small:

[src/EnergyPlus/ConvectionCoefficients.cc:6302]:(style),[unpreciseMathCall],Expression 'log(1 + x)' can be replaced by 'log1p(x)' to avoid loss of precision.

@rraustad
Copy link
Contributor Author

ZoneCoupledKivaConvectionAdaptiveSmallOffice, diffs are small:

- Zone Sizing Information, PERIMETER_ZN_1, Cooling, 3300.72487, 3960.86984, 0.27508, 0.33009, CHICAGO ANN CLG .4% CONDNS WB=>MDB, 7/21 13:00:00, 30.66500, 1.87968E-002, 113.45000, 6.10603, 6.10603E-002, 0.00000
- Zone Sizing Information, PERIMETER_ZN_1, Heating, 7129.69393, 8555.63272, 0.31281, 0.37537, CHICAGO ANN HTG 99.6% CONDNS DB, 1/21 06:00:00, -20.60000, 6.12575E-004, 113.45000, 6.10603, 6.10603E-002, 0.00000
+ Zone Sizing Information, PERIMETER_ZN_1, Cooling, 3300.72486, 3960.86983, 0.27508, 0.33009, CHICAGO ANN CLG .4% CONDNS WB=>MDB, 7/21 13:00:00, 30.66500, 1.87968E-002, 113.45000, 6.10603, 6.10603E-002, 0.00000
+ Zone Sizing Information, PERIMETER_ZN_1, Heating, 7129.69393, 8555.63271, 0.31281, 0.37537, CHICAGO ANN HTG 99.6% CONDNS DB, 1/21 06:00:00, -20.60000, 6.12575E-004, 113.45000, 6.10603, 6.10603E-002, 0.00000

- Component Sizing Information, Coil:Cooling:DX:SingleSpeed, PSZ-AC:1_COOLC DXCOIL, Design Size Gross Rated Total Cooling Capacity [W], 7243.15622
+ Component Sizing Information, Coil:Cooling:DX:SingleSpeed, PSZ-AC:1_COOLC DXCOIL, Design Size Gross Rated Total Cooling Capacity [W], 7243.15619

- Component Sizing Information, Coil:Heating:Fuel, PSZ-AC:1_HEATC, Design Size Nominal Capacity [W], 12281.08991
+ Component Sizing Information, Coil:Heating:Fuel, PSZ-AC:1_HEATC, Design Size Nominal Capacity [W], 12281.08987

@Myoldmopar
Copy link
Member

I'm fine with the extremely tiny diffs here. You want this to drop in @rraustad ?

@rraustad
Copy link
Contributor Author

Please do. This was a test to see how the log1p function affected the answer without making that change in more than 1 place.

@Myoldmopar
Copy link
Member

In it goes, thanks @rraustad

@Myoldmopar Myoldmopar merged commit 08056a2 into develop Sep 10, 2024
16 checks passed
@Myoldmopar Myoldmopar deleted the CppCheck-ConvectionCoefficients-log1p branch September 10, 2024 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DoNotPublish Includes changes that shouldn't be reported in the changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants