lsOxidationSolverBase.hpp

Go to the documentation of this file.

#pragma once
 
#include <lsDomain.hpp>
 
#include <hrleSparseIterator.hpp>
 
#include <algorithm>
#include <array>
#include <cmath>
#include <cstddef>
#include <functional>
#include <limits>
#include <string>
#include <vector>
 
namespace viennals {
 
using namespace viennacore;
 
namespace detail {

template <class T> inline T clampLevelSetPhi(T v) {
  return v > T(1) ? T(1) : (v < T(-1) ? T(-1) : v);
}
 
template <class T>
inline T levelSetCrossingDistance(T insidePhi, T outsidePhi,
                                  T minBoundaryFraction, T gridDelta) {
  const T denom = std::abs(insidePhi) + std::abs(outsidePhi);
  if (denom <= std::numeric_limits<T>::epsilon())
    return gridDelta;
  return std::max(minBoundaryFraction * gridDelta,
                  gridDelta * std::abs(insidePhi) / denom);
}
 
} // namespace detail

template <class T, int D> class OxidationSolverBase {
protected:
  using IndexType = viennahrle::Index<D>;
  using ConstSparseIterator =
      viennahrle::ConstSparseIterator<typename Domain<T, D>::DomainType>;
 
  static constexpr std::size_t noNode = std::numeric_limits<std::size_t>::max();
  std::vector<std::size_t> nodeLookupFlat;
  IndexType minIndex{};
  IndexType maxIndex{};
  std::array<std::size_t, D> extents{};
  std::array<std::size_t, D> strides{};
  T gridDelta = 1.;
 
  struct GridBounds {
    IndexType min{};
    IndexType max{};
    bool foundDefinedPoints = false;
  };
 
  bool crosses(T a, T b) const {
    // Use a small tolerance consistent with isInsideOxide so that grid points
    // that land exactly on an interface (phi ≈ 0 from floating-point rounding
    // in GeometricAdvect) are treated as surface points in boundary detection.
    constexpr T eps = T(1e-9);
    return (a <= eps && b >= -eps) || (a >= -eps && b <= eps);
  }
 
  T valueAt(ConstSparseIterator &it, const IndexType &index) const {
    it.goToIndices(index);
    return it.getValue();
  }
 
  bool inBounds(const IndexType &index) const {
    for (unsigned i = 0; i < D; ++i)
      if (index[i] < minIndex[i] || index[i] > maxIndex[i])
        return false;
    return true;
  }
 
  void initNodeLookup() {
    std::size_t total = 1;
    for (unsigned i = 0; i < D; ++i)
      total *= extents[i];
    nodeLookupFlat.assign(total, noNode);
  }
 
  std::size_t lookupNode(const IndexType &index) const {
    if (!inBounds(index))
      return noNode;
    return nodeLookupFlat[linearIndex(index)];
  }
 
  std::size_t linearIndex(const IndexType &index) const {
    if (!inBounds(index))
      return std::numeric_limits<std::size_t>::max();
    std::size_t result = 0;
    for (unsigned i = 0; i < D; ++i)
      result += static_cast<std::size_t>(index[i] - minIndex[i]) * strides[i];
    return result;
  }
 
  bool increment(IndexType &index) const {
    for (unsigned i = 0; i < D; ++i) {
      if (index[i] < maxIndex[i]) {
        ++index[i];
        return true;
      }
      index[i] = minIndex[i];
    }
    return false;
  }
 
  // Searches with expanding radius shells so that RK2 Stage 2 can find oxide
  // nodes even after the surface has advanced several grid cells beyond the
  // band.
  std::size_t findNearbyNode(const IndexType &index) const {
    for (int radius = 1; radius <= 4; ++radius) {
      T bestDistance2 = std::numeric_limits<T>::max();
      std::size_t bestNode = std::numeric_limits<std::size_t>::max();
 
      IndexType offset{};
      offset.fill(-radius);
      while (true) {
        IndexType candidate = index;
        T distance2 = 0.;
        for (unsigned i = 0; i < D; ++i) {
          candidate[i] += offset[i];
          distance2 += static_cast<T>(offset[i] * offset[i]);
        }
 
        if (distance2 > 0 && inBounds(candidate)) {
          const std::size_t foundId = nodeLookupFlat[linearIndex(candidate)];
          if (foundId != noNode && distance2 < bestDistance2) {
            bestDistance2 = distance2;
            bestNode = foundId;
          }
        }
 
        unsigned dim = 0;
        for (; dim < D; ++dim) {
          if (offset[dim] < radius) {
            ++offset[dim];
            break;
          }
          offset[dim] = -radius;
        }
        if (dim == D)
          break;
      }
 
      if (bestNode != std::numeric_limits<std::size_t>::max())
        return bestNode;
    }
    return std::numeric_limits<std::size_t>::max();
  }
 
  bool initializeGridFromInterfaces(
      SmartPointer<Domain<T, D>> reactionInterface,
      SmartPointer<Domain<T, D>> ambientInterface,
      SmartPointer<Domain<T, D>> maskInterface, bool useRequestedBounds,
      const IndexType &requestedMinIndex, const IndexType &requestedMaxIndex,
      std::size_t maxGridPoints, const std::string &solverName) {
    auto &reactionGrid = reactionInterface->getGrid();
    auto &ambientGrid = ambientInterface->getGrid();
    gridDelta = reactionGrid.getGridDelta();
 
    if (std::abs(gridDelta - ambientGrid.getGridDelta()) >
            std::numeric_limits<T>::epsilon() ||
        (maskInterface != nullptr &&
         std::abs(gridDelta - maskInterface->getGrid().getGridDelta()) >
             std::numeric_limits<T>::epsilon())) {
      Logger::getInstance()
          .addError(solverName + ": Interface grid deltas must match.")
          .print();
      return false;
    }
 
    IndexType gridMin = reactionGrid.getMinGridPoint();
    IndexType gridMax = reactionGrid.getMaxGridPoint();
    for (unsigned i = 0; i < D; ++i) {
      gridMin[i] = std::max(gridMin[i], ambientGrid.getMinGridPoint(i));
      gridMax[i] = std::min(gridMax[i], ambientGrid.getMaxGridPoint(i));
      if (maskInterface != nullptr) {
        gridMin[i] =
            std::max(gridMin[i], maskInterface->getGrid().getMinGridPoint(i));
        gridMax[i] =
            std::min(gridMax[i], maskInterface->getGrid().getMaxGridPoint(i));
      }
    }
 
    auto bounds = definedPointBounds(reactionInterface);
    mergeDefinedPointBounds(bounds, ambientInterface);
    if (maskInterface != nullptr)
      mergeDefinedPointBounds(bounds, maskInterface);
 
    minIndex = bounds.foundDefinedPoints ? bounds.min : gridMin;
    maxIndex = bounds.foundDefinedPoints ? bounds.max : gridMax;
    applyBoundsPaddingAndClamp(minIndex, maxIndex, gridMin, gridMax);
 
    std::size_t numGridPoints = 1;
    for (unsigned i = 0; i < D; ++i) {
      if (useRequestedBounds) {
        minIndex[i] = std::max(minIndex[i], requestedMinIndex[i]);
        maxIndex[i] = std::min(maxIndex[i], requestedMaxIndex[i]);
      }
      if (maxIndex[i] < minIndex[i]) {
        Logger::getInstance()
            .addError(solverName + ": Cartesian solve region is empty.")
            .print();
        return false;
      }
      extents[i] = static_cast<std::size_t>(maxIndex[i] - minIndex[i] + 1);
      numGridPoints *= extents[i];
      strides[i] = (i == 0) ? 1 : strides[i - 1] * extents[i - 1];
    }
 
    if (numGridPoints > maxGridPoints) {
      Logger::getInstance()
          .addError(solverName +
                    ": Cartesian solve region exceeds maxGridPoints.")
          .print();
      return false;
    }
    return true;
  }
 
  bool initializeGridFromMask(SmartPointer<Domain<T, D>> maskInterface,
                              bool useRequestedBounds,
                              const IndexType &requestedMinIndex,
                              const IndexType &requestedMaxIndex,
                              std::size_t maxGridPoints,
                              const std::string &solverName) {
    auto &grid = maskInterface->getGrid();
    gridDelta = grid.getGridDelta();
 
    auto bounds = definedPointBounds(maskInterface);
    minIndex = bounds.foundDefinedPoints ? bounds.min : grid.getMinGridPoint();
    maxIndex = bounds.foundDefinedPoints ? bounds.max : grid.getMaxGridPoint();
    applyBoundsPaddingAndClamp(minIndex, maxIndex, grid.getMinGridPoint(),
                               grid.getMaxGridPoint());
 
    std::size_t numGridPoints = 1;
    for (unsigned i = 0; i < D; ++i) {
      if (useRequestedBounds) {
        minIndex[i] = std::max(minIndex[i], requestedMinIndex[i]);
        maxIndex[i] = std::min(maxIndex[i], requestedMaxIndex[i]);
      }
      if (maxIndex[i] < minIndex[i]) {
        Logger::getInstance()
            .addError(solverName + ": Cartesian solve region is empty.")
            .print();
        return false;
      }
      extents[i] = static_cast<std::size_t>(maxIndex[i] - minIndex[i] + 1);
      numGridPoints *= extents[i];
      strides[i] = (i == 0) ? 1 : strides[i - 1] * extents[i - 1];
    }
 
    if (numGridPoints > maxGridPoints) {
      Logger::getInstance()
          .addError(solverName +
                    ": Cartesian solve region exceeds maxGridPoints.")
          .print();
      return false;
    }
    return true;
  }
 
private:
  GridBounds definedPointBounds(SmartPointer<Domain<T, D>> levelSet) const {
    GridBounds bounds;
    ConstSparseIterator it(levelSet->getDomain());
    for (; !it.isFinished(); ++it) {
      if (!it.isDefined())
        continue;
 
      const auto &index = it.getStartIndices();
      if (!bounds.foundDefinedPoints) {
        bounds.min = index;
        bounds.max = index;
        bounds.foundDefinedPoints = true;
      } else {
        for (unsigned i = 0; i < D; ++i) {
          bounds.min[i] = std::min(bounds.min[i], index[i]);
          bounds.max[i] = std::max(bounds.max[i], index[i]);
        }
      }
    }
    return bounds;
  }
 
  void mergeDefinedPointBounds(GridBounds &target,
                               SmartPointer<Domain<T, D>> levelSet) const {
    const auto source = definedPointBounds(levelSet);
    if (!source.foundDefinedPoints)
      return;
    if (!target.foundDefinedPoints) {
      target = source;
      return;
    }
    for (unsigned i = 0; i < D; ++i) {
      target.min[i] = std::min(target.min[i], source.min[i]);
      target.max[i] = std::max(target.max[i], source.max[i]);
    }
  }
 
  static void applyBoundsPaddingAndClamp(IndexType &minIndex,
                                         IndexType &maxIndex,
                                         const IndexType &gridMin,
                                         const IndexType &gridMax) {
    constexpr int padding = 4;
    for (unsigned i = 0; i < D; ++i) {
      // Clamp to the physical grid before adding/subtracting padding.
      // lsInterior on an INFINITE_BOUNDARY level-set can leave far-field
      // sentinel entries (near std::numeric_limits<IndexType>::min/max) in
      // the HRLE structure.  definedPointBounds() visits them and records
      // the extreme index.  Subtracting padding from that sentinel directly
      // overflows, turning the tiny sentinel into a large positive value and
      // making extents[i] enormous.  Clamping first makes the arithmetic safe.
      minIndex[i] =
          std::max(gridMin[i], std::max(gridMin[i], minIndex[i]) - padding);
      maxIndex[i] =
          std::min(gridMax[i], std::min(gridMax[i], maxIndex[i]) + padding);
    }
  }
};
 
} // namespace viennals