libMesh
Loading...
Searching...
No Matches
subdomain_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_SUBDOMAIN_PARTITIONER_H
21#define LIBMESH_SUBDOMAIN_PARTITIONER_H
22
23// Local Includes
24#include "libmesh/partitioner.h"
25
26// C++ Includes
27#include <memory>
28
29namespace libMesh
30{
31
58{
59public:
60
68
74
81 virtual ~SubdomainPartitioner() = default;
82
83 virtual PartitionerType type () const override;
84
88 virtual std::unique_ptr<Partitioner> clone () const override
89 {
90 return std::make_unique<SubdomainPartitioner>(*this);
91 }
92
99 std::vector<std::set<subdomain_id_type>> chunks;
100
115 std::unique_ptr<Partitioner> & internal_partitioner() { return _internal_partitioner; }
116
117protected:
122 std::unique_ptr<Partitioner> _internal_partitioner;
123
127 virtual void _do_partition (MeshBase & mesh,
128 const unsigned int n) override;
129};
130
131} // namespace libMesh
132
133#endif // LIBMESH_SUBDOMAIN_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 SubdomainPartitioner partitions the elements in "chunks" of user-specified subdomain ids.
std::unique_ptr< Partitioner > & internal_partitioner()
Get a reference to the Partitioner used internally by the SubdomainPartitioner.
std::vector< std::set< subdomain_id_type > > chunks
Each entry of "chunks" represents a set of subdomains which are to be partitioned together.
virtual void _do_partition(MeshBase &mesh, const unsigned int n) override
Partition the MeshBase into n subdomains.
virtual ~SubdomainPartitioner()=default
SubdomainPartitioner(SubdomainPartitioner &&)=default
Move ctor, move assignment operator, and destructor are all explicitly defaulted for this class.
virtual std::unique_ptr< Partitioner > clone() const override
virtual PartitionerType type() const override
SubdomainPartitioner & operator=(const SubdomainPartitioner &)=delete
This class contains a unique_ptr member, so it can't be default copy assigned.
std::unique_ptr< Partitioner > _internal_partitioner
The internal Partitioner we use.
MeshBase & mesh
The libMesh namespace provides an interface to certain functionality in the library.
PartitionerType
Defines an enum for mesh partitioner types.