libMesh
mapped_subdomain_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_MAPPED_SUBDOMAIN_PARTITIONER_H
21 #define LIBMESH_MAPPED_SUBDOMAIN_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 
43 {
44 public:
45 
50  MappedSubdomainPartitioner () = default;
55  virtual ~MappedSubdomainPartitioner() = default;
56 
60  virtual std::unique_ptr<Partitioner> clone () const override
61  {
62  return libmesh_make_unique<MappedSubdomainPartitioner>(*this);
63  }
64 
79  std::map<subdomain_id_type, processor_id_type> subdomain_to_proc;
80 
84  virtual void partition_range(MeshBase & mesh,
87  const unsigned int n) override;
88 
89 protected:
90 
94  virtual void _do_partition (MeshBase & mesh,
95  const unsigned int n) override;
96 };
97 
98 } // namespace libMesh
99 
100 #endif // LIBMESH_MAPPED_SUBDOMAIN_PARTITIONER_H
libMesh::MeshBase::element_iterator
The definition of the element_iterator struct.
Definition: mesh_base.h:1873
libMesh::MappedSubdomainPartitioner::clone
virtual std::unique_ptr< Partitioner > clone() const override
Definition: mapped_subdomain_partitioner.h:60
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
libMesh::MappedSubdomainPartitioner::MappedSubdomainPartitioner
MappedSubdomainPartitioner()=default
Ctors, assignment operators, and destructor are all explicitly defaulted for this class.
mesh
MeshBase & mesh
Definition: mesh_communication.C:1257
libMesh::MeshBase
This is the MeshBase class.
Definition: mesh_base.h:78
libMesh::MappedSubdomainPartitioner::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: mapped_subdomain_partitioner.C:31
libMesh::MappedSubdomainPartitioner::~MappedSubdomainPartitioner
virtual ~MappedSubdomainPartitioner()=default
libMesh::MappedSubdomainPartitioner::_do_partition
virtual void _do_partition(MeshBase &mesh, const unsigned int n) override
Partition the MeshBase into n subdomains.
Definition: mapped_subdomain_partitioner.C:60
libMesh::MappedSubdomainPartitioner::subdomain_to_proc
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...
Definition: mapped_subdomain_partitioner.h:79
libMesh::MappedSubdomainPartitioner::operator=
MappedSubdomainPartitioner & operator=(const MappedSubdomainPartitioner &)=default
libMesh::MappedSubdomainPartitioner
The MappedSubdomainPartitioner partitions the elements based on their subdomain ids.
Definition: mapped_subdomain_partitioner.h:42