Ginkgo: gko::multigrid::FixedCoarsening< ValueType, IndexType >::parameters_type Struct Reference

| Ginkgo Generated from branch based on main. Ginkgo version 1.11.0 A numerical linear algebra library targeting many-core architectures

Loading...
Searching...
No Matches
gko::multigrid::FixedCoarsening< ValueType, IndexType >::parameters_type Struct Reference
Inheritance diagram for gko::multigrid::FixedCoarsening< ValueType, IndexType >::parameters_type:
[legend]
Collaboration diagram for gko::multigrid::FixedCoarsening< ValueType, IndexType >::parameters_type:
[legend]

## Public Member Functions
template<typename... Args>
auto | with_coarse_rows (Args &&... _value) -> std::decay_t< decltype(*(this->self()))> &
template<typename... Args>
auto | with_skip_sorting (Args &&... _value) -> std::decay_t< decltype(*(this->self()))> &
Public Member Functions inherited from gko::enable_parameters_type< parameters_type, Factory >
parameters_type & | with_loggers (Args &&... _value)
| Provides the loggers to be added to the factory and its generated objects in a fluent interface.
std::unique_ptr< Factory > | on (std::shared_ptr< const Executor > exec) const
| Creates a new factory on the specified executor.

## Public Attributes
array< IndexType > | coarse_rows {nullptr}
| This array specifies the rows of the fine matrix which should be selected as rows for the coarse matrix.
bool | skip_sorting {false}
| The system_matrix, which will be given to this factory, must be sorted (first by row, then by column) in order for the algorithm to work.

## Additional Inherited Members
Public Types inherited from gko::enable_parameters_type< parameters_type, Factory >
using | factory

## Member Data Documentation

## ◆ skip_sorting

template<typename ValueType = default_precision, typename IndexType = int32>

bool gko::multigrid::FixedCoarsening< ValueType, IndexType >::parameters_type::skip_sorting {false}

The system_matrix, which will be given to this factory, must be sorted (first by row, then by column) in order for the algorithm to work.

If it is known that the matrix will be sorted, this parameter can be set to true to skip the sorting (therefore, shortening the runtime). However, if it is unknown or if the matrix is known to be not sorted, it must remain false, otherwise, this multigrid_level might be incorrect.

The documentation for this struct was generated from the following file:

- ginkgo/core/multigrid/fixed_coarsening.hpp