Debian Codegraph @

src/atlas/grid/detail/partitioner/Partitioner.h

raw
1 /*
2 * (C) Copyright 2013 ECMWF.
3 *
4 * This software is licensed under the terms of the Apache Licence Version 2.0
5 * which can be obtained at http://www.apache.org/licenses/LICENSE-2.0.
6 * In applying this licence, ECMWF does not waive the privileges and immunities
7 * granted to it by virtue of its status as an intergovernmental organisation
8 * nor does it submit to any jurisdiction.
9 */
10
11 #pragma once
12
13 #include <string>
14
15 #include "atlas/library/config.h"
16 #include "atlas/util/Config.h"
17 #include "atlas/util/Object.h"
18
19 namespace atlas {
20 class Grid;
21 class Mesh;
22 class FunctionSpace;
23 namespace grid {
24 class Distribution;
25 } // namespace grid
26 } // namespace atlas
27
28 namespace atlas {
29 namespace grid {
30 namespace detail {
31 namespace partitioner {
32
33 class Partitioner : public util::Object {
34 public:
35 using Grid = atlas::Grid;
36
37 public:
38 Partitioner();
39 Partitioner(const idx_t nb_partitions, const eckit::Parametrisation&);
40 Partitioner(const eckit::Parametrisation&);
41
42 virtual ~Partitioner();
43
44 virtual void partition(const Grid& grid, int part[]) const = 0;
45
46 virtual Distribution partition(const Grid& grid) const;
47
48 idx_t nb_partitions() const;
49
50 virtual std::string type() const = 0;
51
52 std::string mpi_comm() const;
53
54 static int extract_nb_partitions(const eckit::Parametrisation&);
55 static std::string extract_mpi_comm(const eckit::Parametrisation&);
56
57 private:
58 idx_t nb_partitions_;
59 std::string mpi_comm_;
60 };
61
62 // ------------------------------------------------------------------
63
64 class PartitionerFactory {
65 public:
66 using Grid = Partitioner::Grid;
67
68 public:
69 /*!
70 * \brief build Partitioner with factory key, constructor arguments
71 * \return Partitioner
72 */
73 static Partitioner* build(const std::string&);
74 static Partitioner* build(const std::string&, const idx_t nb_partitions);
75 static Partitioner* build(const std::string&, const idx_t nb_partitions, const eckit::Parametrisation&);
76 static Partitioner* build(const std::string&, const eckit::Parametrisation&);
77
78 /*!
79 * \brief list all registered partioner builders
80 */
81 static void list(std::ostream&);
82 static bool has(const std::string& name);
83
84 private:
85 std::string name_;
86 virtual Partitioner* make() = 0;
87 virtual Partitioner* make(const idx_t nb_partitions) = 0;
88 virtual Partitioner* make(const idx_t nb_partitions, const eckit::Parametrisation&) = 0;
89 virtual Partitioner* make(const eckit::Parametrisation&) = 0;
90
91 protected:
92 PartitionerFactory(const std::string&);
93 virtual ~PartitionerFactory();
94 };
95
96 // ------------------------------------------------------------------
97
98 template <class T>
99 class PartitionerBuilder : public PartitionerFactory {
100 virtual Partitioner* make() { return new T(); }
101
102 virtual Partitioner* make(const idx_t nb_partitions) { return new T(nb_partitions, util::NoConfig()); }
103 virtual Partitioner* make(const idx_t nb_partitions, const eckit::Parametrisation& config) {
104 return new T(nb_partitions, config);
105 }
106 virtual Partitioner* make(const eckit::Parametrisation& config) {
107 return new T(config);
108 }
109
110 public:
111 PartitionerBuilder(const std::string& name): PartitionerFactory(name) {}
112 };
113
114 // ------------------------------------------------------------------
115
116 class MatchingPartitionerFactory {
117 public:
118 static Partitioner* build(const std::string& type, const Mesh& partitioned, const eckit::Parametrisation& config);
119 static Partitioner* build(const std::string& type, const FunctionSpace& partitioned, const eckit::Parametrisation& config);
120 };
121
122 // ------------------------------------------------------------------
123
124 } // namespace partitioner
125 } // namespace detail
126 } // namespace grid
127 } // namespace atlas