cell_pyramid.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_PYRAMID_H
#define LIBMESH_CELL_PYRAMID_H

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

namespace libMesh
{




class Pyramid : public Cell
{
public:

  Pyramid(const unsigned int nn, Elem * p, Node ** nodelinkdata) :
    Cell(nn, num_sides, p, _elemlinks_data, nodelinkdata)
  {
    // Make sure the interior parent isn't undefined
    if (LIBMESH_DIM > 3)
      this->set_interior_parent(nullptr);
  }

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

  virtual Point master_point (const unsigned int i) const override
  {
    libmesh_assert_less(i, this->n_nodes());
    return Point(_master_points[i][0],
                 _master_points[i][1],
                 _master_points[i][2]);
  }

  static const int num_sides = 5;
  static const int num_edges = 8;
  static const int num_children = 0; // not implemented

  virtual unsigned int n_nodes() const override { return 5; }

  virtual unsigned int n_sides() const override { return 5; }

  virtual unsigned int n_vertices() const override { return 5; }

  virtual unsigned int n_edges() const override { return 8; }

  virtual unsigned int n_faces() const override { return 5; }

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

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

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

  using Elem::key;

  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;

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

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

  unsigned int local_singular_node(const Point & p, const Real tol = TOLERANCE*TOLERANCE) const override final;

  virtual bool is_singular_node(unsigned int node_idx) const override final { return (node_idx == 4); }

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

  virtual bool is_flipped() const override final;

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

  static const unsigned int edge_sides_map[8][2];

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

protected:

  Elem * _elemlinks_data[6+(LIBMESH_DIM>3)];

  static const Real _master_points[14][3];

#ifdef LIBMESH_ENABLE_AMR

  unsigned int side_children_matrix (const unsigned int,
                                     const unsigned int) const
  { libmesh_not_implemented(); return 0; }

#endif

  static const unsigned int adjacent_edges_map[/*num_vertices*/5][/*max_adjacent_edges*/4];
};

} // namespace libMesh

#endif // LIBMESH_CELL_PYRAMID_H