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