cell_polyhedron.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.

// This library 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
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_CELL_POLYHEDRON_H
#define LIBMESH_CELL_POLYHEDRON_H


// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/cell.h"

namespace libMesh
{

// Forward declarations
class Polygon;

class Polyhedron : public Cell
{
public:

  Polyhedron (const std::vector<std::shared_ptr<Polygon>> & sides,
              Elem * p);

  Polyhedron (Polyhedron &&) = delete;
  Polyhedron (const Polyhedron &) = delete;
  Polyhedron & operator= (const Polyhedron &) = delete;
  Polyhedron & operator= (Polyhedron &&) = delete;
  virtual ~Polyhedron() = default;

  virtual bool runtime_topology() const override { return true; }

  virtual Point master_point (const unsigned int i) const override;

  static const int num_children = 0; // Refinement not yet supported

  virtual unsigned int n_nodes() const override { return this->_nodelinks_data.size(); }

  virtual unsigned int n_sides() const override final { return _elemlinks_data.size()-2; }

  virtual unsigned int n_edges() const override final { return _edge_lookup.size(); }

  virtual unsigned int n_faces() const override final { return _elemlinks_data.size()-2; }

  virtual unsigned int n_children() const override final { return num_children; }

  virtual bool is_child_on_side(const unsigned int c,
                                const unsigned int s) const override;

  virtual unsigned int opposite_side(const unsigned int s) const override final;

  virtual unsigned int opposite_node(const unsigned int n,
                                     const unsigned int s) const override final;

  using Elem::key;

  virtual dof_id_type key () const override;

  virtual dof_id_type key (const unsigned int s) const override;

  virtual dof_id_type low_order_key (const unsigned int s) const override;

  virtual unsigned int local_side_node(unsigned int side,
                                       unsigned int side_node) const override;

  virtual unsigned int local_edge_node(unsigned int edge,
                                       unsigned int edge_node) const override;

  virtual std::unique_ptr<Elem> side_ptr (const unsigned int i) override final;

  virtual std::unique_ptr<Elem> side_ptr (const unsigned int i) const;

  virtual void side_ptr (std::unique_ptr<Elem> & elem,
                         const unsigned int i) override final;

  virtual std::unique_ptr<Elem> build_side_ptr (const unsigned int i) override;

  virtual void build_side_ptr (std::unique_ptr<Elem> & elem,
                               const unsigned int i) override;

  // Avoid hiding deprecated version with different signature
  using Elem::build_side_ptr;

  virtual std::unique_ptr<Elem> build_edge_ptr (const unsigned int i) override final;

  virtual void build_edge_ptr (std::unique_ptr<Elem> & edge, const unsigned int i) override final;

  virtual std::pair<Real, Real> qual_bounds (const ElemQuality q) const override;

  virtual std::vector<unsigned int> sides_on_edge(const unsigned int e) const override final;

  virtual bool is_edge_on_side(const unsigned int e,
                               const unsigned int s) const override final;

  virtual unsigned int n_permutations() const override { return 1; }

  virtual void permute(unsigned int libmesh_dbg_var(perm_num)) override final
  { libmesh_assert_equal_to(perm_num, 0); }

  virtual bool is_flipped() const override final;

  virtual void flip(BoundaryInfo *) override final { libmesh_not_implemented(); };

  virtual std::vector<unsigned int> edges_adjacent_to_node(const unsigned int n) const override;

  virtual void retriangulate() = 0;

  bool convex();

  unsigned int n_subelements() const { return cast_int<unsigned int>(this->_triangulation.size()); }

  virtual std::array<int, 4> subelement (unsigned int i) const
  {
    libmesh_assert_less(i, this->_triangulation.size());
    return this->_triangulation[i];
  }

  virtual std::array<Point, 4> master_subelement (unsigned int i) const;

  std::tuple<unsigned int, Real, Real, Real>
    subelement_coordinates (const Point & p,
                            Real tol = TOLERANCE*TOLERANCE) const;

  virtual bool on_reference_element(const Point & p,
                                    const Real eps = TOLERANCE) const override final;

protected:

  std::vector<std::shared_ptr<Polygon>> side_clones() const;

  bool side_has_edge_nodes(unsigned int side,
                           unsigned int min_node,
                           unsigned int max_node) const;

  std::vector<Elem *> _elemlinks_data;

  std::vector<Node *> _nodelinks_data;

  std::vector<std::tuple<std::shared_ptr<Polygon>,
                         bool,
                         std::vector<unsigned int>>> _sidelinks_data;

  std::vector<std::pair<unsigned int, unsigned int>> _edge_lookup;

  std::vector<std::array<int, 4>> _triangulation;
};


} // namespace libMesh

#endif // LIBMESH_CELL_POLYHEDRON_H