Line data    Source code

       1             : // The libMesh Finite Element Library.
       2             : // Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
       3             : 
       4             : // This library is free software; you can redistribute it and/or
       5             : // modify it under the terms of the GNU Lesser General Public
       6             : // License as published by the Free Software Foundation; either
       7             : // version 2.1 of the License, or (at your option) any later version.
       8             : 
       9             : // This library is distributed in the hope that it will be useful,
      10             : // but WITHOUT ANY WARRANTY; without even the implied warranty of
      11             : // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      12             : // Lesser General Public License for more details.
      13             : 
      14             : // You should have received a copy of the GNU Lesser General Public
      15             : // License along with this library; if not, write to the Free Software
      16             : // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
      17             : 
      18             : 
      19             : 
      20             : #ifndef LIBMESH_SIBLING_COUPLING_H
      21             : #define LIBMESH_SIBLING_COUPLING_H
      22             : 
      23             : // Local Includes
      24             : #include "libmesh/ghosting_functor.h"
      25             : 
      26             : // C++ Includes
      27             : #include <memory>
      28             : 
      29             : namespace libMesh
      30             : {
      31             : 
      32             : /**
      33             :  * This class adds coupling (for use in send_list construction)
      34             :  * between active elements and all descendants of their parent.
      35             :  *
      36             :  * This may be useful when constructing projections onto the parent
      37             :  * element for error indicator evaluation.
      38             :  *
      39             :  * \author Roy H. Stogner
      40             :  * \date 2016
      41             :  */
      42             : class SiblingCoupling : public GhostingFunctor
      43             : {
      44             : public:
      45             : 
      46             :   /**
      47             :    * Constructor.
      48             :    */
      49             :   SiblingCoupling() :
      50             :     _dof_coupling(nullptr) {}
      51             : 
      52             :   /**
      53             :    * Constructor.
      54             :    */
      55        2414 :   SiblingCoupling(const SiblingCoupling & other) : GhostingFunctor(other),
      56        2414 :     _dof_coupling(other._dof_coupling) {}
      57             : 
      58             :   // Change coupling matrix after construction
      59             :   void set_dof_coupling(const CouplingMatrix * dof_coupling)
      60             :   { _dof_coupling = dof_coupling; }
      61             : 
      62             :   /**
      63             :    * For the specified range of active elements, find any sibling
      64             :    * elements which should be evaluable too.
      65             :    */
      66             :   virtual void operator() (const MeshBase::const_element_iterator & range_begin,
      67             :                            const MeshBase::const_element_iterator & range_end,
      68             :                            processor_id_type p,
      69             :                            map_type & coupled_elements) override;
      70             : 
      71             :    /**
      72             :     * A clone() is needed because GhostingFunctor can not be shared between
      73             :     * different meshes. The operations in  GhostingFunctor are mesh dependent.
      74             :     */
      75        2414 :    virtual std::unique_ptr<GhostingFunctor> clone () const override
      76        2414 :    { return std::make_unique<SiblingCoupling>(*this); }
      77             : 
      78             : private:
      79             : 
      80             :   const CouplingMatrix * _dof_coupling;
      81             : };
      82             : 
      83             : } // namespace libMesh
      84             : 
      85             : #endif // LIBMESH_SIBLING_COUPLING_H