libMesh
metis_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_METIS_PARTITIONER_H
21 #define LIBMESH_METIS_PARTITIONER_H
22 
23 // Local Includes
24 #include "libmesh/partitioner.h"
25 #include "libmesh/auto_ptr.h" // libmesh_make_unique
26 
27 namespace libMesh
28 {
29 
39 {
40 public:
41 
46  MetisPartitioner () = default;
47  MetisPartitioner (const MetisPartitioner &) = default;
48  MetisPartitioner (MetisPartitioner &&) = default;
49  MetisPartitioner & operator= (const MetisPartitioner &) = default;
51  virtual ~MetisPartitioner() = default;
52 
56  virtual std::unique_ptr<Partitioner> clone () const override
57  {
58  return libmesh_make_unique<MetisPartitioner>(*this);
59  }
60 
61  virtual void attach_weights(ErrorVector * weights) override { _weights = weights; }
62 
66  virtual void partition_range(MeshBase & mesh,
69  const unsigned int n) override;
70 
71 protected:
72 
76  virtual void _do_partition (MeshBase & mesh,
77  const unsigned int n) override;
78 };
79 
80 } // namespace libMesh
81 
82 #endif // LIBMESH_METIS_PARTITIONER_H
libMesh::MetisPartitioner::~MetisPartitioner
virtual ~MetisPartitioner()=default
libMesh::MeshBase::element_iterator
The definition of the element_iterator struct.
Definition: mesh_base.h:1873
libMesh::MetisPartitioner::_do_partition
virtual void _do_partition(MeshBase &mesh, const unsigned int n) override
Partition the MeshBase into n subdomains.
Definition: metis_partitioner.C:468
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::MeshBase
This is the MeshBase class.
Definition: mesh_base.h:78
libMesh::MetisPartitioner::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: metis_partitioner.C:58
libMesh::MetisPartitioner::clone
virtual std::unique_ptr< Partitioner > clone() const override
Definition: metis_partitioner.h:56
libMesh::MetisPartitioner
The MetisPartitioner uses the Metis graph partitioner to partition the elements.
Definition: metis_partitioner.h:38
libMesh::MetisPartitioner::MetisPartitioner
MetisPartitioner()=default
Ctors, assignment operators, and destructor are all explicitly defaulted for this class.
libMesh::ErrorVector
The ErrorVector is a specialization of the StatisticsVector for error data computed on a finite eleme...
Definition: error_vector.h:50
libMesh::MetisPartitioner::operator=
MetisPartitioner & operator=(const MetisPartitioner &)=default
libMesh::MetisPartitioner::attach_weights
virtual void attach_weights(ErrorVector *weights) override
Attach weights that can be used for partitioning.
Definition: metis_partitioner.h:61
libMesh::Partitioner::_weights
ErrorVector * _weights
The weights that might be used for partitioning.
Definition: partitioner.h:267