cell_pyramid5.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_PYRAMID5_H
#define LIBMESH_CELL_PYRAMID5_H

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

namespace libMesh
{

class Pyramid5 final : public Pyramid
{
public:

  explicit
  Pyramid5 (Elem * p=nullptr) :
    Pyramid(num_nodes, p, _nodelinks_data)
  {}

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

  virtual ElemType type () const override { return PYRAMID5; }

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

  virtual bool is_vertex(const unsigned int i) const override;

  virtual bool is_edge(const unsigned int i) const override;

  virtual bool is_face(const unsigned int i) const override;

  virtual bool is_node_on_side(const unsigned int n,
                               const unsigned int s) const override;

  virtual std::vector<unsigned int> nodes_on_side(const unsigned int s) const override;

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

  virtual bool is_node_on_edge(const unsigned int n,
                               const unsigned int e) const override;

  virtual bool has_affine_map () const override;

  virtual Order default_order() const override;

  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;

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

  virtual void connectivity(const unsigned int sc,
                            const IOPackage iop,
                            std::vector<dof_id_type> & conn) const override;

  static const int num_nodes = 5;
  static const int nodes_per_side = 4;
  static const int nodes_per_edge = 2;

  static const unsigned int side_nodes_map[num_sides][nodes_per_side];

  static const unsigned int edge_nodes_map[num_edges][nodes_per_edge];

  virtual Point true_centroid () const override;

  virtual Real volume () const override;

  virtual BoundingBox loose_bounding_box () const override;

  virtual void permute(unsigned int perm_num) override final;

  virtual void flip(BoundaryInfo *) override final;

  ElemType side_type (const unsigned int s) const override final;

protected:

  Node * _nodelinks_data[num_nodes];



#ifdef LIBMESH_ENABLE_AMR

  virtual Real embedding_matrix (const unsigned int,
                                 const unsigned int,
                                 const unsigned int) const override
  { libmesh_not_implemented(); return 0.; }

  LIBMESH_ENABLE_TOPOLOGY_CACHES;

#endif // LIBMESH_ENABLE_AMR

};

} // namespace libMesh


#endif // LIBMESH_CELL_PYRAMID5_H