cart_grid_tp.hpp

Go to the documentation of this file.

// --------------------------------------------------------------------------
//
// Copyright (C) 2025-present by Pablo Antolin
//
// This file is part of the QUGaR library.
//
// SPDX-License-Identifier:    MIT
//
// --------------------------------------------------------------------------
 
#ifndef QUGAR_LIBRARY_CART_GRID_TP_HPP
#define QUGAR_LIBRARY_CART_GRID_TP_HPP
 
 
#include <qugar/bbox.hpp>
#include <qugar/point.hpp>
#include <qugar/tensor_index_tp.hpp>
#include <qugar/tolerance.hpp>
#include <qugar/types.hpp>
 
#include <array>
#include <cstddef>
#include <memory>
#include <optional>
#include <vector>
 
namespace qugar {
 
 
template<int dim> class CartGridTP
{
  using PointType = Point<dim>;
 
public:
 
 
  explicit CartGridTP(const std::array<std::vector<real>, dim> &breaks);
 
  CartGridTP(const BoundBox<dim> &domain, const std::array<std::size_t, dim> &n_intrvs_dir);
 
  explicit CartGridTP(const std::array<std::size_t, dim> &n_intrvs_dir);
 
 
 
  [[nodiscard]] const std::vector<real> &get_breaks(int dir) const;
 
  [[nodiscard]] const BoundBox<dim> &get_domain() const;
 
  [[nodiscard]] int get_cell_id(const PointType &point, const Tolerance &tolerance = Tolerance()) const;
 
  [[nodiscard]] std::optional<int> at_cells_boundary(const PointType &point,
    const Tolerance &tolerance = Tolerance()) const;
 
  [[nodiscard]] bool on_boundary(int cell_id, int local_facet_id) const;
 
  [[nodiscard]] std::vector<int> get_boundary_cells(int facet_id) const;
 
  [[nodiscard]] int to_flat(const TensorIndexTP<dim> &tid) const;
 
  [[nodiscard]] TensorIndexTP<dim> to_tensor(int fid) const;
 
  [[nodiscard]] TensorSizeTP<dim> get_num_cells_dir() const;
 
 
  [[nodiscard]] int get_num_cells() const;
 
  [[nodiscard]] BoundBox<dim> get_cell_domain(int cell_fid) const;
 
 
 
private:
 
 
  std::array<std::vector<real>, dim> breaks_;
  qugar::BoundBox<dim> domain_;
  TensorIndexRangeTP<dim> range_;
};
 
template<int dim> class SubCartGridTP
{
public:
  SubCartGridTP(const CartGridTP<dim> &grid,
    const TensorIndexTP<dim> &indices_start,
    const TensorIndexTP<dim> &indices_end);
 
  SubCartGridTP(const CartGridTP<dim> &grid, const TensorIndexRangeTP<dim> &indices_range);
 
  explicit SubCartGridTP(const CartGridTP<dim> &grid);
 
private:
  // NOLINTNEXTLINE (cppcoreguidelines-avoid-const-or-ref-data-members)
  const CartGridTP<dim> &grid_;
  TensorIndexRangeTP<dim> range_;
 
public:
  [[nodiscard]] TensorSizeTP<dim> get_num_cells_dir() const;
 
  [[nodiscard]] int to_flat(const TensorIndexTP<dim> &tid) const;
 
  [[nodiscard]] int get_num_cells() const;
 
  [[nodiscard]] bool is_unique_cell() const;
 
  [[nodiscard]] const TensorIndexRangeTP<dim> &get_range() const;
 
  [[nodiscard]] std::array<std::shared_ptr<const SubCartGridTP<dim>>, 2> split() const;
 
  [[nodiscard]] BoundBox<dim> get_domain() const;
 
  [[nodiscard]] const CartGridTP<dim> &get_grid() const;
 
  [[nodiscard]] int get_single_cell() const;
};
 
}// namespace qugar
 
#endif// QUGAR_LIBRARY_CART_GRID_TP_HPP