similar: always return a PencilArray
#83
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
This PR changes the behaviour of `similar(u::PencilArray, [T], [dims])` when the `dims` argument is passed. First note that we cannot construct a `PencilArray` which is "similar" to `u` but having different dimensions, since in that case we would need to generate a new `Pencil` configuration which is not supported. For this reason, and to make sure that the return type doesn't depend on the value of `dims`, calling `similar` used to return a non-distributed array (most often a regular `Array`) whenever `dims` was passed. Now, we instead make sure that `similar` always returns a `PencilArray`. This is in particular needed if one wants to combine PencilArray, StructArrays and DiffEq.jl. So, when `dims` is passed, we now throw an error if `dims` is different from the size of `u`.
Codecov Report
@@ Coverage Diff @@
## master #83 +/- ##
==========================================
+ Coverage 96.67% 96.76% +0.08%
==========================================
Files 24 24
Lines 1233 1235 +2
==========================================
+ Hits 1192 1195 +3
+ Misses 41 40 -1
|
[skip ci]
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.
This PR changes the behaviour of
similar(u::PencilArray, [T], [dims])when thedimsargument is passed.First note that we cannot construct a
PencilArraywhich is "similar" toubut having different dimensions, since in that case we would need to generate a newPencilconfiguration which is not supported.For this reason, and to make sure that the return type doesn't depend on the value of
dims, callingsimilarused to return a non-distributed array (most often a regularArray) wheneverdimswas passed.Now, we instead make sure that
similaralways returns aPencilArray. This is in particular needed if one wants to combine PencilArray, StructArrays and DiffEq.jl. So, whendimsis passed, we now throw an error ifdimsis different from the size ofu.