|
Ginkgo
Generated from pipelines/1330831941 branch based on master. Ginkgo version 1.8.0
A numerical linear algebra library targeting many-core architectures
|
5 #ifndef GKO_PUBLIC_CORE_MULTIGRID_PGM_HPP_
6 #define GKO_PUBLIC_CORE_MULTIGRID_PGM_HPP_
12 #include <ginkgo/core/base/composition.hpp>
13 #include <ginkgo/core/base/exception_helpers.hpp>
14 #include <ginkgo/core/base/lin_op.hpp>
15 #include <ginkgo/core/base/types.hpp>
16 #include <ginkgo/core/config/config.hpp>
17 #include <ginkgo/core/config/registry.hpp>
18 #include <ginkgo/core/config/type_descriptor.hpp>
19 #include <ginkgo/core/distributed/matrix.hpp>
20 #include <ginkgo/core/matrix/csr.hpp>
21 #include <ginkgo/core/matrix/dense.hpp>
22 #include <ginkgo/core/multigrid/multigrid_level.hpp>
51 template <
typename ValueType = default_precision,
typename IndexType =
int32>
52 class Pgm :
public EnableLinOp<Pgm<ValueType, IndexType>>,
53 public EnableMultigridLevel<ValueType> {
54 friend class EnableLinOp<Pgm>;
55 friend class EnablePolymorphicObject<Pgm,
LinOp>;
58 using value_type = ValueType;
59 using index_type = IndexType;
68 return system_matrix_;
148 static parameters_type
parse(
151 config::make_type_descriptor<ValueType, IndexType>());
154 void apply_impl(
const LinOp* b,
LinOp* x)
const override
160 LinOp* x)
const override
165 explicit Pgm(std::shared_ptr<const Executor> exec)
169 explicit Pgm(
const Factory* factory,
170 std::shared_ptr<const LinOp> system_matrix)
172 EnableMultigridLevel<ValueType>(system_matrix),
173 parameters_{factory->get_parameters()},
174 system_matrix_{system_matrix},
175 agg_(
factory->get_executor(), system_matrix_->get_size()[0])
179 if (system_matrix_->get_size()[0] != 0) {
192 std::tuple<std::shared_ptr<LinOp>, std::shared_ptr<LinOp>,
193 std::shared_ptr<LinOp>>
195 std::shared_ptr<
const matrix::Csr<ValueType, IndexType>> local_matrix);
198 template <
typename GlobalIndexType>
199 void communicate(std::shared_ptr<
const experimental::distributed::Matrix<
200 ValueType, IndexType, GlobalIndexType>>
202 const array<IndexType>& local_agg,
203 array<IndexType>& non_local_agg);
207 std::shared_ptr<const LinOp> system_matrix_{};
208 array<IndexType> agg_;
212 template <
typename ValueType = default_precision,
typename IndexType =
int32>
213 using AmgxPgm GKO_DEPRECATED(
214 "This class is deprecated and will be removed in the next "
215 "major release. Please use Pgm instead.") = Pgm<ValueType, IndexType>;
222 #endif // GKO_PUBLIC_CORE_MULTIGRID_PGM_HPP_
pnode describes a tree of properties.
Definition: property_tree.hpp:28
Definition: lin_op.hpp:118
std::shared_ptr< Composition< ValueType > > get_composition() const
Returns the composition operators.
Definition: composition.hpp:186
#define GKO_FACTORY_PARAMETER_SCALAR(_name, _default)
Creates a scalar factory parameter in the factory parameters structure.
Definition: abstract_factory.hpp:445
This class describes the value and index types to be used when building a Ginkgo type from a configur...
Definition: type_descriptor.hpp:37
The Ginkgo namespace.
Definition: abstract_factory.hpp:20
IndexType * get_agg() noexcept
Returns the aggregate group.
Definition: pgm.hpp:80
Parallel graph match (Pgm) is the aggregate method introduced in the paper M.
Definition: matrix.hpp:37
#define GKO_ENABLE_LIN_OP_FACTORY(_lin_op, _parameters_name, _factory_name)
This macro will generate a default implementation of a LinOpFactory for the LinOp subclass it is defi...
Definition: lin_op.hpp:1018
value_type * get_data() noexcept
Returns a pointer to the block of memory used to store the elements of the array.
Definition: array.hpp:674
const IndexType * get_const_agg() const noexcept
Returns the aggregate group.
Definition: pgm.hpp:89
This class stores additional context for creating Ginkgo objects from configuration files.
Definition: registry.hpp:168
#define GKO_ENABLE_BUILD_METHOD(_factory_name)
Defines a build method for the factory, simplifying its construction by removing the repetitive typin...
Definition: abstract_factory.hpp:394
#define GKO_CREATE_FACTORY_PARAMETERS(_parameters_name, _factory_name)
This Macro will generate a new type containing the parameters for the factory _factory_name.
Definition: abstract_factory.hpp:280
const value_type * get_const_data() const noexcept
Returns a constant pointer to the block of memory used to store the elements of the array.
Definition: array.hpp:683
std::shared_ptr< const Executor > get_executor() const noexcept
Returns the Executor of the object.
Definition: polymorphic_object.hpp:235
std::shared_ptr< const LinOp > get_system_matrix() const
Returns the system operator (matrix) of the linear system.
Definition: pgm.hpp:66
const dim< 2 > & get_size() const noexcept
Returns the size of the operator.
Definition: lin_op.hpp:211
static parameters_type parse(const config::pnode &config, const config::registry &context, const config::type_descriptor &td_for_child=config::make_type_descriptor< ValueType, IndexType >())
Create the parameters from the property_tree.
double max_unassigned_ratio
The maximum ratio of unassigned number, which is valid in the interval 0.0 ~ 1.0.
Definition: pgm.hpp:109
The EnableLinOp mixin can be used to provide sensible default implementations of the majority of the ...
Definition: lin_op.hpp:878
LinOp(const LinOp &)=default
Copy-constructs a LinOp.