edge.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_EDGE_H
#define LIBMESH_EDGE_H

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

namespace libMesh
{

class Edge : public Elem
{
public:

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

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

  static const int num_sides = 2;
  static const int num_edges = 0;
  static const int num_children = 2;
  static const int nodes_per_side = 1;
  static const int nodes_per_edge = invalid_int;

  virtual unsigned short dim () const override final { return 1; }

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

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

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

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

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

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

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

  virtual bool is_edge_on_side(const unsigned int,
                               const unsigned int) const override final
  { return false; }

  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 unsigned int s) const override final
  { return this->compute_key(this->node_id(s)); }

  virtual dof_id_type low_order_key (const unsigned int s) const override final
  { return this->compute_key(this->node_id(s)); }

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

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

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

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

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

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

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

  virtual std::unique_ptr<Elem> build_edge_ptr (const unsigned int) override final
  { libmesh_not_implemented(); return std::unique_ptr<Elem>(); }

  virtual void build_edge_ptr (std::unique_ptr<Elem> &, const unsigned int) override final
  { libmesh_not_implemented(); }

  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 std::vector<unsigned int> sides_on_edge(const unsigned int) const override final
  { return {}; }

  virtual std::vector<unsigned int> edges_adjacent_to_node(const unsigned int /*n*/) const override final
  { return {}; }

  virtual Point quasicircumcenter () const override
  { return (this->point(0) + this->point(1)) / 2; }

  // Any edge permutation flips the mapping Jacobian negative
  virtual unsigned int n_permutations() const override final { return 0; }

  virtual void permute(unsigned int) override final { libmesh_error(); }

  virtual bool is_flipped() const override final;

  unsigned int center_node_on_side(const unsigned short side) const override final;

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

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

protected:

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

#ifdef LIBMESH_ENABLE_AMR

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

#endif

};

} // namespace libMesh

#endif // LIBMESH_EDGE_H