\doxysection{gko::\+multigrid::\+Fixed\+Coarsening\texorpdfstring{$<$}{<} Value\+Type, Index\+Type \texorpdfstring{$>$}{>} Class Template Reference}
\hypertarget{classgko_1_1multigrid_1_1FixedCoarsening}{}\label{classgko_1_1multigrid_1_1FixedCoarsening}\index{gko::multigrid::FixedCoarsening$<$ ValueType, IndexType $>$@{gko::multigrid::FixedCoarsening$<$ ValueType, IndexType $>$}}


\doxylink{classgko_1_1multigrid_1_1FixedCoarsening}{Fixed\+Coarsening} is a very simple coarse grid generation algorithm.  




{\ttfamily \+\#include $<$ginkgo/\+core/\+multigrid/\+fixed\+\_\+coarsening.\+hpp$>$}



Inheritance diagram for gko::\+multigrid::\+Fixed\+Coarsening\texorpdfstring{$<$}{<} Value\+Type, Index\+Type \texorpdfstring{$>$}{>}:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classgko_1_1multigrid_1_1FixedCoarsening__inherit__graph}
\end{center}
\end{figure}


Collaboration diagram for gko::\+multigrid::\+Fixed\+Coarsening\texorpdfstring{$<$}{<} Value\+Type, Index\+Type \texorpdfstring{$>$}{>}:\+
\nopagebreak
\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[width=350pt]{classgko_1_1multigrid_1_1FixedCoarsening__coll__graph}
\end{center}
\end{figure}
\doxysubsubsection*{Classes}
\begin{DoxyCompactItemize}
\item 
struct \doxymbox{\hyperlink{structgko_1_1multigrid_1_1FixedCoarsening_1_1parameters__type}{parameters\+\_\+type}}
\item 
class \doxymbox{\hyperlink{classgko_1_1multigrid_1_1FixedCoarsening_1_1Factory}{Factory}}
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Types}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classgko_1_1multigrid_1_1FixedCoarsening_ab13af52f5102cc298322a7797620cb07}\label{classgko_1_1multigrid_1_1FixedCoarsening_ab13af52f5102cc298322a7797620cb07} 
using {\bfseries value\+\_\+type} = Value\+Type
\item 
\Hypertarget{classgko_1_1multigrid_1_1FixedCoarsening_a303b38702045873249cb1c87fe97e715}\label{classgko_1_1multigrid_1_1FixedCoarsening_a303b38702045873249cb1c87fe97e715} 
using {\bfseries index\+\_\+type} = Index\+Type
\end{DoxyCompactItemize}
\doxysubsection*{Public Types inherited from \doxymbox{\hyperlink{classgko_1_1EnablePolymorphicAssignment}{gko::\+\+Enable\+Polymorphic\+Assignment$<$ Fixed\+Coarsening$<$ default\+\_\+precision, int32 $>$ $>$}}}
\begin{DoxyCompactItemize}
\item 
using {\bfseries result\+\_\+type}
\end{DoxyCompactItemize}
\doxysubsection*{Public Types inherited from \doxymbox{\hyperlink{classgko_1_1multigrid_1_1EnableMultigridLevel}{gko::\+multigrid::\+\+Enable\+Multigrid\+Level$<$ default\+\_\+precision $>$}}}
\begin{DoxyCompactItemize}
\item 
using {\bfseries value\+\_\+type}
\end{DoxyCompactItemize}
\doxysubsection*{Public Types inherited from \doxymbox{\hyperlink{classgko_1_1UseComposition}{gko::\+\+Use\+Composition$<$ default\+\_\+precision $>$}}}
\begin{DoxyCompactItemize}
\item 
using {\bfseries value\+\_\+type}
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1multigrid_1_1FixedCoarsening_a7316baba83470a770156fa2109a8ff47}{get\+\_\+system\+\_\+matrix}} () const
\begin{DoxyCompactList}\small\item\em Returns the system operator (matrix) of the linear system. \end{DoxyCompactList}\item 
\Hypertarget{classgko_1_1multigrid_1_1FixedCoarsening_ace4adc6f8ab73a90841e9d478c2f1b07}\label{classgko_1_1multigrid_1_1FixedCoarsening_ace4adc6f8ab73a90841e9d478c2f1b07} 
const \doxymbox{\hyperlink{structgko_1_1multigrid_1_1FixedCoarsening_1_1parameters__type}{parameters\+\_\+type}} \& {\bfseries get\+\_\+parameters} () const
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \doxymbox{\hyperlink{classgko_1_1EnableLinOp}{gko::\+\+Enable\+Lin\+Op$<$ Fixed\+Coarsening$<$ default\+\_\+precision, int32 $>$ $>$}}}
\begin{DoxyCompactItemize}
\item 
const Fixed\+Coarsening$<$ \doxymbox{\hyperlink{namespacegko_a89637c833af7ae805802226d97cebebf}{default\+\_\+precision}}, \doxymbox{\hyperlink{namespacegko_a16bd14c10900eb804d784908d8aab5ab}{int32}} $>$ \texorpdfstring{$\ast$}{*} {\bfseries apply} (\doxymbox{\hyperlink{classgko_1_1ptr__param}{ptr\+\_\+param}}$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ b, \doxymbox{\hyperlink{classgko_1_1ptr__param}{ptr\+\_\+param}}$<$ \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ x) const
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \doxymbox{\hyperlink{classgko_1_1EnablePolymorphicAssignment}{gko::\+\+Enable\+Polymorphic\+Assignment$<$ Fixed\+Coarsening$<$ default\+\_\+precision, int32 $>$ $>$}}}
\begin{DoxyCompactItemize}
\item 
void {\bfseries convert\+\_\+to} (result\+\_\+type \texorpdfstring{$\ast$}{*}result) const override
\item 
void {\bfseries move\+\_\+to} (result\+\_\+type \texorpdfstring{$\ast$}{*}result) override
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \doxymbox{\hyperlink{classgko_1_1multigrid_1_1EnableMultigridLevel}{gko::\+multigrid::\+\+Enable\+Multigrid\+Level$<$ default\+\_\+precision $>$}}}
\begin{DoxyCompactItemize}
\item 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1multigrid_1_1EnableMultigridLevel_afe1942cb9e7ad413f14c2837cf699e96}{get\+\_\+fine\+\_\+op}} () const override
\begin{DoxyCompactList}\small\item\em Returns the operator on fine level. \end{DoxyCompactList}\item 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1multigrid_1_1EnableMultigridLevel_a660228f99b543605ccbd24f3fa0e816b}{get\+\_\+restrict\+\_\+op}} () const override
\begin{DoxyCompactList}\small\item\em Returns the restrict operator. \end{DoxyCompactList}\item 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1multigrid_1_1EnableMultigridLevel_a6be3e7352bd2b57d95717caa757fbf7c}{get\+\_\+coarse\+\_\+op}} () const override
\begin{DoxyCompactList}\small\item\em Returns the operator on coarse level. \end{DoxyCompactList}\item 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1multigrid_1_1EnableMultigridLevel_a27e2ddde81000fae9f6df287585b71a6}{get\+\_\+prolong\+\_\+op}} () const override
\begin{DoxyCompactList}\small\item\em Returns the prolong operator. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \doxymbox{\hyperlink{classgko_1_1UseComposition}{gko::\+\+Use\+Composition$<$ default\+\_\+precision $>$}}}
\begin{DoxyCompactItemize}
\item 
std::\+shared\+\_\+ptr$<$ \doxymbox{\hyperlink{classgko_1_1Composition}{Composition}}$<$ \doxymbox{\hyperlink{namespacegko_a89637c833af7ae805802226d97cebebf}{default\+\_\+precision}} $>$ $>$ \doxymbox{\hyperlink{classgko_1_1UseComposition_a81d7f1c982c43df853ed9b9074e45409}{get\+\_\+composition}} () const
\begin{DoxyCompactList}\small\item\em Returns the composition operators. \end{DoxyCompactList}\item 
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1UseComposition_a46d5ea836edce6f0c0738d0218dd394b}{get\+\_\+operator\+\_\+at}} (\doxymbox{\hyperlink{namespacegko_a9579c98b1d85bf4ad02d7cb5b96fc771}{size\+\_\+type}} index) const
\begin{DoxyCompactList}\small\item\em Returns the operator at index-\/th position of composition. \end{DoxyCompactList}\end{DoxyCompactItemize}
\doxysubsubsection*{Static Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classgko_1_1multigrid_1_1FixedCoarsening_ae77996e09caed445e61c6a0c7ed669db}\label{classgko_1_1multigrid_1_1FixedCoarsening_ae77996e09caed445e61c6a0c7ed669db} 
static auto {\bfseries build} () -\/$>$ decltype(\doxymbox{\hyperlink{classgko_1_1EnableDefaultFactory_a1d077101d9e788e6c65f088612d14cc3}{Factory::\+create}}())
\end{DoxyCompactItemize}
\doxysubsubsection*{Friends}
\begin{DoxyCompactItemize}
\item 
\Hypertarget{classgko_1_1multigrid_1_1FixedCoarsening_ab746d60625ad079f71dcd758ff87498c}\label{classgko_1_1multigrid_1_1FixedCoarsening_ab746d60625ad079f71dcd758ff87498c} 
class {\bfseries Enable\+Lin\+Op$<$ Fixed\+Coarsening $>$}
\item 
\Hypertarget{classgko_1_1multigrid_1_1FixedCoarsening_ab3c3c4668894bcab31e3201732cd9489}\label{classgko_1_1multigrid_1_1FixedCoarsening_ab3c3c4668894bcab31e3201732cd9489} 
class {\bfseries Enable\+Polymorphic\+Object$<$ Fixed\+Coarsening, Lin\+Op $>$}
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\subsubsection*{template$<$typename Value\+Type = default\+\_\+precision, typename Index\+Type = int32$>$\newline
class gko::\+multigrid::\+\+Fixed\+Coarsening$<$ Value\+Type, Index\+Type $>$}
\doxylink{classgko_1_1multigrid_1_1FixedCoarsening}{Fixed\+Coarsening} is a very simple coarse grid generation algorithm. 

