edge.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2014 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"

// C++ includes
#include <cstddef>

namespace libMesh
{


// Forward declarations
class Mesh;



class Edge : public Elem
{
public:

  Edge (const unsigned int nn,
        Elem* p,
        Node** nodelinkdata) :
    Elem(nn, Edge::n_sides(), p, _elemlinks_data, nodelinkdata) {}

  unsigned int dim () const { return 1; }

  unsigned int n_nodes() const { return 2; }

  unsigned int n_sides() const { return 2; }

  unsigned int n_vertices() const { return 2; }

  unsigned int n_edges() const { return 0; }

  unsigned int n_faces() const { return 0; }

  unsigned int n_children() const { return 2; }

  /*
   * @returns true iff the specified child is on the
   * specified side
   */
  virtual bool is_child_on_side(const unsigned int c,
                                const unsigned int s) const;

  /*
   * @returns true iff the specified edge is on the specified side
   */
  virtual bool is_edge_on_side(const unsigned int,
                               const unsigned int) const
  { return false; }

  /*
   * @returns the side number opposite to \p s (for a tensor product
   * element), or throws an error otherwise.
   */
  virtual unsigned int opposite_side(const unsigned int s) const;

  /*
   * @returns the local node number for the node opposite to node n
   * on side \p opposite_side(s) (for a tensor product element), or
   * throws an error otherwise.
   */
  virtual unsigned int opposite_node(const unsigned int n,
                                     const unsigned int s) const;

  //   /**
  //    * @returns 1
  //    */
  //   unsigned int n_children_per_side(const unsigned int) const { return 1; }

  dof_id_type key (const unsigned int s) const
  { return this->compute_key(this->node(s)); }

  UniquePtr<Elem> side (const unsigned int i) const;

  UniquePtr<Elem> build_side (const unsigned int i,
                              bool proxy) const;

  UniquePtr<Elem> build_edge (const unsigned int) const
  { libmesh_not_implemented(); return UniquePtr<Elem>(); }


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

};





// ------------------------------------------------------------
// Edge class member functions

} // namespace libMesh

#endif // LIBMESH_EDGE_H