Deprecating ConstDensityThermo class #645
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #645 +/- ##
=========================================
- Coverage 68.53% 68.5% -0.04%
=========================================
Files 368 368
Lines 40027 40027
=========================================
- Hits 27433 27419 -14
- Misses 12594 12608 +14
Continue to review full report at Codecov.
|
Codecov Report
@@ Coverage Diff @@
## master #645 +/- ##
=========================================
- Coverage 68.53% 68.5% -0.04%
=========================================
Files 368 368
Lines 40027 40027
=========================================
- Hits 27433 27419 -14
- Misses 12594 12608 +14
Continue to review full report at Codecov.
|
speth
reviewed
Jun 12, 2019
| @@ -2295,15 +2304,14 @@ def __init__(self, | |||
| initial_state, options) | |||
| self._tr = transport | |||
| self._n = site_density | |||
| self._species = species | |||
|
|
|||
There was a problem hiding this comment.
As minor as it is, I'd suggest that this fix for lattice be done in a separate commit, since it serves a distinct purpose, and 'Enable instantiation of lattice class in CTI files` is a nice thing to see in the commit log.
Removes references to incompressible_solid phase in the codebase. This phase type references ConstDensityThermo phase, which is a non-physical model and is to be deprecated, with Cantera 2.5. In order to enable deprecation, the following changes are hereby made: - Changes oxide_bulk phase type from incompressible_solid to lattice in sofc.cti - Changes test_convert.py so that it interrogates the density_mole of the bulk_oxide, rather than density_mass
The thermophase ConstDensityThermo instantiates a class with constant density_mass Such a model is of dubious physical validity/applicability and has minimal foreseeable use cases. This commit marks it for deprecation, and adds a message in ctml_writer.py (where the model has the misleading alias 'incompressible_solid') refering the interested user to consider appropriate alternate thermophase classes 'lattice' or 'IdealSolidSoln.'
decaluwe
force-pushed
the
const_density_deprecate
branch
from
7325d5e
to
88ac987
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
As previously discussed, the
incompressible_solidcti phase actually points to theConstDensityThermoclass. This is misleading to a user, and moreover, a thermo class which enforces constant mass density has both dubious physical underpinning and marginal utility for a user. It is therefore appropriate to deprecate and remove this class, and refer interested users to either theIdealSolidSolnPhaseorLatticethermo classes, which are appropriate replacements.Changes proposed in this pull request:
ConstDensityThermothermo class for deprecation, as of release 2.5, and for removal, thereafter.ctml_writer.pyparsing routine,ConstDensityThermo.cpp, andConstDensityThermo.hto indicate as much, and suggest use ofLatticeorIdealSolidSolnPhaseclasses as alternatesincompressible_solidphase insofc.cti(which is used for the sofc example, and which aliases to theConstDensityThermoclass) and replaces it with an equivalentLatticephase.test_convert.pywhich interrogates theincompressible_solidphase mass density insofc.ctiso that it instead interrogates theLatticephase molar density.