ghosting_functor.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_GHOSTING_FUNCTOR_H
#define LIBMESH_GHOSTING_FUNCTOR_H

// Local Includes
#include "libmesh/libmesh_common.h"
#include "libmesh/id_types.h"
#include "libmesh/mesh_base.h"
#include "libmesh/reference_counted_object.h"
#include "libmesh/dof_object.h"

// C++ Includes
#include <unordered_map>

namespace libMesh
{

// Forward Declarations
class CouplingMatrix;
class Elem;
#ifdef LIBMESH_ENABLE_PERIODIC
class PeriodicBoundaries;
#endif

class GhostingFunctor : public ReferenceCountedObject<GhostingFunctor>
{
public:

  GhostingFunctor(): _mesh(nullptr) {}

  GhostingFunctor(const MeshBase & mesh): _mesh(&mesh) {}

  GhostingFunctor(const GhostingFunctor & other) :
   ReferenceCountedObject<GhostingFunctor>(other),
   _mesh (other._mesh)
  {}

  virtual ~GhostingFunctor() = default;

  virtual std::unique_ptr<GhostingFunctor> clone () const
  // Let us return nullptr for backward compatibility.
  // We will come back to mark this function as pure virtual
  // once the API upgrade is done.
  { return nullptr; }

  virtual void set_mesh(const MeshBase * mesh) { _mesh = mesh; }

#ifdef LIBMESH_ENABLE_PERIODIC
  // Set PeriodicBoundaries to couple
  virtual void set_periodic_boundaries(const PeriodicBoundaries *) {}
#endif

  const MeshBase * get_mesh() const { libmesh_assert(_mesh); return _mesh; }

  typedef std::map<const Elem*, const CouplingMatrix*, CompareDofObjectsByPIDAndThenID> map_type;

  virtual void operator() (const MeshBase::const_element_iterator & range_begin,
                           const MeshBase::const_element_iterator & range_end,
                           processor_id_type p,
                           map_type & coupled_elements) = 0;

  virtual void mesh_reinit () {};

  virtual void dofmap_reinit () {};

  virtual void redistribute () {};

  virtual void delete_remote_elements () {};

protected:
  const MeshBase * _mesh;
};

} // namespace libMesh

#endif // LIBMESH_GHOSTING_FUNCTOR_H