point_neighbor_coupling.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_POINT_NEIGHBOR_COUPLING_H
#define LIBMESH_POINT_NEIGHBOR_COUPLING_H

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

// C++ Includes
#include <memory>

namespace libMesh
{

// Forward declarations
class PeriodicBoundaries;


class PointNeighborCoupling : public GhostingFunctor
{
public:

  PointNeighborCoupling() :
    _dof_coupling(nullptr),
#ifdef LIBMESH_ENABLE_PERIODIC
    _periodic_bcs(nullptr),
#endif
    _n_levels(0)
  {}

  PointNeighborCoupling(const PointNeighborCoupling & other) :
    GhostingFunctor(other),
    _dof_coupling(other._dof_coupling),
#ifdef LIBMESH_ENABLE_PERIODIC
    _periodic_bcs(other._periodic_bcs),
#endif
    _n_levels(other._n_levels)
  {}

  virtual std::unique_ptr<GhostingFunctor> clone () const override
  { return std::make_unique<PointNeighborCoupling>(*this); }

  // Change coupling matrix after construction
  void set_dof_coupling(const CouplingMatrix * dof_coupling)
  { _dof_coupling = dof_coupling; }

  // Return number of levels of point neighbors we will couple.
  unsigned int n_levels()
  { return _n_levels; }

  // Change number of levels of point neighbors to couple.
  void set_n_levels(unsigned int n_levels)
  { _n_levels = n_levels; }

#ifdef LIBMESH_ENABLE_PERIODIC
  // Set PeriodicBoundaries to couple.
  //
  // FIXME: This capability is not currently implemented.
  void set_periodic_boundaries(const PeriodicBoundaries * periodic_bcs) override
  { _periodic_bcs = periodic_bcs; }
#endif

  virtual void mesh_reinit () override;

  virtual void redistribute () override
  { this->mesh_reinit(); }

  virtual void delete_remote_elements() override
  { this->mesh_reinit(); }

  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) override;

private:

  const CouplingMatrix * _dof_coupling;
#ifdef LIBMESH_ENABLE_PERIODIC
  const PeriodicBoundaries * _periodic_bcs;
#endif
  unsigned int _n_levels;
};

} // namespace libMesh

#endif // LIBMESH_POINT_NEIGHBOR_COUPLING_H