libMesh
Loading...
Searching...
No Matches
parallel_sort.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#ifndef LIBMESH_PARALLEL_SORT_H
20#define LIBMESH_PARALLEL_SORT_H
21
22// Local Includes
23#include "libmesh/libmesh_common.h"
24#include "libmesh/parallel_object.h"
25
26// C++ Includes
27#include <vector>
28
29namespace libMesh
30{
31
32namespace Parallel
33{
34
35// Forward declarations
36class Communicator;
37
54template <typename KeyType, typename IdxType=unsigned int>
55class Sort : public ParallelObject
56{
57public:
67 std::vector<KeyType> & d);
68
69
76 void sort();
77
83 const std::vector<KeyType> & bin();
84
85private:
86
91
96
101
107 std::vector<KeyType> & _data;
108
114 std::vector<IdxType> _local_bin_sizes;
115
122 std::vector<KeyType> _my_bin;
123
129 void binsort ();
130
137 void communicate_bins();
138
144 void sort_local_bin();
145
146};
147}
148
149} // namespace libMesh
150
151#endif // LIBMESH_PARALLEL_SORT_H
An object whose state is distributed along a set of processors.
const Parallel::Communicator & comm() const
The parallel sorting method is templated on the type of data which is to be sorted.
const processor_id_type _n_procs
The number of processors to work with.
const std::vector< KeyType > & bin()
Return a constant reference to _my_bin.
std::vector< KeyType > _my_bin
The bin which will eventually be held by this processor.
void sort()
This is the only method which needs to be called by the user.
void sort_local_bin()
After all the bins have been communicated, we can sort our local bin.
void communicate_bins()
Communicates the bins from each processor to the appropriate processor.
std::vector< IdxType > _local_bin_sizes
Vector which holds the size of each bin on this processor.
std::vector< KeyType > & _data
The raw, unsorted data which will need to be sorted (in parallel) across all processors.
bool _bin_is_sorted
Flag which lets you know if sorting is complete.
void binsort()
Sorts the local data into bins across all processors.
const processor_id_type _proc_id
The identity of this processor.
uint8_t processor_id_type
The libMesh namespace provides an interface to certain functionality in the library.