grid.h (Latest change: Author:Lakshman Anumolu <acrlakshman@yahoo.co.in>, 2019-07-26 23:58:51 -0500, [commit: 5e5cd8b])

Go to the documentation of this file.

// Copyright 2019 Lakshman Anumolu, Raunak Bardia.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright notice,
// this list of conditions and the following disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice,
// this list of conditions and the following disclaimer in the documentation
// and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors
// may be used to endorse or promote products derived from this software without
// specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

#pragma once

#include <string>
#include <vector>

#include "gals/input-fields/grid.h"
#include "gals/utilities/utilities.h"
#include "mat3.h"
#include "vec3.h"

namespace GALS
{
namespace CPU
{
constexpr int num_mixed_derivatives(const int dim)
{
  switch (dim) {
    case 1:
      return 0;
      break;
    case 2:
      return 1;
      break;
    case 3:
      return 4;
      break;
    default:
      return -1;
  }
}

template <typename T, int DIM = 3>
class Grid
{
 public:
  using value_type = T;
  using position_type = Vec3<T>;

  static constexpr int dim = DIM;

  static const Mat3<int> axis_vectors;
  static const Mat3<T> identity_mat;

  static constexpr int num_mixed_derivatives = GALS::CPU::num_mixed_derivatives(DIM);

  Grid(int nx, int ny, int nz);

  Grid(int nx, int ny);

  Grid(int nx);

  ~Grid();

  Vec3<T>& x(const int i, const int j = 0, const int k = 0);

  const int dimension() const;

  const int size() const;

  const int* getMask() const;

  const Vec3<int> numCells() const;

  const size_t totalCells() const;

  const int getPadding() const;

  const std::size_t index(const int i, const int j, const int k) const;

  const std::size_t index(const Vec3<int> node_id) const;

  const Vec3<int> baseNodeId(const Vec3<T>& x) const;

  const Vec3<T>& dX() const;

  const Vec3<T>& oneOverDX() const;

  const Vec3<T>& operator()(const int i, const int j, const int k) const;

  const Vec3<T>& operator()(const Vec3<int> node_id) const;

  void setPadding(const int pad);

  void generate(T x_min, T x_max, T y_min, T y_max, T z_min, T z_max);

 private:
  int m_dimension, m_nx, m_ny, m_nz, m_pad;
  size_t m_total_cells;
  int m_mask[3];
  Vec3<T> m_box_min, m_box_max;
  Vec3<T> m_dx, m_one_over_dx;
  std::vector<Vec3<T>> m_grid;
};

template <typename T, int DIM>
const Mat3<int> Grid<T, DIM>::axis_vectors = Mat3<int>(1, 0, 0, 0, 1, 0, 0, 0, 1);

template <typename T, int DIM>
const Mat3<T> Grid<T, DIM>::identity_mat = Mat3<T>(1, 0, 0, 0, 1, 0, 0, 0, 1);

}  // namespace CPU
}  // namespace GALS