libMesh
Loading...
Searching...
No Matches
metis_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_METIS_PARTITIONER_H
21#define LIBMESH_METIS_PARTITIONER_H
22
23// Local Includes
24#include "libmesh/partitioner.h"
25
26// C++ Includes
27#include <memory>
28
29namespace libMesh
30{
31
41{
42public:
43
48 MetisPartitioner () = default;
53 virtual ~MetisPartitioner() = default;
54
55 virtual PartitionerType type () const override;
56
60 virtual std::unique_ptr<Partitioner> clone () const override
61 {
62 return std::make_unique<MetisPartitioner>(*this);
63 }
64
65 virtual void attach_weights(ErrorVector * weights) override { _weights = weights; }
66
70 virtual void partition_range(MeshBase & mesh,
73 const unsigned int n) override;
74
75protected:
76
80 virtual void _do_partition (MeshBase & mesh,
81 const unsigned int n) override;
82};
83
84} // namespace libMesh
85
86#endif // LIBMESH_METIS_PARTITIONER_H
The ErrorVector is a specialization of the StatisticsVector for error data computed on a finite eleme...
This is the MeshBase class.
Definition mesh_base.h:81
The MetisPartitioner uses the Metis graph partitioner to partition the elements.
virtual PartitionerType type() const override
MetisPartitioner(const MetisPartitioner &)=default
virtual void attach_weights(ErrorVector *weights) override
Attach weights that can be used for partitioning.
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).
virtual ~MetisPartitioner()=default
MetisPartitioner & operator=(const MetisPartitioner &)=default
virtual void _do_partition(MeshBase &mesh, const unsigned int n) override
Partition the MeshBase into n subdomains.
virtual std::unique_ptr< Partitioner > clone() const override
MetisPartitioner()=default
Ctors, assignment operators, and destructor are all explicitly defaulted for this class.
MetisPartitioner(MetisPartitioner &&)=default
The Partitioner class provides a uniform interface for partitioning algorithms.
Definition partitioner.h:52
ErrorVector * _weights
The weights that might be used for partitioning.
MeshBase & mesh
The libMesh namespace provides an interface to certain functionality in the library.
PartitionerType
Defines an enum for mesh partitioner types.
The definition of the element_iterator struct.
Definition mesh_base.h:2538