OneD domain factories and cleanup

[ischoegl]

Changes proposed in this pull request

• Implement DomainFactory (see https://github.com/Cantera/cantera/projects/2)
• Initial simplifications in Python API
• Deprecate magic numbers in Domain1D::domainType
• Replace raw pointers by shared pointers in assembly of Sim1D.
• Remove solution from Domain1D::show and Sim1D::show to avoid erroneous conflation with Solution objects
• Introduce clib function returning domain type as well as new_domain factory loader (to facilitate Matlab toolbox revamp #1182)

While other tweaks are possible, they will create merge conflicts with #1079

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

Implements one 'idea' in https://github.com/Cantera/cantera/projects/2

If applicable, provide an example illustrating new features this pull request is introducing

shared_ptr<Domain1D> inlet = newDomain("inlet", sol, "reactants");
shared_ptr<Domain1D> flow = newDomain("gas-flow", sol, "flow");

for clib, the following items are added:

int domain_type3(int i, size_t lennm, char* nm); /* returns char* instead of magic number */
int sim1D_show(int i, const char* fname); /* replaces sim1D_showSolution */
int bdry_setSpreadRate(int i, double v); /* replaces inlet_setSpreadRate */
double bdry_spreadRate(int i); /* add missing getter */

int soln_setTransportModel(int n, const char* model); /* addendum to #1448 */
int trans_transportModel(int n, int lennm, char* nm); /* returns char* specifying transport type */

int domain_new(const char* type, int i, const char* id); /* factory constructor */

For the Python API, the following items are (re-)introduced:

flow = ct.FreeFlow(gas)
flow = ct.AxisymmetricFlow(gas)

with IdealGasFlow being deprecated.

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

[codecov]

Codecov Report

Merging #1445 (6d84d7f) into main (0c5fc1d) will decrease coverage by 0.05%.
The diff coverage is 61.83%.

@@            Coverage Diff             @@
##             main    #1445      +/-   ##
==========================================
- Coverage   69.86%   69.81%   -0.05%     
==========================================
  Files         373      375       +2     
  Lines       56684    56872     +188     
  Branches    18883    18980      +97     
==========================================
+ Hits        39600    39705     +105     
- Misses      14571    14650      +79     
- Partials     2513     2517       +4     

Impacted Files	Coverage Δ
include/cantera/oneD/IonFlow.h	84.61% <ø> (ø)
include/cantera/oneD/OneDim.h	53.62% <ø> (ø)
include/cantera/oneD/Sim1D.h	66.66% <ø> (-3.34%)	⬇️
src/clib/ctmultiphase.cpp	0.00% <0.00%> (ø)
src/oneD/IonFlow.cpp	49.14% <0.00%> (-1.15%)	⬇️
src/oneD/Domain1D.cpp	71.59% <15.38%> (-4.63%)	⬇️
src/oneD/Boundary1D.cpp	55.39% <16.66%> (-0.03%)	⬇️
include/cantera/oneD/Boundary1D.h	48.97% <33.33%> (-6.58%)	⬇️
src/clib/ctonedim.cpp	20.91% <37.50%> (+0.02%)	⬆️
include/cantera/oneD/Domain1D.h	79.23% <40.00%> (-1.54%)	⬇️
... and 12 more

... and 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[ischoegl]

@speth ... after running into #1447 (which likely involves tackling Cantera/enhancements#158) I am omitting factory constructors in clib for the moment.

[ischoegl]

Converting back to draft, as this should be merged after #1448.

[ischoegl]

Rebased after the merge of #1448; some experiments for the introduction of SharedCabinet and/or newDomain factory constructors indicate that updates to clib/ctonedim will have to be somewhat more extensive than anticipated, and are postponed for another time. Edit: changes are now incorporated.

[ischoegl]

Resolved a minor merge conflict introduced by #1426.

[speth]

Thanks, @ischoegl. This looks very good, and I think having the 1D code start to use the factory infrastructure that we have for most other object types will simplify some future additions (say, ExtensibleDomain). I had only a handful of minor suggestions.

[ischoegl]

@speth ... thanks for the review! I adopted some suggestions, and responded to others. Edit: I removed StFlow::isFree as I don't think that a new methods should be introduced.

[speth]

Thanks for the updates, @ischoegl. This looks good to me.