It selects the coarse matrix from the fine matrix by with user-\/specified indices.

The user needs to specify the indices (with global numbering) of the fine matrix, they wish to be in the coarse matrix. The restriction and prolongation matrices will map to and from the coarse space without any interpolation or weighting.


\begin{DoxyTemplParams}{Template Parameters}
{\em Value\+Type} & precision of matrix elements \\
\hline
{\em Index\+Type} & precision of matrix indexes \\
\hline
\end{DoxyTemplParams}


\label{doc-func-members}
\Hypertarget{classgko_1_1multigrid_1_1FixedCoarsening_doc-func-members}
\doxysubsection{Member Function Documentation}
\Hypertarget{classgko_1_1multigrid_1_1FixedCoarsening_a7316baba83470a770156fa2109a8ff47}\index{gko::multigrid::FixedCoarsening$<$ ValueType, IndexType $>$@{gko::multigrid::FixedCoarsening$<$ ValueType, IndexType $>$}!get\_system\_matrix@{get\_system\_matrix}}
\index{get\_system\_matrix@{get\_system\_matrix}!gko::multigrid::FixedCoarsening$<$ ValueType, IndexType $>$@{gko::multigrid::FixedCoarsening$<$ ValueType, IndexType $>$}}
\doxysubsubsection{\texorpdfstring{get\_system\_matrix()}{get\_system\_matrix()}}
{\footnotesize\ttfamily \label{classgko_1_1multigrid_1_1FixedCoarsening_a7316baba83470a770156fa2109a8ff47} 
template$<$typename Value\+Type = default\+\_\+precision, typename Index\+Type = int32$>$ \\
std::\+shared\+\_\+ptr$<$ const \doxymbox{\hyperlink{classgko_1_1LinOp}{Lin\+Op}} $>$ \doxymbox{\hyperlink{classgko_1_1multigrid_1_1FixedCoarsening}{gko::\+multigrid::\+\+Fixed\+Coarsening}}$<$ Value\+Type, Index\+Type $>$::\+get\+\_\+system\+\_\+matrix (\begin{DoxyParamCaption}{}{}\end{DoxyParamCaption}) const\hspace{0.3cm}{\ttfamily [inline]}}



Returns the system operator (matrix) of the linear system. 

\begin{DoxyReturn}{Returns}
the system operator (matrix) 
\end{DoxyReturn}


The documentation for this class was generated from the following file:\+\begin{DoxyCompactItemize}
\item 
ginkgo/\+core/\+multigrid/\+fixed\+\_\+coarsening.\+hpp\end{DoxyCompactItemize}
