point.h

Go to the documentation of this file.

// ------------------------------------------------------------------------
//
// SPDX-License-Identifier: LGPL-2.1-or-later
// Copyright (C) 1998 - 2024 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Part of the source code is dual licensed under Apache-2.0 WITH
// LLVM-exception OR LGPL-2.1-or-later. Detailed license information
// governing the source code and code contributions can be found in
// LICENSE.md and CONTRIBUTING.md at the top level directory of deal.II.
//
// ------------------------------------------------------------------------
 
#ifndef dealii_point_h
#define dealii_point_h
 
 
#include <deal.II/base/config.h>
 
#include <deal.II/base/exceptions.h>
#include <deal.II/base/tensor.h>
 
#include <boost/geometry/core/cs.hpp>
#include <boost/geometry/geometries/point.hpp>
 
#include <cmath>
 
DEAL_II_NAMESPACE_OPEN
 
template <int dim, typename Number = double>
DEAL_II_CXX20_REQUIRES(dim >= 0)
class Point : public Tensor<1, dim, Number>
{
public:
  constexpr DEAL_II_HOST_DEVICE
  Point();
 
  constexpr explicit DEAL_II_HOST_DEVICE
  Point(const Tensor<1, dim, Number> &);
 
  constexpr explicit DEAL_II_HOST_DEVICE
  Point(const Number x);
 
  constexpr DEAL_II_HOST_DEVICE
  Point(const Number x, const Number y);
 
  constexpr DEAL_II_HOST_DEVICE
  Point(const Number x, const Number y, const Number z);
 
  template <std::size_t dummy_dim,
            std::enable_if_t<(dim == dummy_dim) && (dummy_dim != 0), int> = 0>
  constexpr Point(
    const boost::geometry::model::
      point<Number, dummy_dim, boost::geometry::cs::cartesian> &boost_pt);
 
  static constexpr DEAL_II_HOST_DEVICE Point<dim, Number>
                                       unit_vector(const unsigned int i);
 
  constexpr DEAL_II_HOST_DEVICE Number
  operator()(const unsigned int index) const;
 
  constexpr DEAL_II_HOST_DEVICE Number &
  operator()(const unsigned int index);
 
  template <typename OtherNumber>
  constexpr Point<dim, Number> &
  operator=(const Tensor<1, dim, OtherNumber> &p);
 
  constexpr DEAL_II_HOST_DEVICE Point<dim, Number>
                                operator+(const Tensor<1, dim, Number> &) const;
 
  constexpr DEAL_II_HOST_DEVICE Tensor<1, dim, Number>
                                operator-(const Point<dim, Number> &) const;
 
  constexpr DEAL_II_HOST_DEVICE Point<dim, Number>
                                operator-(const Tensor<1, dim, Number> &) const;
 
  constexpr DEAL_II_HOST_DEVICE Point<dim, Number>
                                operator-() const;
 
  template <typename OtherNumber>
  constexpr DEAL_II_HOST_DEVICE Point<
    dim,
    typename ProductType<Number,
                         typename EnableIfScalar<OtherNumber>::type>::type>
  operator*(const OtherNumber) const;
 
  template <typename OtherNumber>
  constexpr DEAL_II_HOST_DEVICE Point<
    dim,
    typename ProductType<Number,
                         typename EnableIfScalar<OtherNumber>::type>::type>
  operator/(const OtherNumber) const;
 
  constexpr DEAL_II_HOST_DEVICE Number
  operator*(const Tensor<1, dim, Number> &p) const;
 
  constexpr DEAL_II_HOST_DEVICE
    typename numbers::NumberTraits<Number>::real_type
    square() const;
 
  DEAL_II_HOST_DEVICE typename numbers::NumberTraits<Number>::real_type
  distance(const Point<dim, Number> &p) const;
 
  constexpr DEAL_II_HOST_DEVICE
    typename numbers::NumberTraits<Number>::real_type
    distance_square(const Point<dim, Number> &p) const;
 
  template <class Archive>
  void
  serialize(Archive &ar, const unsigned int version);
};
 
/*--------------------------- Inline functions: Point -----------------------*/
 
#ifndef DOXYGEN
 
