stencils.hh

Go to the documentation of this file.

/* Copyright (C) 2015, 2016, 2021, 2023 PISM Authors
 *
 * This file is part of PISM.
 *
 * PISM is free software; you can redistribute it and/or modify it under the
 * terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3 of the License, or (at your option) any later
 * version.
 *
 * PISM is distributed in the hope that it will be useful, but WITHOUT ANY
 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License
 * along with PISM; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef PISM_STENCILS_HH
#define PISM_STENCILS_HH
 
namespace pism {
enum Direction {North = 0, East, South, West};
 
namespace stencils {
 
//! \brief Star stencil points (in the map-plane).
template <typename T>
struct Star {
  T c, e, w, n, s;
 
  Star() = default;
 
  Star(T value) {
    set(value);
  }
 
  void set(T input) {
    c = e = w = n = s = input;
  }
 
  //! Get the element corresponding to a given direction.
  //! Use foo.c to get the value at i,j (center of the star).
  inline T& operator[](Direction direction) {
    switch (direction) {
    default:                    // just to silence the warning
    case North:
      return n;
    case East:
      return e;
    case South:
      return s;
    case West:
      return w;
    }
  }
 
  inline const T& operator[](Direction direction) const {
    switch (direction) {
    default:                    // just to silence the warning
    case North:
      return n;
    case East:
      return e;
    case South:
      return s;
    case West:
      return w;
    }
  }
};
 
// NB: Do not change the order of elements in this struct. array::Array2D::box() depends
// on it.
template <typename T>
struct Box {
  T c, n, nw, w, sw, s, se, e, ne;
};
 
} // end of namespace stencils
 
} // end of namespace pism
 
#endif /* PISM_STENCILS_HH */