mesh_tools.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_MESH_TOOLS_H
#define LIBMESH_MESH_TOOLS_H

// Local Includes
#include "libmesh/libmesh.h"
#include "libmesh/bounding_box.h"
#include "libmesh/id_types.h"
#include "libmesh/mesh_base.h"

// C++ Includes
#include <limits>
#include <set>
#include <unordered_set>
#include <unordered_map>
#include <vector>

namespace libMesh
{

// forward declarations
class Sphere;
class Elem;
enum ElemType : int;

namespace MeshTools
{

dof_id_type total_weight (const MeshBase & mesh);

dof_id_type weight (const MeshBase & mesh,
                    const processor_id_type pid);

inline
dof_id_type weight (const MeshBase & mesh)
{ return MeshTools::weight (mesh, mesh.processor_id()); }

void build_nodes_to_elem_map (const MeshBase & mesh,
                              std::vector<std::vector<dof_id_type>> & nodes_to_elem_map);

void build_nodes_to_elem_map (const MeshBase & mesh,
                              std::vector<std::vector<const Elem *>> & nodes_to_elem_map);

void build_nodes_to_elem_map (const MeshBase & mesh,
                              std::unordered_map<dof_id_type, std::vector<dof_id_type>> & nodes_to_elem_map);

void build_nodes_to_elem_map (const MeshBase & mesh,
                              std::unordered_map<dof_id_type, std::vector<const Elem *>> & nodes_to_elem_map);


//   /**
//    * Calling this function on a 2D mesh will convert all the elements
//    * to triangles.  \p QUAD4s will be converted to \p TRI3s, \p QUAD8s
//    * and \p QUAD9s will be converted to \p TRI6s.
//    */
//   void all_tri (MeshBase & mesh);

std::unordered_set<dof_id_type> find_boundary_nodes(const MeshBase & mesh);

std::unordered_set<dof_id_type> find_block_boundary_nodes(const MeshBase & mesh);

libMesh::BoundingBox
create_bounding_box (const MeshBase & mesh);

Sphere
bounding_sphere (const MeshBase & mesh);

libMesh::BoundingBox
create_nodal_bounding_box (const MeshBase & mesh);

libMesh::BoundingBox
create_local_bounding_box (const MeshBase & mesh);

libMesh::BoundingBox
create_processor_bounding_box (const MeshBase & mesh,
                               const processor_id_type pid);

Sphere
processor_bounding_sphere (const MeshBase & mesh,
                           const processor_id_type pid);

libMesh::BoundingBox
create_subdomain_bounding_box (const MeshBase & mesh,
                               const subdomain_id_type sid);

Sphere
subdomain_bounding_sphere (const MeshBase & mesh,
                           const subdomain_id_type sid);


void elem_types (const MeshBase & mesh,
                 std::vector<ElemType> & et);

dof_id_type n_elem_of_type (const MeshBase & mesh,
                            const ElemType type);

dof_id_type n_active_elem_of_type (const MeshBase & mesh,
                                   const ElemType type);

dof_id_type n_non_subactive_elem_of_type_at_level(const MeshBase & mesh,
                                                  const ElemType type,
                                                  const unsigned int level);

unsigned int n_levels(const MeshBase & mesh);

unsigned int n_local_levels(const MeshBase & mesh);

unsigned int n_active_levels(const MeshBase & mesh);

unsigned int n_active_local_levels(const MeshBase & mesh);

unsigned int n_p_levels (const MeshBase & mesh);

unsigned int paranoid_n_levels(const MeshBase & mesh);

dof_id_type n_connected_components(const MeshBase & mesh,
                                   Real constraint_tol = 0);

void get_not_subactive_node_ids(const MeshBase & mesh,
                                std::set<dof_id_type> & not_subactive_node_ids);

dof_id_type n_elem (const MeshBase::const_element_iterator & begin,
                    const MeshBase::const_element_iterator & end);


dof_id_type n_nodes (const MeshBase::const_node_iterator & begin,
                     const MeshBase::const_node_iterator & end);


Real volume (const MeshBase & mesh,
             unsigned int dim=libMesh::invalid_uint);


void find_nodal_neighbors(const MeshBase & mesh,
                          const Node & n,
                          const std::vector<std::vector<const Elem *>> & nodes_to_elem_map,
                          std::vector<const Node *> & neighbors);

void find_nodal_neighbors(const MeshBase & mesh,
                          const Node & n,
                          const std::unordered_map<dof_id_type, std::vector<const Elem *>> & nodes_to_elem_map,
                          std::vector<const Node *> & neighbors);

void find_hanging_nodes_and_parents(const MeshBase & mesh,
                                    std::map<dof_id_type, std::vector<dof_id_type>> & hanging_nodes);

void correct_node_proc_ids(MeshBase &);

void clear_spline_nodes(MeshBase &);

bool valid_is_prepared (const MeshBase & mesh);


#ifndef NDEBUG

void libmesh_assert_equal_n_systems (const MeshBase & mesh);

void libmesh_assert_old_dof_objects (const MeshBase & mesh);

void libmesh_assert_valid_node_pointers (const MeshBase & mesh);

void libmesh_assert_valid_remote_elems (const MeshBase & mesh);

void libmesh_assert_valid_elem_ids (const MeshBase & mesh);

void libmesh_assert_valid_amr_elem_ids (const MeshBase & mesh);

void libmesh_assert_valid_amr_interior_parents (const MeshBase & mesh);

void libmesh_assert_contiguous_dof_ids (const MeshBase & mesh,
                                        unsigned int sysnum);

template <typename DofObjectSubclass>
void libmesh_assert_topology_consistent_procids (const MeshBase & mesh);

void libmesh_assert_canonical_node_procids (const MeshBase & mesh);

void libmesh_assert_valid_refinement_tree (const MeshBase & mesh);

#endif // !NDEBUG



#ifdef DEBUG

void libmesh_assert_no_links_to_elem(const MeshBase & mesh,
                                     const Elem * bad_elem);

void libmesh_assert_equal_points (const MeshBase & mesh);

void libmesh_assert_equal_connectivity (const MeshBase & mesh);

void libmesh_assert_connected_nodes (const MeshBase & mesh);

void libmesh_assert_valid_constraint_rows (const MeshBase & mesh);

void libmesh_assert_valid_boundary_ids (const MeshBase & mesh);

void libmesh_assert_valid_dof_ids (const MeshBase & mesh,
                                   unsigned int sysnum = libMesh::invalid_uint);

#ifdef LIBMESH_ENABLE_UNIQUE_ID

void libmesh_assert_valid_unique_ids (const MeshBase & mesh);
#endif

void libmesh_assert_consistent_distributed(const MeshBase & mesh);

void libmesh_assert_consistent_distributed_nodes(const MeshBase & mesh);

void libmesh_assert_parallel_consistent_new_node_procids (const MeshBase & mesh);

template <typename DofObjectSubclass>
void libmesh_assert_parallel_consistent_procids (const MeshBase & mesh);

template <typename DofObjectSubclass>
void libmesh_assert_valid_procids (const MeshBase & mesh)
{
  libmesh_assert_parallel_consistent_procids<DofObjectSubclass>(mesh);
  libmesh_assert_topology_consistent_procids<DofObjectSubclass>(mesh);
}

void libmesh_assert_valid_refinement_flags (const MeshBase & mesh);

void libmesh_assert_valid_neighbors (const MeshBase & mesh,
                                     bool assert_valid_remote_elems=true);

#endif // DEBUG


// There is no reason for users to call functions in the MeshTools::Private namespace.
namespace Private {
void globally_renumber_nodes_and_elements (MeshBase &);
} // end namespace Private

} // end namespace MeshTools

} // namespace libMesh


#endif // LIBMESH_MESH_TOOLS_H