libMesh
linear_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_LINEAR_PARTITIONER_H
21 #define LIBMESH_LINEAR_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 
41 {
42 public:
43 
48  LinearPartitioner () = default;
49  LinearPartitioner (const LinearPartitioner &) = default;
50  LinearPartitioner (LinearPartitioner &&) = default;
51  LinearPartitioner & operator= (const LinearPartitioner &) = default;
53  virtual ~LinearPartitioner() = default;
54 
58  virtual std::unique_ptr<Partitioner> clone () const override
59  {
60  return libmesh_make_unique<LinearPartitioner>(*this);
61  }
62 
66  virtual void partition_range(MeshBase & mesh,
69  const unsigned int n) override;
70 protected:
71 
75  virtual void _do_partition (MeshBase & mesh,
76  const unsigned int n) override;
77 };
78 
79 } // namespace libMesh
80 
81 #endif // LIBMESH_LINEAR_PARTITIONER_H
libMesh::LinearPartitioner::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: linear_partitioner.C:29
libMesh::MeshBase::element_iterator
The definition of the element_iterator struct.
Definition: mesh_base.h:1873
libMesh::LinearPartitioner::LinearPartitioner
LinearPartitioner()=default
Ctors, assignment operators, and destructor are all explicitly defaulted for this class.
libMesh::LinearPartitioner::operator=
LinearPartitioner & operator=(const LinearPartitioner &)=default
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
mesh
MeshBase & mesh
Definition: mesh_communication.C:1257
libMesh::MeshBase
This is the MeshBase class.
Definition: mesh_base.h:78
libMesh::LinearPartitioner::_do_partition
virtual void _do_partition(MeshBase &mesh, const unsigned int n) override
Partition the MeshBase into n subdomains.
Definition: linear_partitioner.C:108
libMesh::LinearPartitioner::~LinearPartitioner
virtual ~LinearPartitioner()=default
libMesh::LinearPartitioner::clone
virtual std::unique_ptr< Partitioner > clone() const override
Definition: linear_partitioner.h:58
libMesh::LinearPartitioner
The LinearPartitioner simply takes the element list and splits it into equal-sized chunks assigned to...
Definition: linear_partitioner.h:40