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_METIS_PARTITIONER_H
      21             : #define LIBMESH_METIS_PARTITIONER_H
      22             : 
      23             : // Local Includes
      24             : #include "libmesh/partitioner.h"
      25             : 
      26             : // C++ Includes
      27             : #include <memory>
      28             : 
      29             : namespace libMesh
      30             : {
      31             : 
      32             : /**
      33             :  * The \p MetisPartitioner uses the Metis graph partitioner
      34             :  * to partition the elements.
      35             :  *
      36             :  * \author Benjamin S. Kirk
      37             :  * \date 2003
      38             :  * \brief Partitioner which interfaces with the METIS library.
      39             :  */
      40             : class MetisPartitioner : public Partitioner
      41             : {
      42             : public:
      43             : 
      44             :   /**
      45             :    * Ctors, assignment operators, and destructor are all explicitly
      46             :    * defaulted for this class.
      47             :    */
      48      315860 :   MetisPartitioner () = default;
      49        4496 :   MetisPartitioner (const MetisPartitioner &) = default;
      50             :   MetisPartitioner (MetisPartitioner &&) = default;
      51             :   MetisPartitioner & operator= (const MetisPartitioner &) = default;
      52             :   MetisPartitioner & operator= (MetisPartitioner &&) = default;
      53      262739 :   virtual ~MetisPartitioner() = default;
      54             : 
      55             :   virtual PartitionerType type () const override;
      56             : 
      57             :   /**
      58             :    * \returns A copy of this partitioner wrapped in a smart pointer.
      59             :    */
      60        4496 :   virtual std::unique_ptr<Partitioner> clone () const override
      61             :   {
      62        4496 :     return std::make_unique<MetisPartitioner>(*this);
      63             :   }
      64             : 
      65             :   /**
      66             :    * METIS is handed the mesh dual graph indexed along a space-filling curve of its own,
      67             :    * so its result does not depend on the partitioning the mesh arrives with.
      68             :    */
      69       59333 :   virtual bool partitions_from_scratch () const override { return true; }
      70             : 
      71           0 :   virtual void attach_weights(ErrorVector * weights) override { _weights = weights; }
      72             : 
      73             :   /**
      74             :    * Called by the SubdomainPartitioner to partition elements in the range (it, end).
      75             :    */
      76             :   virtual void partition_range(MeshBase & mesh,
      77             :                                MeshBase::element_iterator it,
      78             :                                MeshBase::element_iterator end,
      79             :                                const unsigned int n) override;
      80             : 
      81             : protected:
      82             : 
      83             :   /**
      84             :    * Partition the \p MeshBase into \p n subdomains.
      85             :    */
      86             :   virtual void _do_partition (MeshBase & mesh,
      87             :                               const unsigned int n) override;
      88             : };
      89             : 
      90             : } // namespace libMesh
      91             : 
      92             : #endif // LIBMESH_METIS_PARTITIONER_H