Expose result of convergence of LOM analysis' Q3D renderer to end user #915
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
Convergence data is extracted from q3d simulation. Implementation is copied from Sweeping class
is_converged property is added to LumpedElementsSim class
Add 2 tests to get convergence boolean. 1. Test to get True when simulation converge 2. Test to get False when simulation did not converge
is_converged variable is added to the data labels
The notebook is executed to illustrate the usage of is_converged key. Example is shown in the notebook with accompanying textual explanation.
The notebook is updated to illustrate the use of is_converged key. Code example accompanying textual explanation is added to the notebook. The notebook is not executed.
priti-ashvin-shah-ibm
requested review from
priti-ashvin-shah-ibm,
ThomasGM4 and
obrienpja
priti-ashvin-shah-ibm
approved these changes
Jan 31, 2023
|
Will merge for you. |
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.
✅ I have added the tests to cover my changes.
✅ I have updated the documentation accordingly.
✅ I have read the CONTRIBUTING document.
What are the issues this pull addresses (issue numbers / links)?
Fixes #914
Did you add tests to cover your changes (yes/no)?
Yes
Did you update the documentation accordingly (yes/no)?
Yes
Did you read the CONTRIBUTING document (yes/no)?
Yes
Summary
Currently, the result of convergence of LOM Analysis' Q3D renderer is not exposed to the end user.
Exposing the result of convergence to the user would give feedback to the user on whether the results obtained is reliable. Users can also programatically increase the number of passes and rerun the simulation to achieve convergence.
Details and comments
The PR only covers Q3D renderer at the moment.