Skip to content

Rename Inlet1d.h / Bdry1d#815

Merged
speth merged 3 commits intoCantera:masterfrom
ischoegl:rename-bdry1d
Jun 5, 2020
Merged

Rename Inlet1d.h / Bdry1d#815
speth merged 3 commits intoCantera:masterfrom
ischoegl:rename-bdry1d

Conversation

@ischoegl
Copy link
Copy Markdown
Member

@ischoegl ischoegl commented Feb 29, 2020

Checklist

  • There is a clear use-case for this code change
  • The commit message has a short title & references relevant issues
  • Build passes (scons build & scons test) and unit tests address code coverage
  • The pull request is ready for review

If applicable, fill in the issue number this pull request is fixing

Resolves “small” project idea (see 1D Flame Development Ideas):

Make class and file names clear and consistent: Inlet1D.h should be named Boundary1D.h, and class Bdry1D should be named Boundary1D.

Changes proposed in this pull request

While the Boundary1D.h diff does not show a good overview, individual commits do:

  • 162d5fb (which renames Brdy1D to Boundary1D, etc.),
  • 62dd18a (handling of deprecation) and
  • 86892fa (which replaces doublereal by double; since entire files are renamed, I felt like this was an appropriate occasion).

Further:
 * rename Inlet1D.h to Boundary1D.h
 * rename boundaries1D.cpp to Boundary1D.cpp
Re-add Inlet1D to define Brdy1D; deprecation warnings are issued for both.
The separate commit should keep the diff smaller.
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 29, 2020

Codecov Report

Merging #815 into master will decrease coverage by 0.01%.
The diff coverage is 45.54%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #815      +/-   ##
==========================================
- Coverage   71.39%   71.37%   -0.02%     
==========================================
  Files         372      372              
  Lines       43482    43482              
==========================================
- Hits        31045    31037       -8     
- Misses      12437    12445       +8
Impacted Files Coverage Δ
src/clib/ctonedim.cpp 0% <0%> (ø) ⬆️
include/cantera/oneD/Boundary1D.h 46.42% <46.42%> (ø)
src/oneD/Boundary1D.cpp 51.11% <51.28%> (ø)
include/cantera/oneD/OneDim.h 17.02% <0%> (-12.77%) ⬇️
include/cantera/oneD/StFlow.h 86.04% <0%> (-4.66%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c16c4b0...86892fa. Read the comment docs.

Copy link
Copy Markdown
Member

@speth speth left a comment

Choose a reason for hiding this comment

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

This seems straightforward enough to me. While there are lots of little naming warts throughout Cantera, this one was especially messy, and is worth cleaning up.

@speth speth merged commit 05bd22d into Cantera:master Jun 5, 2020
@ischoegl ischoegl deleted the rename-bdry1d branch July 13, 2020 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants