Skip to content

XZHermiteSpline: Move implementation_type to bout::details #3317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bendudson merged 3 commits into from
Mar 11, 2026
Merged

XZHermiteSpline: Move implementation_type to bout::details #3317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
05fe2a8
XZHermiteSpline: Move implementation_type to bout::details
bendudson Mar 11, 2026
64e4285
[bot] Apply format changes
bendudson Mar 11, 2026
94effb6
[bot] Add last format changes commit to ignore file
bendudson Mar 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .git-blame-ignore-revs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@ d1cfb8abd6aa5c76e6c1a4d7ab20929c65f8afc2
ec69e8838be2dde140a915e50506f8e1ce3cb534
f2bc0488a298f136294c523bc5ab4086d090059b
1b4707187a3a85126338303dc766280b8fb2dc56
64e4285ec38569f66d31e589a4610cefd16d8076
31 changes: 18 additions & 13 deletions include/bout/interpolation_xz.hxx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
/**************************************************************************
* Copyright 2010-2020 B.D.Dudson, S.Farley, P. Hill, J.T. Omotani, J.T. Parker,
* M.V.Umansky, X.Q.Xu
* Copyright 2010 - 2026 BOUT++ contributors
*
* Contact: Ben Dudson, bd512@york.ac.uk
* Contact: Ben Dudson, dudson2@llnl.gov
*
* This file is part of BOUT++.
*
Expand Down Expand Up @@ -33,9 +32,11 @@
#include "bout/petsclib.hxx"
#endif

namespace {
namespace bout {
namespace details {
enum class implementation_type { new_weights, petsc, legacy };
}
} // namespace bout

class Options;
class GlobalField3DAccess;
Expand Down Expand Up @@ -144,7 +145,7 @@ public:
/// 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>
template <bool monotonic, bout::details::implementation_type imp_type>
class XZHermiteSplineBase : public XZInterpolation {
protected:
/// This is protected rather than private so that it can be
Expand Down Expand Up @@ -224,19 +225,23 @@ public:
};

using XZMonotonicHermiteSplineSerial =
XZHermiteSplineBase<true, implementation_type::new_weights>;
XZHermiteSplineBase<true, bout::details::implementation_type::new_weights>;
using XZHermiteSplineSerial =
XZHermiteSplineBase<false, implementation_type::new_weights>;
XZHermiteSplineBase<false, bout::details::implementation_type::new_weights>;
using XZMonotonicHermiteSplineLegacy =
XZHermiteSplineBase<true, implementation_type::legacy>;
using XZHermiteSplineLegacy = XZHermiteSplineBase<false, implementation_type::legacy>;
XZHermiteSplineBase<true, bout::details::implementation_type::legacy>;
using XZHermiteSplineLegacy =
XZHermiteSplineBase<false, bout::details::implementation_type::legacy>;
#if BOUT_HAS_PETSC
using XZMonotonicHermiteSpline = XZHermiteSplineBase<true, implementation_type::petsc>;
using XZHermiteSpline = XZHermiteSplineBase<false, implementation_type::petsc>;
using XZMonotonicHermiteSpline =
XZHermiteSplineBase<true, bout::details::implementation_type::petsc>;
using XZHermiteSpline =
XZHermiteSplineBase<false, bout::details::implementation_type::petsc>;
#else
using XZMonotonicHermiteSpline =
XZHermiteSplineBase<true, implementation_type::new_weights>;
using XZHermiteSpline = XZHermiteSplineBase<false, implementation_type::new_weights>;
XZHermiteSplineBase<true, bout::details::implementation_type::new_weights>;
using XZHermiteSpline =
XZHermiteSplineBase<false, bout::details::implementation_type::new_weights>;
#endif

/// XZLagrange4pt interpolation class
Expand Down
55 changes: 28 additions & 27 deletions src/mesh/interpolation/hermite_spline_xz.cxx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**************************************************************************
* Copyright 2015-2018 B.D.Dudson, P. Hill
* Copyright 2015 - 2026 BOUT++ contributors
*
* Contact: Ben Dudson, bd512@york.ac.uk
* Contact: Ben Dudson, dudson2@llnl.gov
*
* This file is part of BOUT++.
*
Expand Down Expand Up @@ -109,7 +109,7 @@ class IndConverter {
}
};

template <bool monotonic, implementation_type imp_type>
template <bool monotonic, bout::details::implementation_type imp_type>
XZHermiteSplineBase<monotonic, imp_type>::XZHermiteSplineBase(int y_offset, Mesh* meshin,
Options* options)
: XZInterpolation(y_offset, meshin), h00_x(localmesh), h01_x(localmesh),
Expand Down Expand Up @@ -142,15 +142,15 @@ XZHermiteSplineBase<monotonic, imp_type>::XZHermiteSplineBase(int y_offset, Mesh
h10_z.allocate();
h11_z.allocate();

if constexpr (imp_type == implementation_type::new_weights
|| imp_type == implementation_type::petsc) {
if constexpr (imp_type == bout::details::implementation_type::new_weights
|| imp_type == bout::details::implementation_type::petsc) {
newWeights.reserve(16);
for (int w = 0; w < 16; ++w) {
newWeights.emplace_back(localmesh);
newWeights[w].allocate();
}
}
if constexpr (imp_type == implementation_type::petsc) {
if constexpr (imp_type == bout::details::implementation_type::petsc) {
#if BOUT_HAS_PETSC
petsclib = new PetscLib(
&Options::root()["mesh:paralleltransform:xzinterpolation:hermitespline"]);
Expand All @@ -163,15 +163,15 @@ XZHermiteSplineBase<monotonic, imp_type>::XZHermiteSplineBase(int y_offset, Mesh
gf3daccess = std::make_unique<GlobalField3DAccess>(localmesh);
g3dinds.reallocate(localmesh->LocalNx, localmesh->LocalNy, localmesh->LocalNz);
}
if constexpr (imp_type == implementation_type::new_weights
|| imp_type == implementation_type::legacy) {
if constexpr (imp_type == bout::details::implementation_type::new_weights
|| imp_type == bout::details::implementation_type::legacy) {
if (localmesh->getNXPE() > 1) {
throw BoutException("Require PETSc for MPI splitting in X");
}
}
}

template <bool monotonic, implementation_type imp_type>
template <bool monotonic, bout::details::implementation_type imp_type>
void XZHermiteSplineBase<monotonic, imp_type>::calcWeights(
const Field3D& delta_x, const Field3D& delta_z,
[[maybe_unused]] const std::string& region) {
Expand Down Expand Up @@ -251,8 +251,8 @@ void XZHermiteSplineBase<monotonic, imp_type>::calcWeights(
h11_x[i] = (t_x * t_x * t_x) - (t_x * t_x);
h11_z[i] = (t_z * t_z * t_z) - (t_z * t_z);

if constexpr (imp_type == implementation_type::new_weights
|| imp_type == implementation_type::petsc) {
if constexpr (imp_type == bout::details::implementation_type::new_weights
|| imp_type == bout::details::implementation_type::petsc) {
for (int w = 0; w < 16; ++w) {
newWeights[w][i] = 0;
}
Expand Down Expand Up @@ -309,7 +309,7 @@ void XZHermiteSplineBase<monotonic, imp_type>::calcWeights(
newWeights[13][i] -= h11_x[i] * h11_z[i] / 4;
newWeights[7][i] -= h11_x[i] * h11_z[i] / 4;
newWeights[5][i] += h11_x[i] * h11_z[i] / 4;
if (imp_type == implementation_type::petsc) {
if (imp_type == bout::details::implementation_type::petsc) {
#if BOUT_HAS_PETSC
PetscInt idxn[1] = {conv.fromLocalToGlobal(x, y + y_offset, z)};
// output.write("debug: {:d} -> {:d}: {:d}:{:d} -> {:d}:{:d}\n",
Expand Down Expand Up @@ -340,7 +340,7 @@ void XZHermiteSplineBase<monotonic, imp_type>::calcWeights(
g3dinds[i] = {gind.ind, gind.xp(1).ind, gind.zp(1).ind, gind.xp(1).zp(1).ind};
}
}
if constexpr (imp_type == implementation_type::petsc) {
if constexpr (imp_type == bout::details::implementation_type::petsc) {
#if BOUT_HAS_PETSC
MatAssemblyBegin(petscWeights, MAT_FINAL_ASSEMBLY);
MatAssemblyEnd(petscWeights, MAT_FINAL_ASSEMBLY);
Expand All @@ -352,7 +352,7 @@ void XZHermiteSplineBase<monotonic, imp_type>::calcWeights(
}
}

template <bool monotonic, implementation_type imp_type>
template <bool monotonic, bout::details::implementation_type imp_type>
void XZHermiteSplineBase<monotonic, imp_type>::calcWeights(const Field3D& delta_x,
const Field3D& delta_z,
const BoutMask& mask,
Expand All @@ -377,7 +377,7 @@ void XZHermiteSplineBase<monotonic, imp_type>::calcWeights(const Field3D& delta_
* (i, j+1, k+1) h01_z + h10_z / 2
* (i, j+1, k+2) h11_z / 2
*/
template <bool monotonic, implementation_type imp_type>
template <bool monotonic, bout::details::implementation_type imp_type>
std::vector<ParallelTransform::PositionsAndWeights>
XZHermiteSplineBase<monotonic, imp_type>::getWeightsForYApproximation(int i, int j, int k,
int yoffset) {
Expand All @@ -397,7 +397,7 @@ XZHermiteSplineBase<monotonic, imp_type>::getWeightsForYApproximation(int i, int
{i, j + yoffset, k_mod_p2, 0.5 * h11_z(i, j, k)}};
}

