Deprecate StFlow::evalResidual

[ischoegl]

Changes proposed in this pull request

This is a follow-up to #1595, as proposed here: #1595 (comment)

• Rename StFlow to Flow1D (which is consistent with other class names used for 1D simulations)
• Backport StFlow with legacy methods StFlow::evalResidual, etc.; issue a deprecation warning when constructor is called
• Reorder Flow1D content and add new named sections to improve doxygen documentation
• Add googletest for legacy StFlow in test-oneD

Other than renaming / reordering content and reintroducing legacy code for deprecation purposes, this PR does not introduce any new capabilities.

Checklist

• The pull request includes a clear description of this code change
• Commit messages have short titles and reference relevant issues
• Build passes (scons build & scons test) and unit tests address code coverage
• Style & formatting of contributed code follows contributing guidelines
• The pull request is ready for review

[ischoegl]

@speth ... this is the PR I had mentioned earlier. The diff is a little deceiving, as git doesn't acknowledge that files were renamed/removed and only partially re-added - the detailed commit history makes this a little clearer.

@wandadars ... this PR reorders the updateXYZ methods as you had envisioned.

[codecov]

Codecov Report

Attention: Patch coverage is 81.85291% with 190 lines in your changes missing coverage. Please review.

Project coverage is 72.80%. Comparing base (b4fa531) to head (0e7e224).
Report is 2 commits behind head on main.

Files	Patch %	Lines
src/oneD/Flow1D.cpp	84.86%	69 Missing and 43 partials ⚠️
src/oneD/StFlow.cpp	59.84%	43 Missing and 10 partials ⚠️
src/clib/ctonedim.cpp	52.00%	24 Missing ⚠️
src/oneD/IonFlow.cpp	85.71%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1619      +/-   ##
==========================================
- Coverage   72.84%   72.80%   -0.05%     
==========================================
  Files         379      381       +2     
  Lines       53824    54011     +187     
  Branches     9182     9207      +25     
==========================================
+ Hits        39208    39321     +113     
- Misses      11642    11706      +64     
- Partials     2974     2984      +10     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ischoegl]

@speth and @wandadars : I am closing this as there is too much interference with #1622.

[speth]

I think this is still worth pursuing in general, but waiting until some of the other changes @wandadars is working on are finished makes sense to me.

[ischoegl]

I believe the window of opportunity to resolve this in 3.1 is de facto closed (see also #1639).

[ischoegl]

Reopening so this can be tracked - I'd like to revisit as long as #1622 can be resolved prior to 3.1

[wandadars]

I have been testing the implementation against cases that I have solved using FlameMaster. So far I have been able to run an RCM1 H2/O2 ideal gas case using the "flamelets" generated by the two-point control method. I think that's a pretty good test of the implementation, so I will be making a push to merge that branch starting this week.

[ischoegl]

With #1622 being merged, I hope to rebase these changes to current main, so we can get those into 3.1.

[ischoegl]

Rebased.

PS: As mentioned on top, the PR is actually much smaller than indicated by the line count (renaming + back port is an unfortunate combination).

[speth]

Thanks, @ischoegl. This looks good to me. Just a couple of small comments.