Added doc to MultiResolutionAnalysis.cpp #228
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 ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #228 +/- ##
==========================================
+ Coverage 65.67% 65.70% +0.03%
==========================================
Files 185 185
Lines 10234 10232 -2
==========================================
+ Hits 6721 6723 +2
+ Misses 3513 3509 -4 ☔ View full report in Codecov by Sentry. |
|
robertodr
reviewed
Feb 13, 2024
robertodr
reviewed
Feb 13, 2024
| * | ||
| * @brief Contructs a MultiResolutionAnalysis object composed of computational domain (world) and a polynomial basis (Multiwavelets) from a pre-existing BoundingBox object | ||
| * | ||
| * @param[in] bb: BoundingBox object representing the computational domain |
There was a problem hiding this comment.
same here about adding the types to the parameter documentation
robertodr
reviewed
Feb 13, 2024
robertodr
reviewed
Feb 13, 2024
robertodr
reviewed
Feb 13, 2024
robertodr
reviewed
Feb 13, 2024
| * @details Inequality operator for the MultiResolutionAnalysis class, returns true if both MRAs have the same polynomial basis represented by a BoundingBox object, computational domain (ScalingBasis object) and maximum depth (integer), and false otherwise. | ||
| * Opposite of the == operator. | ||
| * For more information about the meaning of equality for BoundingBox and ScalingBasis objets, see their respective classes. | ||
| */ | ||
| template <int D> bool MultiResolutionAnalysis<D>::operator!=(const MultiResolutionAnalysis<D> &mra) const { |
There was a problem hiding this comment.
now that I see this, it seems duplicated... Usually either one implements operator== or operator!= in full then the other is simply return !(left == right) @stigrj?
robertodr
reviewed
Feb 13, 2024
robertodr
reviewed
Feb 13, 2024
robertodr
reviewed
Feb 13, 2024
| template <int D> bool MultiResolutionAnalysis<D>::operator==(const MultiResolutionAnalysis<D> &mra) const { | ||
| if (this->basis != mra.basis) return false; | ||
| if (this->world != mra.world) return false; | ||
| if (this->maxDepth != mra.maxDepth) return false; | ||
| return true; | ||
| } | ||
|
|
||
| /** @returns Boolean value |
There was a problem hiding this comment.
/** @returns Whether the two MRA objects are not equal.
robertodr
reviewed
Feb 13, 2024
robertodr
reviewed
Feb 13, 2024
Comment on lines
174
to
177
| * @brief TODO: Sets up the filters | ||
| * | ||
| * @details TBD | ||
| * |
There was a problem hiding this comment.
you should fill these out.
robertodr
reviewed
Feb 13, 2024
| @@ -117,6 +193,14 @@ template <int D> void MultiResolutionAnalysis<D>::setupFilter() { | |||
| } | |||
| } | |||
|
|
|||
| /** @returns double (double-precision floating point number) | |||
There was a problem hiding this comment.
you should write down what the function returns, not its type. The type will be provided by doxygen.
robertodr
reviewed
Feb 13, 2024
Comment on lines
200
to
201
| * @details This function displays the attributes of the MRA in the using the Printer class. | ||
| * By default, the Printer class writes all information in the output file, not the terminal. |
There was a problem hiding this comment.
this seems a copy-paste? Please check.
robertodr
requested changes
Feb 13, 2024
…o MultiResolutionAnalysis.rst
Thanks Roberto! Co-authored-by: Roberto Di Remigio Eikås <[email protected]>
stigrj
approved these changes
Feb 27, 2024
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.
Created a new branch fresh off the latest commit in the master in which I copied the doc I had written.
I had to do it because I mistakenly used "git add *" in the old one and that induced stupid errors.