cell_tet.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_TET_H
#define LIBMESH_CELL_TET_H

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

namespace libMesh
{

class Tet : public Cell
{
public:

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

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

  virtual Point master_point (const unsigned int i) const override final
  {
    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 = 4;
  static const int num_edges = 6;
  static const int num_children = 8;

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

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

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

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

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

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

  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 final;

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

  virtual Real quality (const ElemQuality q) const override;

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

  enum Diagonal
    {
      DIAG_02_13=0,    // diagonal between edges (0,2) and (1,3)
      DIAG_03_12=1,    // diagonal between edges (0,3) and (1,2)
      DIAG_01_23=2,    // diagonal between edges (0,1) and (2,3)
      INVALID_DIAG=99  // diagonal not yet selected
    };

  Diagonal diagonal_selection () const { return _diagonal_selection; }

  void select_diagonal (const Diagonal diag) const;

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


#ifdef LIBMESH_ENABLE_AMR


  virtual unsigned int embedding_matrix_version () const override final
  {
    this->choose_diagonal();
    return this->diagonal_selection();
  }

#endif // LIBMESH_ENABLE_AMR

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

  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[6][2];

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

protected:

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

  static const Real _master_points[14][3];

  bool is_child_on_side_helper(const unsigned int c,
                               const unsigned int s,
                               const unsigned int checked_nodes[][3] ) const;

  mutable Diagonal _diagonal_selection;

  void choose_diagonal() const;

  static const unsigned int adjacent_edges_map[/*num_vertices*/4][/*n_adjacent_edges*/3];
};

} // namespace libMesh

#endif // LIBMESH_CELL_TET_H