libMesh
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_SUBDOMAIN_PARTITIONER_H
21 #define LIBMESH_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 
56 {
57 public:
58 
66 
72 
79  virtual ~SubdomainPartitioner() = default;
80 
84  virtual std::unique_ptr<Partitioner> clone () const override
85  {
86  return libmesh_make_unique<SubdomainPartitioner>(*this);
87  }
88 
95  std::vector<std::set<subdomain_id_type>> chunks;
96 
111  std::unique_ptr<Partitioner> & internal_partitioner() { return _internal_partitioner; }
112 
113 protected:
118  std::unique_ptr<Partitioner> _internal_partitioner;
119 
123  virtual void _do_partition (MeshBase & mesh,
124  const unsigned int n) override;
125 };
126 
127 } // namespace libMesh
128 
129 #endif // LIBMESH_SUBDOMAIN_PARTITIONER_H
libMesh::SubdomainPartitioner::_internal_partitioner
std::unique_ptr< Partitioner > _internal_partitioner
The internal Partitioner we use.
Definition: subdomain_partitioner.h:118
libMesh::SubdomainPartitioner::~SubdomainPartitioner
virtual ~SubdomainPartitioner()=default
libMesh::SubdomainPartitioner::_do_partition
virtual void _do_partition(MeshBase &mesh, const unsigned int n) override
Partition the MeshBase into n subdomains.
Definition: subdomain_partitioner.C:42
libMesh
The libMesh namespace provides an interface to certain functionality in the library.
Definition: factoryfunction.C:55
libMesh::SubdomainPartitioner::internal_partitioner
std::unique_ptr< Partitioner > & internal_partitioner()
Get a reference to the Partitioner used internally by the SubdomainPartitioner.
Definition: subdomain_partitioner.h:111
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::SubdomainPartitioner::chunks
std::vector< std::set< subdomain_id_type > > chunks
Each entry of "chunks" represents a set of subdomains which are to be partitioned together.
Definition: subdomain_partitioner.h:95
libMesh::SubdomainPartitioner::clone
virtual std::unique_ptr< Partitioner > clone() const override
Definition: subdomain_partitioner.h:84
libMesh::SubdomainPartitioner::operator=
SubdomainPartitioner & operator=(const SubdomainPartitioner &)=delete
This class contains a unique_ptr member, so it can't be default copy assigned.
libMesh::SubdomainPartitioner
The SubdomainPartitioner partitions the elements in "chunks" of user-specified subdomain ids.
Definition: subdomain_partitioner.h:55
libMesh::SubdomainPartitioner::SubdomainPartitioner
SubdomainPartitioner()
Constructors.
Definition: subdomain_partitioner.C:30