sibling_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_SIBLING_COUPLING_H
#define LIBMESH_SIBLING_COUPLING_H

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

// C++ Includes
#include <memory>

namespace libMesh
{

class SiblingCoupling : public GhostingFunctor
{
public:

  SiblingCoupling() :
    _dof_coupling(nullptr) {}

  SiblingCoupling(const SiblingCoupling & other) : GhostingFunctor(other),
    _dof_coupling(other._dof_coupling) {}

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

  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;

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

private:

  const CouplingMatrix * _dof_coupling;
};

} // namespace libMesh

#endif // LIBMESH_SIBLING_COUPLING_H