laplacian3.h

Go to the documentation of this file.

// ========================================================================= //
// This file is part of MyraMath, copyright (c) 2014-2019 by Ryan A Chilton  //
// and distributed by MyraCore, LLC. See LICENSE.txt for license terms.      //
// ========================================================================= //

#ifndef MYRAMATH_SPARSE_LAPLACIAN3_H
#define MYRAMATH_SPARSE_LAPLACIAN3_H

#include <myramath/MYRAMATH_EXPORT.h>
#include <myramath/utility/Number.h>

#include <utility>
#include <vector>

namespace myra {

// Forward declarations.
class Pattern;
class Permutation;
template<class Number> class SparseMatrix;

class MYRAMATH_EXPORT Natural3D
  {

  public:

    Natural3D(int in_I, int in_J, int in_K);

    std::vector<int> size() const;
    
    int operator () (int i, int j, int k) const;

    std::pair<Natural3D, Natural3D> i_split() const;

    std::pair<Natural3D, Natural3D> j_split() const;

    std::pair<Natural3D, Natural3D> k_split() const;
    
  private:

    // Full constructor used by splitting methods.
    Natural3D(int in_I, int in_i_begin, int in_i_end, int in_J, int in_j_begin, int in_j_end, int in_K, int in_k_begin, int in_k_end);

    // Private data - total size (I/J/K) and begin/end specification of subwindow.
    int I, i_begin, i_end;
    int J, j_begin, j_end;
    int K, k_begin, k_end;
  };

MYRAMATH_EXPORT Pattern stencil3(int I, int J, int K);

template<class Number> SparseMatrix<Number> laplacian3(int I, int J, int K);
template<> MYRAMATH_EXPORT SparseMatrix<NumberS> laplacian3<NumberS>(int I, int J, int K);
template<> MYRAMATH_EXPORT SparseMatrix<NumberD> laplacian3<NumberD>(int I, int J, int K);
template<> MYRAMATH_EXPORT SparseMatrix<NumberC> laplacian3<NumberC>(int I, int J, int K);
template<> MYRAMATH_EXPORT SparseMatrix<NumberZ> laplacian3<NumberZ>(int I, int J, int K);

MYRAMATH_EXPORT Permutation bisect3(int I, int J, int K);

MYRAMATH_EXPORT Pattern stencil3_unsymmetric(int I, int J, int K, double density = 0.5);

} // namespace

#endif