mesh_communication.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2018 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_COMMUNICATION_H
#define LIBMESH_MESH_COMMUNICATION_H

// Local Includes
#include "libmesh/compare_elems_by_level.h"
#include "libmesh/libmesh_common.h"
#include "libmesh/mesh_tools.h"

// C++ Includes
#include <unordered_map>

namespace libMesh
{

// Forward declarations
class MeshBase;
class DistributedMesh;

// This is for backwards compatibility, but if your code relies on
// forward declarations in our headers then fix it.
class ParallelMesh;

class MeshCommunication
{
public:

  MeshCommunication () {}

  ~MeshCommunication () {}

  void clear ();

  //   /**
  //    * Finds all the processors that may contain
  //    * elements that neighbor my elements.  This list
  //    * is guaranteed to include all processors that border
  //    * any of my elements, but may include additional ones as
  //    * well.  This method computes bounding boxes for the
  //    * elements on each processor and checks for overlaps.
  //    */
  //   void find_neighboring_processors(const MeshBase &);

  void broadcast (MeshBase &) const;

  void redistribute (DistributedMesh & mesh,
                     bool newly_coarsened_only = false) const;

  void gather_neighboring_elements (DistributedMesh &) const;

  void send_coarse_ghosts (MeshBase &) const;

  void gather (const processor_id_type root_id, DistributedMesh &) const;

  void allgather (DistributedMesh & mesh) const
  { MeshCommunication::gather(DofObject::invalid_processor_id, mesh); }

  void delete_remote_elements (DistributedMesh &, const std::set<Elem *> &) const;

  void assign_global_indices (MeshBase &) const;

  void check_for_duplicate_global_indices (MeshBase & ) const;

  template <typename ForwardIterator>
  void find_local_indices (const libMesh::BoundingBox &,
                           const ForwardIterator &,
                           const ForwardIterator &,
                           std::unordered_map<dof_id_type, dof_id_type> &) const;

  template <typename ForwardIterator>
  void find_global_indices (const Parallel::Communicator & communicator,
                            const libMesh::BoundingBox &,
                            const ForwardIterator &,
                            const ForwardIterator &,
                            std::vector<dof_id_type> &) const;

  void make_elems_parallel_consistent (MeshBase &);

#ifdef LIBMESH_ENABLE_AMR

  void make_p_levels_parallel_consistent (MeshBase &);
#endif // LIBMESH_ENABLE_AMR

  void make_node_ids_parallel_consistent (MeshBase &);

  void make_node_unique_ids_parallel_consistent (MeshBase &);

  void make_node_proc_ids_parallel_consistent (MeshBase &);

  void make_new_node_proc_ids_parallel_consistent (MeshBase &);

  void make_nodes_parallel_consistent (MeshBase &);

  void make_new_nodes_parallel_consistent (MeshBase &);
};


// Related utilities

// Ask a mesh's ghosting functors to insert into a set all elements
// that are either on or connected to processor id \p pid.  Ask only
// for elements in the range from \p elem_it before \p elem_end;
// typically this may be mesh.active_pid_elements_*(pid)
void query_ghosting_functors(const MeshBase & mesh,
                             processor_id_type pid,
                             MeshBase::const_element_iterator elem_it,
                             MeshBase::const_element_iterator elem_end,
                             std::set<const Elem *, CompareElemIdsByLevel> & connected_elements);

// Take a set of elements and insert all immediate
// children of elements in the given range
void connect_children(const MeshBase & mesh,
                      MeshBase::const_element_iterator elem_it,
                      MeshBase::const_element_iterator elem_end,
                      std::set<const Elem *, CompareElemIdsByLevel> & connected_elements);

// Take a set of elements and insert all elements' ancestors and
// subactive descendants as well.
void connect_families(std::set<const Elem *, CompareElemIdsByLevel> & connected_elements);

// Take a set of elements and create a set of connected nodes.
void reconnect_nodes (const std::set<const Elem *, CompareElemIdsByLevel> & connected_elements,
                      std::set<const Node *> & connected_nodes);



//--------------------------------------------------------------
// MeshCommunication inline members


} // namespace libMesh

#endif // LIBMESH_MESH_COMMUNICATION_H