libMesh
Loading...
Searching...
No Matches
sfc_partitioner.h
Go to the documentation of this file.
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
30namespace libMesh
31{
32
42{
43public:
44
50 _sfc_type ("Hilbert")
51 {}
52
57 SFCPartitioner (const SFCPartitioner &) = default;
61 virtual ~SFCPartitioner() = default;
62
63 virtual PartitionerType type () const override;
64
68 virtual std::unique_ptr<Partitioner> clone () const override
69 {
70 return std::make_unique<SFCPartitioner>(*this);
71 }
72
77 void set_sfc_type (std::string sfc_type)
78 {
79 libmesh_assert ((sfc_type == "Hilbert") ||
80 (sfc_type == "Morton"));
81
82 _sfc_type = std::move(sfc_type);
83 }
84
88 virtual void partition_range(MeshBase & mesh,
91 const unsigned int n) override;
92
93protected:
94
98 virtual void _do_partition (MeshBase & mesh,
99 const unsigned int n) override;
100
101
102private:
103
107 std::string _sfc_type;
108};
109
110} // namespace libMesh
111
112#endif // LIBMESH_SFC_PARTITIONER_H
This is the MeshBase class.
Definition mesh_base.h:81
The Partitioner class provides a uniform interface for partitioning algorithms.
Definition partitioner.h:52
The SFCPartitioner uses a Hilbert or Morton-ordered space filling curve to partition the elements.
std::string _sfc_type
The type of space-filling curve to use.
void set_sfc_type(std::string sfc_type)
Sets the type of space-filling curve to use.
SFCPartitioner(const SFCPartitioner &)=default
Copy/move ctor, copy/move assignment operator, and destructor are all explicitly defaulted for this c...
virtual PartitionerType type() const override
virtual void _do_partition(MeshBase &mesh, const unsigned int n) override
Partition the MeshBase into n subdomains.
virtual void partition_range(MeshBase &mesh, MeshBase::element_iterator it, MeshBase::element_iterator end, const unsigned int n) override
Called by the SubdomainPartitioner to partition elements in the range (it, end).
SFCPartitioner(SFCPartitioner &&)=default
virtual std::unique_ptr< Partitioner > clone() const override
SFCPartitioner & operator=(const SFCPartitioner &)=default
virtual ~SFCPartitioner()=default
MeshBase & mesh
The libMesh namespace provides an interface to certain functionality in the library.
PartitionerType
Defines an enum for mesh partitioner types.
libmesh_assert(ctx)
The definition of the element_iterator struct.
Definition mesh_base.h:2538