libMesh
mapped_subdomain_partitioner.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2025 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_MAPPED_SUBDOMAIN_PARTITIONER_H
21 #define LIBMESH_MAPPED_SUBDOMAIN_PARTITIONER_H
22 
23 // Local Includes
24 #include "libmesh/partitioner.h"
25 
26 // C++ Includes
27 #include <memory>
28 
29 namespace libMesh
30 {
31 
45 {
46 public:
47 
52  MappedSubdomainPartitioner () = default;
57  virtual ~MappedSubdomainPartitioner() = default;
58 
59  virtual PartitionerType type () const override;
60 
64  virtual std::unique_ptr<Partitioner> clone () const override
65  {
66  return std::make_unique<MappedSubdomainPartitioner>(*this);
67  }
68 
83  std::map<subdomain_id_type, processor_id_type> subdomain_to_proc;
84 
88  virtual void partition_range(MeshBase & mesh,
91  const unsigned int n) override;
92 
93 protected:
94 
98  virtual void _do_partition (MeshBase & mesh,
99  const unsigned int n) override;
100 };
101 
102 } // namespace libMesh
103 
104 #endif // LIBMESH_MAPPED_SUBDOMAIN_PARTITIONER_H
The definition of the element_iterator struct.
Definition: mesh_base.h:2198
MappedSubdomainPartitioner & operator=(const MappedSubdomainPartitioner &)=default
The MappedSubdomainPartitioner partitions the elements based on their subdomain ids.
MeshBase & mesh
virtual std::unique_ptr< Partitioner > clone() const override
The libMesh namespace provides an interface to certain functionality in the library.
This is the MeshBase class.
Definition: mesh_base.h:75
The Partitioner class provides a uniform interface for partitioning algorithms.
Definition: partitioner.h:51
virtual PartitionerType type() const override
virtual void _do_partition(MeshBase &mesh, const unsigned int n) override
Partition the MeshBase into n subdomains.
PartitionerType
Defines an enum for mesh partitioner types.
MappedSubdomainPartitioner()=default
Ctors, assignment operators, and destructor are all explicitly defaulted for this class...
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 ~MappedSubdomainPartitioner()=default
std::map< subdomain_id_type, processor_id_type > subdomain_to_proc
Before calling partition() or partition_range(), the user must assign all the Mesh subdomains to cert...