unstructured_mesh.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_UNSTRUCTURED_MESH_H
#define LIBMESH_UNSTRUCTURED_MESH_H

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

// C++ Includes
#include <cstddef>

namespace libMesh
{

class UnstructuredMesh : public MeshBase
{
public:

  explicit
  UnstructuredMesh (const Parallel::Communicator & comm_in,
                    unsigned char dim=1);

  UnstructuredMesh(const UnstructuredMesh &) = default;

  UnstructuredMesh(const MeshBase &);

  UnstructuredMesh(UnstructuredMesh &&) = delete;

  UnstructuredMesh & operator= (const UnstructuredMesh &) = delete;

  UnstructuredMesh & operator= (UnstructuredMesh && other_mesh) = default;

  virtual MeshBase & assign(MeshBase && other_mesh) override = 0;

  virtual ~UnstructuredMesh();

  virtual void read (const std::string & name,
                     void * mesh_data=nullptr,
                     bool skip_renumber_nodes_and_elements=false,
                     bool skip_find_neighbors=false) override;
  virtual void write (const std::string & name) const override;

  void write (const std::string & name,
              const std::vector<Number> & values,
              const std::vector<std::string> & variable_names) const;

  virtual void all_first_order () override;

  virtual void all_second_order_range (const SimpleRange<element_iterator> & range,
                                       const bool full_ordered=true) override;

  virtual void all_complete_order_range (const SimpleRange<element_iterator> & range) override;

  void create_pid_mesh (UnstructuredMesh & pid_mesh,
                        const processor_id_type pid) const;

  void create_submesh (UnstructuredMesh & new_mesh,
                       const const_element_iterator & it,
                       const const_element_iterator & it_end) const;

  std::size_t stitch_meshes (const MeshBase & other_mesh,
                             boundary_id_type this_mesh_boundary,
                             boundary_id_type other_mesh_boundary,
                             Real tol=TOLERANCE,
                             bool clear_stitched_boundary_ids=false,
                             bool verbose=true,
                             bool use_binary_search=true,
                             bool enforce_all_nodes_match_on_boundaries=false,
                             bool merge_boundary_nodes_all_or_nothing=false,
                             bool remap_subdomain_ids=false);

  std::size_t stitch_surfaces (boundary_id_type boundary_id_1,
                               boundary_id_type boundary_id_2,
                               Real tol=TOLERANCE,
                               bool clear_stitched_boundary_ids=false,
                               bool verbose=true,
                               bool use_binary_search=true,
                               bool enforce_all_nodes_match_on_boundaries=false,
                               bool merge_boundary_nodes_all_or_nothing=false);

  virtual void copy_nodes_and_elements (const MeshBase & other_mesh,
                                        const bool skip_find_neighbors = false,
                                        dof_id_type element_id_offset = 0,
                                        dof_id_type node_id_offset = 0,
                                        unique_id_type unique_id_offset = 0,
                                        std::unordered_map<subdomain_id_type, subdomain_id_type> *
                                          id_remapping = nullptr);

  virtual void move_nodes_and_elements(MeshBase && other_mesh) = 0;


  virtual void find_neighbors (const bool reset_remote_elements = false,
                               const bool reset_current_list    = true) override;

#ifdef LIBMESH_ENABLE_AMR

  virtual bool contract () override;
#endif // #ifdef LIBMESH_ENABLE_AMR

private:

  std::size_t stitching_helper (const MeshBase * other_mesh,
                                boundary_id_type boundary_id_1,
                                boundary_id_type boundary_id_2,
                                Real tol,
                                bool clear_stitched_boundary_ids,
                                bool verbose,
                                bool use_binary_search,
                                bool enforce_all_nodes_match_on_boundaries,
                                bool skip_find_neighbors,
                                bool merge_boundary_nodes_all_or_nothing,
                                bool remap_subdomain_ids);
};


} // namespace libMesh

#endif // LIBMESH_UNSTRUCTURED_MESH_H