// At least clang-3.7 requires us to have a user-defined constructor
// and we can't use 'Point<dim,Number>::Point () = default' here.
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE Point<dim, Number>::Point() // NOLINT
{}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE Point<dim, Number>::Point(
  const Tensor<1, dim, Number> &t)
  : Tensor<1, dim, Number>(t)
{}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE Point<dim, Number>::Point(const Number x)
{
  Assert(dim == 1,
         ExcMessage(
           "You can only initialize Point<1> objects using the constructor "
           "that takes only one argument. Point<dim> objects with dim!=1 "
           "require initialization with the constructor that takes 'dim' "
           "arguments."));
 
  // we can only get here if we pass the assertion. use the switch anyway so
  // as to avoid compiler warnings about uninitialized elements or writing
  // beyond the end of the 'values' array
  switch (dim)
    {
      case 1:
        this->values[0] = x;
        break;
 
      default:;
    }
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE Point<dim, Number>::Point(const Number x,
                                                        const Number y)
{
  Assert(dim == 2,
         ExcMessage(
           "You can only initialize Point<2> objects using the constructor "
           "that takes two arguments. Point<dim> objects with dim!=2 "
           "require initialization with the constructor that takes 'dim' "
           "arguments."));
 
  // we can only get here if we pass the assertion. use the indirection anyway
  // so as to avoid compiler warnings about uninitialized elements or writing
  // beyond the end of the 'values' array
  constexpr unsigned int y_index = (dim < 2) ? 0 : 1;
  this->values[0]                = x;
  this->values[y_index]          = y;
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE Point<dim, Number>::Point(const Number x,
                                                        const Number y,
                                                        const Number z)
{
  Assert(dim == 3,
         ExcMessage(
           "You can only initialize Point<3> objects using the constructor "
           "that takes three arguments. Point<dim> objects with dim!=3 "
           "require initialization with the constructor that takes 'dim' "
           "arguments."));
 
  // we can only get here if we pass the assertion. use the indirection anyway
  // so as to avoid compiler warnings about uninitialized elements or writing
  // beyond the end of the 'values' array
  constexpr unsigned int y_index = (dim < 2) ? 0 : 1;
  constexpr unsigned int z_index = (dim < 3) ? 0 : 2;
  this->values[0]                = x;
  this->values[y_index]          = y;
  this->values[z_index]          = z;
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
template <std::size_t dummy_dim,
          std::enable_if_t<(dim == dummy_dim) && (dummy_dim != 0), int>>
constexpr Point<dim, Number>::Point(
  const boost::geometry::model::
    point<Number, dummy_dim, boost::geometry::cs::cartesian> &boost_pt)
{
  Assert(dim <= 3, ExcNotImplemented());
  this->values[0]                = boost::geometry::get<0>(boost_pt);
  constexpr unsigned int y_index = (dim < 2) ? 0 : 1;
  constexpr unsigned int z_index = (dim < 3) ? 0 : 2;
 
  if (dim >= 2)
    this->values[y_index] = boost::geometry::get<y_index>(boost_pt);
 
  if (dim >= 3)
    this->values[z_index] = boost::geometry::get<z_index>(boost_pt);
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE
  Point<dim, Number> Point<dim, Number>::unit_vector(unsigned int i)
{
  Point<dim, Number> p;
  p[i] = 1.;
  return p;
}
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE Number Point<dim, Number>::operator()(
  const unsigned int index) const
{
  AssertIndexRange(static_cast<int>(index), dim);
  return this->values[index];
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE Number &Point<dim, Number>::operator()(
  const unsigned int index)
{
  AssertIndexRange(static_cast<int>(index), dim);
  return this->values[index];
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
template <typename OtherNumber>
constexpr DEAL_II_ALWAYS_INLINE Point<dim, Number>
  &Point<dim, Number>::operator=(const Tensor<1, dim, OtherNumber> &p)
{
  Tensor<1, dim, Number>::operator=(p);
  return *this;
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE Point<dim, Number> Point<dim, Number>::operator+(
  const Tensor<1, dim, Number> &p) const
{
  Point<dim, Number> tmp = *this;
  tmp += p;
  return tmp;
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE
  Tensor<1, dim, Number> Point<dim, Number>::operator-(
    const Point<dim, Number> &p) const
{
  return (Tensor<1, dim, Number>(*this) -= p);
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE Point<dim, Number> Point<dim, Number>::operator-(
  const Tensor<1, dim, Number> &p) const
{
  Point<dim, Number> tmp = *this;
  tmp -= p;
  return tmp;
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE Point<dim, Number> Point<dim, Number>::operator-()
  const
{
  Point<dim, Number> result;
  for (unsigned int i = 0; i < dim; ++i)
    result.values[i] = -this->values[i];
  return result;
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
template <typename OtherNumber>
constexpr DEAL_II_HOST_DEVICE Point<
  dim,
  typename ProductType<Number, typename EnableIfScalar<OtherNumber>::type>::
    type> Point<dim, Number>::operator*(const OtherNumber factor) const
{
  Point<dim, typename ProductType<Number, OtherNumber>::type> tmp;
  for (unsigned int i = 0; i < dim; ++i)
    tmp[i] = this->operator[](i) * factor;
  return tmp;
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
template <typename OtherNumber>
constexpr DEAL_II_HOST_DEVICE Point<
  dim,
  typename ProductType<Number, typename EnableIfScalar<OtherNumber>::type>::
    type> Point<dim, Number>::operator/(const OtherNumber factor) const
{
  const Tensor<1, dim, Number> &base_object = *this;
  return Point<
    dim,
    typename ProductType<Number,
                         typename EnableIfScalar<OtherNumber>::type>::type>(
    ::operator/(base_object, factor));
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE Number Point<dim, Number>::operator*(
  const Tensor<1, dim, Number> &p) const
{
  Number res = Number();
  for (unsigned int i = 0; i < dim; ++i)
    res += this->operator[](i) * p[i];
  return res;
}
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE typename numbers::NumberTraits<Number>::real_type
  Point<dim, Number>::square() const
{
  return this->norm_square();
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
inline DEAL_II_HOST_DEVICE typename numbers::NumberTraits<Number>::real_type
  Point<dim, Number>::distance(const Point<dim, Number> &p) const
{
  return std::sqrt(distance_square(p));
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
constexpr DEAL_II_HOST_DEVICE typename numbers::NumberTraits<Number>::real_type
  Point<dim, Number>::distance_square(const Point<dim, Number> &p) const
{
  Number sum = internal::NumberType<Number>::value(0.0);
  for (unsigned int i = 0; i < dim; ++i)
    {
      const Number diff = static_cast<Number>(this->values[i]) - p[i];
      sum += numbers::NumberTraits<Number>::abs_square(diff);
    }
 
  return sum;
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
template <class Archive>
inline void Point<dim, Number>::serialize(Archive &ar, const unsigned int)
{
  // forward to serialization
  // function in the base class
  ar &static_cast<Tensor<1, dim, Number> &>(*this);
}
 
#endif // DOXYGEN
 
 
/*--------------------------- Global functions: Point -----------------------*/
 
 
template <int dim, typename Number, typename OtherNumber>
constexpr DEAL_II_HOST_DEVICE
  Point<dim,
        typename ProductType<Number,
                             typename EnableIfScalar<OtherNumber>::type>::type>
  operator*(const OtherNumber factor, const Point<dim, Number> &p)
{
  return p * factor;
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
inline std::ostream &
operator<<(std::ostream &out, const Point<dim, Number> &p)
{
  for (unsigned int i = 0; i < dim - 1; ++i)
    out << p[i] << ' ';
  out << p[dim - 1];
 
  return out;
}
 
 
 
template <int dim, typename Number>
DEAL_II_CXX20_REQUIRES(dim >= 0)
inline std::istream &
operator>>(std::istream &in, Point<dim, Number> &p)
{
  for (unsigned int i = 0; i < dim; ++i)
    in >> p[i];
 
  return in;
}
 
 
#ifndef DOXYGEN
 
template <typename Number>
inline std::ostream &
operator<<(std::ostream &out, const Point<1, Number> &p)
{
  out << p[0];
 
  return out;
}
 
#endif // DOXYGEN
DEAL_II_NAMESPACE_CLOSE
 
#endif