libMesh
sfc_partitioner.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2019 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 #include "libmesh/auto_ptr.h" // libmesh_make_unique
26 
27 // C++ Includes
28 #include <string>
29 
30 namespace libMesh
31 {
32 
42 {
43 public:
44 
50  _sfc_type ("Hilbert")
51  {}
52 
57  SFCPartitioner (const SFCPartitioner &) = default;
58  SFCPartitioner (SFCPartitioner &&) = default;
59  SFCPartitioner & operator= (const SFCPartitioner &) = default;
61  virtual ~SFCPartitioner() = default;
62 
66  virtual std::unique_ptr<Partitioner> clone () const override
67  {
68  return libmesh_make_unique<SFCPartitioner>(*this);
69  }
70 
75  void set_sfc_type (const std::string & sfc_type)
76  {
77  libmesh_assert ((sfc_type == "Hilbert") ||
78  (sfc_type == "Morton"));
79 
80  _sfc_type = sfc_type;
81  }
82 
86  virtual void partition_range(MeshBase & mesh,
89  const unsigned int n) override;
90 
91 protected:
92 
96  virtual void _do_partition (MeshBase & mesh,
97  const unsigned int n) override;
98 
99 
100 private:
101 
105  std::string _sfc_type;
106 };
107 
108 } // namespace libMesh
109 
110 #endif // LIBMESH_SFC_PARTITIONER_H
libMesh::MeshBase::element_iterator
The definition of the element_iterator struct.
Definition: mesh_base.h:1873
libMesh::SFCPartitioner::partition_range
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).
Definition: sfc_partitioner.C:41
libMesh
The libMesh namespace provides an interface to certain functionality in the library.
Definition: factoryfunction.C:55
end
IterBase * end
Also have a polymorphic pointer to the end object, this prevents iterating past the end.
Definition: variant_filter_iterator.h:343
libMesh::Partitioner
The Partitioner class provides a uniform interface for partitioning algorithms.
Definition: partitioner.h:50
mesh
MeshBase & mesh
Definition: mesh_communication.C:1257
libMesh::SFCPartitioner::operator=
SFCPartitioner & operator=(const SFCPartitioner &)=default
libMesh::libmesh_assert
libmesh_assert(ctx)
libMesh::MeshBase
This is the MeshBase class.
Definition: mesh_base.h:78
libMesh::SFCPartitioner::set_sfc_type
void set_sfc_type(const std::string &sfc_type)
Sets the type of space-filling curve to use.
Definition: sfc_partitioner.h:75
libMesh::SFCPartitioner::~SFCPartitioner
virtual ~SFCPartitioner()=default
libMesh::SFCPartitioner::SFCPartitioner
SFCPartitioner()
Constructor.
Definition: sfc_partitioner.h:49
libMesh::SFCPartitioner
The SFCPartitioner uses a Hilbert or Morton-ordered space filling curve to partition the elements.
Definition: sfc_partitioner.h:41
libMesh::SFCPartitioner::clone
virtual std::unique_ptr< Partitioner > clone() const override
Definition: sfc_partitioner.h:66
libMesh::SFCPartitioner::_do_partition
virtual void _do_partition(MeshBase &mesh, const unsigned int n) override
Partition the MeshBase into n subdomains.
Definition: sfc_partitioner.C:182
libMesh::SFCPartitioner::_sfc_type
std::string _sfc_type
The type of space-filling curve to use.
Definition: sfc_partitioner.h:105