template <bool monotonic, implementation_type imp_type>
template <bool monotonic, bout::details::implementation_type imp_type>
Field3D XZHermiteSplineBase<monotonic, imp_type>::interpolate(
const Field3D& f, [[maybe_unused]] const std::string& region) const {

Expand All @@ -411,7 +411,7 @@ Field3D XZHermiteSplineBase<monotonic, imp_type>::interpolate(
gf = gf3daccess->communicate_asPtr(f);
}

if constexpr (imp_type == implementation_type::petsc) {
if constexpr (imp_type == bout::details::implementation_type::petsc) {
#if BOUT_HAS_PETSC
BoutReal* ptr = nullptr;
const BoutReal* cptr = nullptr;
Expand Down Expand Up @@ -439,7 +439,7 @@ Field3D XZHermiteSplineBase<monotonic, imp_type>::interpolate(
#endif
}

if constexpr (imp_type == implementation_type::new_weights) {
if constexpr (imp_type == bout::details::implementation_type::new_weights) {
BOUT_FOR(i, getRegion(region)) {
auto ic = i_corner[i];
auto iyp = i.yp(y_offset);
Expand All @@ -463,7 +463,7 @@ Field3D XZHermiteSplineBase<monotonic, imp_type>::interpolate(
ASSERT2(std::isfinite(f_interp[iyp]));
}
}
if constexpr (imp_type == implementation_type::legacy) {
if constexpr (imp_type == bout::details::implementation_type::legacy) {
// Legacy interpolation
// TODO(peter): Should we apply dirichlet BCs to derivatives?
// Derivatives are used for tension and need to be on dimensionless
Expand Down Expand Up @@ -523,7 +523,7 @@ Field3D XZHermiteSplineBase<monotonic, imp_type>::interpolate(
return f_interp;
}

template <bool monotonic, implementation_type imp_type>
template <bool monotonic, bout::details::implementation_type imp_type>
Field3D XZHermiteSplineBase<monotonic, imp_type>::interpolate(const Field3D& f,
const Field3D& delta_x,
const Field3D& delta_z,
Expand All @@ -532,7 +532,7 @@ Field3D XZHermiteSplineBase<monotonic, imp_type>::interpolate(const Field3D& f,
return interpolate(f, region);
}

template <bool monotonic, implementation_type imp_type>
template <bool monotonic, bout::details::implementation_type imp_type>
Field3D XZHermiteSplineBase<monotonic, imp_type>::interpolate(const Field3D& f,
const Field3D& delta_x,
const Field3D& delta_z,
Expand All @@ -543,11 +543,12 @@ Field3D XZHermiteSplineBase<monotonic, imp_type>::interpolate(const Field3D& f,
}

// ensure they are instantiated
template class XZHermiteSplineBase<true, implementation_type::new_weights>;
template class XZHermiteSplineBase<false, implementation_type::new_weights>;
template class XZHermiteSplineBase<true, implementation_type::legacy>;
template class XZHermiteSplineBase<false, implementation_type::legacy>;
template class XZHermiteSplineBase<true, bout::details::implementation_type::new_weights>;
template class XZHermiteSplineBase<false,
bout::details::implementation_type::new_weights>;
template class XZHermiteSplineBase<true, bout::details::implementation_type::legacy>;
template class XZHermiteSplineBase<false, bout::details::implementation_type::legacy>;
#if BOUT_HAS_PETSC
template class XZHermiteSplineBase<true, implementation_type::petsc>;
template class XZHermiteSplineBase<false, implementation_type::petsc>;
template class XZHermiteSplineBase<true, bout::details::implementation_type::petsc>;
template class XZHermiteSplineBase<false, bout::details::implementation_type::petsc>;
#endif