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_HILBERT_SFC_PARTITIONER_H
      21             : #define LIBMESH_HILBERT_SFC_PARTITIONER_H
      22             : 
      23             : // Local Includes
      24             : #include "libmesh/sfc_partitioner.h"
      25             : 
      26             : #include "libmesh/enum_partitioner_type.h"
      27             : 
      28             : namespace libMesh
      29             : {
      30             : 
      31             : /**
      32             :  * The \p HilbertSFCPartitioner uses a Hilbert space
      33             :  * filling curve to partition the elements.
      34             :  *
      35             :  * \author Benjamin S. Kirk
      36             :  * \date 2003
      37             :  * \brief Partitioner based on Hilbert's space filling curve algorithm.
      38             :  */
      39             : class HilbertSFCPartitioner : public SFCPartitioner
      40             : {
      41             : public:
      42             : 
      43             :   /**
      44             :    * Constructor. Sets the underlying space filling curve type.
      45             :    */
      46          73 :   HilbertSFCPartitioner ()
      47          73 :   {
      48          73 :     this->set_sfc_type ("Hilbert");
      49          73 :   }
      50             : 
      51             :   /**
      52             :    * Copy/move ctor, copy/move assignment operator, and destructor are
      53             :    * all explicitly defaulted for this class.
      54             :    */
      55          32 :   HilbertSFCPartitioner (const HilbertSFCPartitioner &) = default;
      56             :   HilbertSFCPartitioner (HilbertSFCPartitioner &&) = default;
      57             :   HilbertSFCPartitioner & operator= (const HilbertSFCPartitioner &) = default;
      58             :   HilbertSFCPartitioner & operator= (HilbertSFCPartitioner &&) = default;
      59          54 :   virtual ~HilbertSFCPartitioner() = default;
      60             : 
      61           0 :   virtual PartitionerType type () const override
      62             :   {
      63           0 :     return HILBERT_SFC_PARTITIONER;
      64             :   };
      65             : 
      66             :   /**
      67             :    * \returns A copy of this partitioner wrapped in a smart pointer.
      68             :    */
      69          32 :   virtual std::unique_ptr<Partitioner> clone () const override
      70             :   {
      71          32 :     return std::make_unique<HilbertSFCPartitioner>(*this);
      72             :   }
      73             : 
      74             : protected:
      75             : 
      76             :   /**
      77             :    * Partition the \p MeshBase into \p n subdomains.
      78             :    */
      79          60 :   virtual void _do_partition (MeshBase & mesh,
      80             :                               const unsigned int n) override
      81             :   {
      82          60 :     SFCPartitioner::_do_partition (mesh, n);
      83          60 :   }
      84             : };
      85             : 
      86             : } // namespace libMesh
      87             : 
      88             : #endif // LIBMESH_HILBERT_SFC_PARTITIONER_H