Improvements for hermitespline interpolation #3298
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,17 +27,18 @@ | |
| #include <bout/bout_types.hxx> | ||
| #include <bout/generic_factory.hxx> | ||
| #include <bout/mask.hxx> | ||
| #include <array> | ||
|
|
||
| #if BOUT_HAS_PETSC | ||
| #include "bout/petsclib.hxx" | ||
| #endif | ||
|
|
||
| namespace { | ||
| enum class implementation_type { new_weights, petsc, legacy }; | ||
| } | ||
|
|
||
| class Options; | ||
| class GlobalField3DAccess; | ||
|
|
||
| /// Interpolate a field onto a perturbed set of points | ||
| const Field3D interpolate(const Field3D& f, const Field3D& delta_x, | ||
|
|
@@ -135,14 +136,26 @@ public: | |
| } | ||
| }; | ||
|
|
||
| /// Monotonic Hermite spline interpolator | ||
| /// | ||
| /// Similar to XZHermiteSpline, so uses most of the same code. | ||
| /// Forces the interpolated result to be in the range of the | ||
| /// neighbouring cell values. This prevents unphysical overshoots, | ||
| /// but also degrades accuracy near maxima and minima. | ||
| /// Perhaps should only impose near boundaries, since that is where | ||
| /// problems most obviously occur. | ||
| template <bool monotonic, implementation_type imp_type> | ||
| class XZHermiteSplineBase : public XZInterpolation { | ||
|
Contributor
There was a problem hiding this comment. warning: class 'XZHermiteSplineBase' defines a non-default destructor but does not define a copy constructor, a copy assignment operator, a move constructor or a move assignment operator [cppcoreguidelines-special-member-functions] class XZHermiteSplineBase : public XZInterpolation {
^ |
||
| protected: | ||
| /// This is protected rather than private so that it can be | ||
| /// extended and used by HermiteSplineMonotonic | ||
|
|
||
| Tensor<SpecificInd<IND_TYPE::IND_3D>> i_corner; // index of bottom-left grid point | ||
| Tensor<int> k_corner; // z-index of bottom-left grid point | ||
|
|
||
| std::unique_ptr<GlobalField3DAccess> gf3daccess; | ||
|
Contributor
There was a problem hiding this comment. warning: member variable 'gf3daccess' has protected visibility [cppcoreguidelines-non-private-member-variables-in-classes] std::unique_ptr<GlobalField3DAccess> gf3daccess;
^ |
||
| Tensor<std::array<int, 4>> g3dinds; | ||
|
Contributor
There was a problem hiding this comment. warning: member variable 'g3dinds' has protected visibility [cppcoreguidelines-non-private-member-variables-in-classes] Tensor<std::array<int, 4>> g3dinds;
^
dschwoerer marked this conversation as resolved.
|
||
|
|
||
| // Basis functions for cubic Hermite spline interpolation | ||
| // see http://en.wikipedia.org/wiki/Cubic_Hermite_spline | ||
| // The h00 and h01 basis functions are applied to the function itself | ||
|
|
@@ -160,23 +173,28 @@ protected: | |
|
|
||
| std::vector<Field3D> newWeights; | ||
|
|
||
| #if BOUT_HAS_PETSC | ||
| PetscLib* petsclib; | ||
| bool isInit{false}; | ||
| Mat petscWeights{}; | ||
|
dschwoerer marked this conversation as resolved.
|
||
| Vec rhs{}, result{}; | ||
|
dschwoerer marked this conversation as resolved.
dschwoerer marked this conversation as resolved.
|
||
| #endif | ||
|
|
||
| /// Factors to allow for some wiggleroom | ||
| BoutReal abs_fac_monotonic{1e-2}; | ||
|
Contributor
There was a problem hiding this comment. warning: member variable 'abs_fac_monotonic' has protected visibility [cppcoreguidelines-non-private-member-variables-in-classes] BoutReal abs_fac_monotonic{1e-2};
^ |
||
| BoutReal rel_fac_monotonic{1e-1}; | ||
|
Contributor
There was a problem hiding this comment. warning: member variable 'rel_fac_monotonic' has protected visibility [cppcoreguidelines-non-private-member-variables-in-classes] BoutReal rel_fac_monotonic{1e-1};
^ |
||
|
|
||
| public: | ||
| XZHermiteSplineBase(Mesh* mesh = nullptr, [[maybe_unused]] Options* options = nullptr) | ||
| : XZHermiteSplineBase(0, mesh, options) {} | ||
| XZHermiteSplineBase(int y_offset = 0, Mesh* mesh = nullptr, Options* options = nullptr); | ||
| XZHermiteSplineBase(const BoutMask& mask, int y_offset = 0, Mesh* mesh = nullptr, | ||
| Options* options = nullptr) | ||
| : XZHermiteSplineBase(y_offset, mesh, options) { | ||
| setRegion(regionFromMask(mask, localmesh)); | ||
| } | ||
| ~XZHermiteSplineBase() override { | ||
| #if BOUT_HAS_PETSC | ||
| if (isInit) { | ||
| MatDestroy(&petscWeights); | ||
| VecDestroy(&rhs); | ||
|
|
@@ -205,61 +223,21 @@ public: | |
| getWeightsForYApproximation(int i, int j, int k, int yoffset) override; | ||
| }; | ||
|
|
||
| using XZMonotonicHermiteSplineSerial = | ||
| XZHermiteSplineBase<true, implementation_type::new_weights>; | ||
| using XZHermiteSplineSerial = | ||
| XZHermiteSplineBase<false, implementation_type::new_weights>; | ||
| using XZMonotonicHermiteSplineLegacy = | ||
| XZHermiteSplineBase<true, implementation_type::legacy>; | ||
| using XZHermiteSplineLegacy = XZHermiteSplineBase<false, implementation_type::legacy>; | ||
| #if BOUT_HAS_PETSC | ||
| using XZMonotonicHermiteSpline = XZHermiteSplineBase<true, implementation_type::petsc>; | ||
| using XZHermiteSpline = XZHermiteSplineBase<false, implementation_type::petsc>; | ||
| #else | ||
| using XZMonotonicHermiteSpline = | ||
| XZHermiteSplineBase<true, implementation_type::new_weights>; | ||
| using XZHermiteSpline = XZHermiteSplineBase<false, implementation_type::new_weights>; | ||
| #endif | ||
|
|
||
| /// XZLagrange4pt interpolation class | ||
| /// | ||
|
|
||
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -80,7 +80,7 @@ public: | |
| } | ||
|
|
||
| void pop() {} | ||
| void pop([[maybe_unused]] int id) {} | ||
| void clear() {} | ||
|
|
||
| void dump() {} | ||
|
|
||
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
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
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -534,6 +534,8 @@ int BoutMesh::load() { | |||||||||
| PE_XIND = MYPE % NXPE; | ||||||||||
| PE_ZIND = 0; | ||||||||||
|
|
||||||||||
| ASSERT2(MYPE == getProcIndex(PE_XIND, PE_YIND, PE_ZIND)); | ||||||||||
|
Contributor
There was a problem hiding this comment. warning: no header providing "ASSERT2" is directly included [misc-include-cleaner] ASSERT2(MYPE == getProcIndex(PE_XIND, PE_YIND, PE_ZIND));
^ |
||||||||||
|
|
||||||||||
| // Set the other grid sizes from nx, ny, nz | ||||||||||
| setDerivedGridSizes(); | ||||||||||
|
|
||||||||||
|
|
@@ -1015,6 +1017,8 @@ void BoutMesh::createXBoundaries() { | |||||||||
| } | ||||||||||
| } | ||||||||||
|
|
||||||||||
| int BoutMesh::getProcIndex(int X, int Y, int Z) const { return Y * NXPE + X; } | ||||||||||
|
Contributor
There was a problem hiding this comment. warning: '*' has higher precedence than '+'; add parentheses to explicitly specify the order of operations [readability-math-missing-parentheses]
Suggested change
Contributor
There was a problem hiding this comment. warning: parameter 'Z' is unused [misc-unused-parameters]
Suggested change
Contributor
There was a problem hiding this comment. warning: unused parameter 'Z' [clang-diagnostic-unused-parameter] int BoutMesh::getProcIndex(int X, int Y, int Z) const { return Y * NXPE + X; }
^ |
||||||||||
|
|
||||||||||
| void BoutMesh::createYBoundaries() { | ||||||||||
| if (MYG <= 0) { | ||||||||||
| return; | ||||||||||
|
|
||||||||||
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
warning: enum 'implementation_type' uses a larger base type ('int', size: 4 bytes) than necessary for its value set, consider using 'std::uint8_t' (1 byte) as the base type to reduce its size [performance-enum-size]