tetgen_scaffold_mesh.h

Go to the documentation of this file.

// LIC// ====================================================================
// LIC// This file forms part of oomph-lib, the object-oriented,
// LIC// multi-physics finite-element library, available
// LIC// at http://www.oomph-lib.org.
// LIC//
// LIC// Copyright (C) 2006-2025 Matthias Heil and Andrew Hazel
// LIC//
// LIC// This library is free software; you can redistribute it and/or
// LIC// modify it under the terms of the GNU Lesser General Public
// LIC// License as published by the Free Software Foundation; either
// LIC// version 2.1 of the License, or (at your option) any later version.
// LIC//
// LIC// This library is distributed in the hope that it will be useful,
// LIC// but WITHOUT ANY WARRANTY; without even the implied warranty of
// LIC// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// LIC// Lesser General Public License for more details.
// LIC//
// LIC// You should have received a copy of the GNU Lesser General Public
// LIC// License along with this library; if not, write to the Free Software
// LIC// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
// LIC// 02110-1301  USA.
// LIC//
// LIC// The authors may be contacted at oomph-lib@maths.man.ac.uk.
// LIC//
// LIC//====================================================================
#ifndef OOMPH_TETGEN_SCAFFOLD_MESH_HEADER
#define OOMPH_TETGEN_SCAFFOLD_MESH_HEADER
 
#include "mesh.h"
#include "Telements.h"
 
// Include the data structure from tetgen
 
#ifdef OOMPH_HAS_NEW_TETGEN
#include "oomph_tetgen_1.6/tetgen.h"
#else
#include "oomph_tetgen/tetgen.h"
#endif
 
namespace oomph
{
  //======================================================================
  /// Mesh that is based on input files generated by the tetrahedra
  /// mesh generator tetgen.
  //======================================================================
  class TetgenScaffoldMesh : public virtual Mesh
  {
  public:
    /// Empty constructor
    TetgenScaffoldMesh() {}
 
    /// Constructor: Pass the filename of the tetrahedra file
    TetgenScaffoldMesh(const std::string& node_file_name,
                       const std::string& element_file_name,
                       const std::string& face_file_name);
 
    /// Constructor using direct tetgenio object
    TetgenScaffoldMesh(tetgenio& tetgen_data);
 
    /// Empty destructor
    ~TetgenScaffoldMesh() {}
 
    /// Return the global node of each local node
    /// listed element-by-element e*n_local_node + n_local
    /// Note that the node numbers are indexed from 1
    unsigned global_node_number(const unsigned& i)
    {
      return Global_node[i];
    }
 
    /// Return the boundary id of the i-th face in the e-th element:
    /// This is zero-based as in tetgen. Zero means the face is not
    /// on a boundary. Postive numbers identify the boundary.
    /// Will be reduced by one to identify the oomph-lib boundary.
    unsigned face_boundary(const unsigned& e, const unsigned& i) const
    {
      return Face_boundary[e][i];
    }
 
    /// Return the number of internal edges
    unsigned nglobal_edge()
    {
      return Nglobal_edge;
    }
 
    /// Return a boolean indicating whether the i-th global
    /// edge is on a boundary
    bool edge_boundary(const unsigned& i)
    {
      return Edge_boundary[i];
    }
 
    /// Return the global index of the i-th edge in the e-th element:
    /// The global index starts from zero
    unsigned edge_index(const unsigned& e, const unsigned& i) const
    {
      return Edge_index[e][i];
    }
 
    /// Return the number of internal face
    unsigned nglobal_face()
    {
      return Nglobal_face;
    }
 
    /// Return the global index of the i-th face in the e-th element:
    /// The global index starts from zero
    unsigned face_index(const unsigned& e, const unsigned& i) const
    {
      return Face_index[e][i];
    }
 
    /// Return the attribute of the element e.
    /// NOTE: Attributes are doubles because tetgen forces us to! We only
    /// use them for region IDs
    double element_attribute(const unsigned& e) const
    {
      return Element_attribute[e];
    }
 
 
  protected:
    /// Storage for the number of global faces
    unsigned Nglobal_face;
 
    /// Storage for the number of global edges
    unsigned Nglobal_edge;
 
    /// Storage for global node numbers listed element-by-element
    Vector<unsigned> Global_node;
 
    /// Vector of booleans to indicate whether a global edge lies
    /// on a boundary
    std::vector<bool> Edge_boundary;
 
    /// Vector of vectors containing the boundary ids of the
    /// elements' faces
    Vector<Vector<unsigned>> Face_boundary;
 
    /// Vector of vectors containing the global edge index of
    // the elements' edges
    Vector<Vector<unsigned>> Edge_index;
 
    /// Vector of vectors containing the global edge index of
    // the elements' edges
    Vector<Vector<unsigned>> Face_index;
 
    /// Vector of double attributes for each element.
    /// NOTE: This stores doubles because tetgen forces us to! We only
    /// use it for region IDs
    Vector<double> Element_attribute;
  };
 
} // namespace oomph
 
#endif