Ignoring Fluid density warning for Component Fluids #2075
Merged
+77
−2
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
#1852 introduced a warning when `Component.material.density(...)` was invoked. The rationale is the `Component` is the source of truth for volume, density, mass, etc. And components are the things that are thermally expanded. However, fluids are not thermally expanded and so the density of a fluid material is appropriate. This change undoes the density wrapper applied by the base `Material` when creating a `Fluid` subclass. A test is added to show that any non-`Fluid` subclass still logs the warning, but a `Fluid` subclass does not. I attempted to use a "real" material like `Sodium` but lots of other warnings can be logged depending on appropriate bounds of temperatures. So a fake Fluid is used to have more control over what warnings are logged.
john-science
changed the title
john-science
reviewed
Feb 6, 2025
john-science
reviewed
Feb 6, 2025
john-science
reviewed
Feb 6, 2025
drewj-tp
commented
Feb 6, 2025
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.
What is the change?
Calling
Component.material.densitydoes not log a warning with a traceback if the material is a subclass ofFluidWhy is the change being made?
TH applications need fluid densities and the traceback invocation is kind of a bottleneck.
#1852 introduced a warning when
Component.material.density(...)was invoked. The rationale is theComponentis the source of truth for volume, density, mass, etc. And components are the things that are thermally expanded.However, fluids are not thermally expanded and so the density of a fluid material is appropriate.
This change undoes the density wrapper applied by the base
Materialwhen creating aFluidsubclass.A test is added to show that any non-
Fluidsubclass still logs the warning, but aFluidsubclass does not.I attempted to use a "real" material like
Sodiumbut lots of other warnings can be logged depending on appropriate bounds of temperatures. So a fake Fluid is used to have more control over what warnings are logged.I contend that the stack trace should still be used in this message. This is a message meant for application developers to root out problematic parts of their codebase. And it helped us pinpoint very specific call locations with ease.
Checklist
docfolder.pyproject.toml.