New PR closes #284 regarding adding scalar boundary conditions#298
Open
Jiya-Rathi wants to merge 11 commits intomainfrom
Open
New PR closes #284 regarding adding scalar boundary conditions#298Jiya-Rathi wants to merge 11 commits intomainfrom
Jiya-Rathi wants to merge 11 commits intomainfrom
Conversation
…nditions This commit pushes 3 files: src/cpp/addscalarbc.h implementing functional overloading, src/cpp/addscalarbc.cpp added helper functions and overloading for reducing code repeatation, tests/cpp/test_addscalarbc.cpp added more tests to this to make testing more comprehensive.
Collaborator
|
I have reviewed this work. It can be merged to main as it is but Jiya and I would like to suggest to clean the implementation further and replace the calls to addScalarBC1D, addScalarBC2D and addScalarBC3D from the examples and tests with calls to addScalarBC (C++ overloading) directly. |
This file contains hidden or 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
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 type of PR is this? (check all applicable)
Description
Is your feature request related to a problem? Please describe.
Closing the implementation gap of MOLE functionality between MATLAB/Octave and C++
Describe the solution you'd like
Building on @jbrzensk proposed AddScalar function C++ implementations (for multiple dimensions), we will complete the implementation using C++ functional overloading + reducing the duplication of code by creating addition functions used in the set up of non-periodic boundary conditions. In addition, extra tests have been added.
Describe alternatives you've considered
We explored the @jbrzensk original implementation and reduced code redundancy and use C++ function overloading. We are testing @jbrzensk original tests + additional functional tests. Remove some special characters from the comments that were causing issues
Additional context
For compatibility with existing tests, we will provide 3 header functions that call AddScalarBC (overloading) for the 1D, 2D, 3D cases. The tests call these header functions (i.e., AddScalarBC1D, AddScalarBC2D and AddScalarBC3D)
Related Issues & Documents
QA Instructions, Screenshots, Recordings
Build using the instructions in the README.md and then run the executable called test_addscalarbc
Added/updated tests?
have not been included
Read Contributing Guide and Code of Conduct