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_SFC_PARTITIONER_H
      21             : #define LIBMESH_SFC_PARTITIONER_H
      22             : 
      23             : // Local Includes
      24             : #include "libmesh/partitioner.h"
      25             : 
      26             : // C++ Includes
      27             : #include <memory>
      28             : #include <string>
      29             : 
      30             : namespace libMesh
      31             : {
      32             : 
      33             : /**
      34             :  * The \p SFCPartitioner uses a Hilbert or Morton-ordered space
      35             :  * filling curve to partition the elements.
      36             :  *
      37             :  * \author Benjamin S. Kirk
      38             :  * \date 2003
      39             :  * \brief Partitioner based on different types of space filling curves.
      40             :  */
      41             : class SFCPartitioner : public Partitioner
      42             : {
      43             : public:
      44             : 
      45             :   /**
      46             :    * Constructor.  Sets the default space filling
      47             :    * curve type to "Hilbert".
      48             :    */
      49         219 :   SFCPartitioner () :
      50         231 :     _sfc_type ("Hilbert")
      51         219 :   {}
      52             : 
      53             :   /**
      54             :    * Copy/move ctor, copy/move assignment operator, and destructor are
      55             :    * all explicitly defaulted for this class.
      56             :    */
      57          96 :   SFCPartitioner (const SFCPartitioner &) = default;
      58             :   SFCPartitioner (SFCPartitioner &&) = default;
      59             :   SFCPartitioner & operator= (const SFCPartitioner &) = default;
      60             :   SFCPartitioner & operator= (SFCPartitioner &&) = default;
      61         144 :   virtual ~SFCPartitioner() = default;
      62             : 
      63             :   virtual PartitionerType type () const override;
      64             : 
      65             :   /**
      66             :    * \returns A copy of this partitioner wrapped in a smart pointer.
      67             :    */
      68          32 :   virtual std::unique_ptr<Partitioner> clone () const override
      69             :   {
      70          32 :     return std::make_unique<SFCPartitioner>(*this);
      71             :   }
      72             : 
      73             :   /**
      74             :    * Elements are assigned from a space-filling curve computed here, with no reference to
      75             :    * the partitioning the mesh arrives with.
      76             :    */
      77         180 :   virtual bool partitions_from_scratch () const override { return true; }
      78             : 
      79             :   /**
      80             :    * Sets the type of space-filling curve to use.  Valid types are
      81             :    * "Hilbert" (the default) and "Morton".
      82             :    */
      83           4 :   void set_sfc_type (std::string sfc_type)
      84             :   {
      85           4 :     libmesh_assert ((sfc_type == "Hilbert") ||
      86             :                     (sfc_type == "Morton"));
      87             : 
      88         146 :     _sfc_type = std::move(sfc_type);
      89           4 :   }
      90             : 
      91             :   /**
      92             :    * Called by the SubdomainPartitioner to partition elements in the range (it, end).
      93             :    */
      94             :   virtual void partition_range(MeshBase & mesh,
      95             :                                MeshBase::element_iterator it,
      96             :                                MeshBase::element_iterator end,
      97             :                                const unsigned int n) override;
      98             : 
      99             : protected:
     100             : 
     101             :   /**
     102             :    * Partition the \p MeshBase into \p n subdomains.
     103             :    */
     104             :   virtual void _do_partition (MeshBase & mesh,
     105             :                               const unsigned int n) override;
     106             : 
     107             : 
     108             : private:
     109             : 
     110             :   /**
     111             :    * The type of space-filling curve to use.  Hilbert by default.
     112             :    */
     113             :   std::string _sfc_type;
     114             : };
     115             : 
     116             : } // namespace libMesh
     117             : 
     118             : #endif // LIBMESH_SFC_PARTITIONER_H