Line data Source code
1 : // The libMesh Finite Element Library. 2 : // Copyright (C) 2002-2026 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_POINT_NEIGHBOR_COUPLING_H 21 : #define LIBMESH_POINT_NEIGHBOR_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 : // Forward declarations 33 : class PeriodicBoundaries; 34 : 35 : 36 : /** 37 : * This class implements ghosting of point neighbors (elements on the 38 : * same manifold that share points), ghosting stencils out to a 39 : * user-configurable number of levels of neighbors. 40 : * 41 : * \author Roy H. Stogner 42 : * \date 2016 43 : */ 44 : class PointNeighborCoupling : public GhostingFunctor 45 : { 46 : public: 47 : 48 : /** 49 : * Constructor. 50 : */ 51 : PointNeighborCoupling() : 52 : _dof_coupling(nullptr), 53 : #ifdef LIBMESH_ENABLE_PERIODIC 54 : _periodic_bcs(nullptr), 55 : #endif 56 : _n_levels(0) 57 : {} 58 : 59 : /** 60 : * Constructor. 61 : */ 62 8 : PointNeighborCoupling(const PointNeighborCoupling & other) : 63 : GhostingFunctor(other), 64 8 : _dof_coupling(other._dof_coupling), 65 : #ifdef LIBMESH_ENABLE_PERIODIC 66 8 : _periodic_bcs(other._periodic_bcs), 67 : #endif 68 8 : _n_levels(other._n_levels) 69 8 : {} 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 8 : virtual std::unique_ptr<GhostingFunctor> clone () const override 76 8 : { return std::make_unique<PointNeighborCoupling>(*this); } 77 : 78 : // Change coupling matrix after construction 79 : void set_dof_coupling(const CouplingMatrix * dof_coupling) 80 : { _dof_coupling = dof_coupling; } 81 : 82 : // Return number of levels of point neighbors we will couple. 83 : unsigned int n_levels() 84 : { return _n_levels; } 85 : 86 : // Change number of levels of point neighbors to couple. 87 : void set_n_levels(unsigned int n_levels) 88 : { _n_levels = n_levels; } 89 : 90 : #ifdef LIBMESH_ENABLE_PERIODIC 91 : // Set PeriodicBoundaries to couple. 92 : // 93 : // FIXME: This capability is not currently implemented. 94 0 : void set_periodic_boundaries(const PeriodicBoundaries * periodic_bcs) override 95 0 : { _periodic_bcs = periodic_bcs; } 96 : 97 0 : const PeriodicBoundaries * get_periodic_boundaries() override 98 0 : { return _periodic_bcs; } 99 : #endif 100 : 101 : /** 102 : * If we have periodic boundaries, then we'll need the mesh to have 103 : * an updated point locator whenever we're about to query them. 104 : */ 105 : virtual void mesh_reinit () override; 106 : 107 430 : virtual void redistribute () override 108 430 : { this->mesh_reinit(); } 109 : 110 256 : virtual void delete_remote_elements() override 111 256 : { this->mesh_reinit(); } 112 : 113 : /** 114 : * For the specified range of active elements, find the elements 115 : * which will be coupled to them in the sparsity pattern. 116 : * 117 : * This will include the point neighbors, point neighbors of point 118 : * neighbors, etc, to n_levels depth. 119 : */ 120 : virtual void operator() (const MeshBase::const_element_iterator & range_begin, 121 : const MeshBase::const_element_iterator & range_end, 122 : processor_id_type p, 123 : map_type & coupled_elements) override; 124 : 125 : private: 126 : 127 : const CouplingMatrix * _dof_coupling; 128 : #ifdef LIBMESH_ENABLE_PERIODIC 129 : const PeriodicBoundaries * _periodic_bcs; 130 : #endif 131 : unsigned int _n_levels; 132 : }; 133 : 134 : } // namespace libMesh 135 : 136 : #endif // LIBMESH_POINT_NEIGHBOR_COUPLING_H