update README with solver upgrades #117
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
b-fg
reviewed
Mar 29, 2024
b-fg
reviewed
Mar 29, 2024
README.md
Outdated
| Simulation((512,384), (1,0), 32; body, perdir=(2,)) | ||
| ``` | ||
|
|
||
| Additionally, the flag `exitBC=true` can be passed to the `Simulation` function to enable convective boundary conditions. This will apply a 1D convective exit in the __`x`__ direction (there is not way to change this at the moment). The `exitBC` flag is set to `false` by default. |
There was a problem hiding this comment.
Explain what exitBC=false defaults too?
b-fg
reviewed
Mar 29, 2024
b-fg
reviewed
Mar 29, 2024
b-fg
reviewed
Mar 29, 2024
b-fg
reviewed
Mar 29, 2024
|
Is there anything else to be done here? |
Co-authored-by: Bernat Font <[email protected]>
Co-authored-by: Bernat Font <[email protected]>
Co-authored-by: Bernat Font <[email protected]>
Co-authored-by: Bernat Font <[email protected]>
Co-authored-by: Bernat Font <[email protected]>
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #117 +/- ##
=======================================
Coverage 96.13% 96.13%
=======================================
Files 12 12
Lines 491 491
=======================================
Hits 472 472
Misses 19 19 ☔ View full report in Codecov by Sentry. |
|
I fixed everything. This is ready. |
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 realized that some of the solver's new capabilities are not well documented. I have updated the README.md with a few useful things.