Grid 0.7.0
Grid::SchurRedBlackBase< Field > Class Template Referenceabstract

#include <SchurRedBlack.h>

Inheritance diagram for Grid::SchurRedBlackBase< Field >:
Grid::NonHermitianSchurRedBlackDiagMooeeSolve< Field > Grid::NonHermitianSchurRedBlackDiagTwoSolve< Field > Grid::SchurRedBlackDiagMooeeSolve< Field > Grid::SchurRedBlackDiagOneSolve< Field > Grid::SchurRedBlackDiagTwoSolve< Field > Grid::SchurRedBlackStaggeredSolve< Field >

Public Member Functions

 SchurRedBlackBase (OperatorFunction< Field > &HermitianRBSolver, const bool initSubGuess=false, const bool _solnAsInitGuess=false)
void subtractGuess (const bool initSubGuess)
bool isSubtractGuess (void)
void operator() (Matrix &_Matrix, const Field &in, Field &out)
void operator() (Matrix &_Matrix, const std::vector< Field > &in, std::vector< Field > &out)
void RedBlackSource (Matrix &_Matrix, const std::vector< Field > &in, std::vector< Field > &src_o)
void RedBlackSolution (Matrix &_Matrix, const std::vector< Field > &in, const std::vector< Field > &sol_o, std::vector< Field > &out)
template<class Guesser>
void operator() (Matrix &_Matrix, const std::vector< Field > &in, std::vector< Field > &out, Guesser &guess)
template<class Guesser>
void operator() (Matrix &_Matrix, const Field &in, Field &out, Guesser &guess)
virtual void RedBlackSource (Matrix &_Matrix, const Field &src, Field &src_e, Field &src_o)=0
virtual void RedBlackSolution (Matrix &_Matrix, const Field &sol_o, const Field &src_e, Field &sol)=0
virtual void RedBlackSolve (Matrix &_Matrix, const Field &src_o, Field &sol_o)=0
virtual void RedBlackSolve (Matrix &_Matrix, const std::vector< Field > &src_o, std::vector< Field > &sol_o)=0

Protected Types

typedef CheckerBoardedSparseMatrixBase< Field > Matrix

Protected Attributes

OperatorFunction< Field > & _HermitianRBSolver
int CBfactorise
bool subGuess
bool useSolnAsInitGuess

Detailed Description

template<class Field>
class Grid::SchurRedBlackBase< Field >

Definition at line 96 of file SchurRedBlack.h.

Member Typedef Documentation

◆ Matrix

template<class Field>
typedef CheckerBoardedSparseMatrixBase<Field> Grid::SchurRedBlackBase< Field >::Matrix
protected

Definition at line 98 of file SchurRedBlack.h.

Constructor & Destructor Documentation

◆ SchurRedBlackBase()

template<class Field>
Grid::SchurRedBlackBase< Field >::SchurRedBlackBase ( OperatorFunction< Field > & HermitianRBSolver,
const bool initSubGuess = false,
const bool _solnAsInitGuess = false )
inline

Definition at line 105 of file SchurRedBlack.h.

References _HermitianRBSolver, CBfactorise, subtractGuess(), and useSolnAsInitGuess.

Referenced by Grid::NonHermitianSchurRedBlackDiagMooeeSolve< Field >::NonHermitianSchurRedBlackDiagMooeeSolve(), Grid::NonHermitianSchurRedBlackDiagTwoSolve< Field >::NonHermitianSchurRedBlackDiagTwoSolve(), Grid::SchurRedBlackDiagMooeeSolve< Field >::SchurRedBlackDiagMooeeSolve(), Grid::SchurRedBlackDiagOneSolve< Field >::SchurRedBlackDiagOneSolve(), Grid::SchurRedBlackDiagTwoSolve< Field >::SchurRedBlackDiagTwoSolve(), and Grid::SchurRedBlackStaggeredSolve< Field >::SchurRedBlackStaggeredSolve().

Member Function Documentation

◆ subtractGuess()

template<class Field>
void Grid::SchurRedBlackBase< Field >::subtractGuess ( const bool initSubGuess)
inline

Definition at line 113 of file SchurRedBlack.h.

References subGuess.

Referenced by SchurRedBlackBase().

◆ isSubtractGuess()

template<class Field>
bool Grid::SchurRedBlackBase< Field >::isSubtractGuess ( void )
inline

Definition at line 117 of file SchurRedBlack.h.

References subGuess.

◆ operator()() [1/4]

template<class Field>
void Grid::SchurRedBlackBase< Field >::operator() ( Matrix & _Matrix,
const Field & in,
Field & out )
inline

Definition at line 125 of file SchurRedBlack.h.

◆ operator()() [2/4]

template<class Field>
void Grid::SchurRedBlackBase< Field >::operator() ( Matrix & _Matrix,
const std::vector< Field > & in,
std::vector< Field > & out )
inline

Definition at line 129 of file SchurRedBlack.h.

◆ RedBlackSource() [1/2]

template<class Field>
void Grid::SchurRedBlackBase< Field >::RedBlackSource ( Matrix & _Matrix,
const std::vector< Field > & in,
std::vector< Field > & src_o )
inline

Definition at line 135 of file SchurRedBlack.h.

References CheckerBoardedSparseMatrixBase< Field >::RedBlackGrid(), and RedBlackSource().

Referenced by operator()(), operator()(), and RedBlackSource().

◆ RedBlackSolution() [1/2]

template<class Field>
void Grid::SchurRedBlackBase< Field >::RedBlackSolution ( Matrix & _Matrix,
const std::vector< Field > & in,
const std::vector< Field > & sol_o,
std::vector< Field > & out )
inline

Definition at line 149 of file SchurRedBlack.h.

References Even, pickCheckerboard(), CheckerBoardedSparseMatrixBase< Field >::RedBlackGrid(), and RedBlackSolution().

Referenced by operator()(), operator()(), and RedBlackSolution().

◆ operator()() [3/4]

template<class Field>
template<class Guesser>
void Grid::SchurRedBlackBase< Field >::operator() ( Matrix & _Matrix,
const std::vector< Field > & in,
std::vector< Field > & out,
Guesser & guess )
inline

Definition at line 161 of file SchurRedBlack.h.

References Even, SparseMatrixBase< Field >::Grid(), GridLogMessage, SparseMatrixBase< Field >::M(), norm2(), Odd, pickCheckerboard(), CheckerBoardedSparseMatrixBase< Field >::RedBlackGrid(), RedBlackSolution(), RedBlackSolve(), RedBlackSource(), subGuess, and useSolnAsInitGuess.

◆ operator()() [4/4]

template<class Field>
template<class Guesser>
void Grid::SchurRedBlackBase< Field >::operator() ( Matrix & _Matrix,
const Field & in,
Field & out,
Guesser & guess )
inline

Definition at line 236 of file SchurRedBlack.h.

References SparseMatrixBase< Field >::Grid(), GridLogMessage, SparseMatrixBase< Field >::M(), norm2(), Odd, pickCheckerboard(), CheckerBoardedSparseMatrixBase< Field >::RedBlackGrid(), RedBlackSolution(), RedBlackSolve(), RedBlackSource(), subGuess, and useSolnAsInitGuess.

◆ RedBlackSource() [2/2]

template<class Field>
virtual void Grid::SchurRedBlackBase< Field >::RedBlackSource ( Matrix & _Matrix,
const Field & src,
Field & src_e,
Field & src_o )
pure virtual

Implemented in Grid::NonHermitianSchurRedBlackDiagMooeeSolve< Field >, Grid::NonHermitianSchurRedBlackDiagTwoSolve< Field >, Grid::SchurRedBlackDiagMooeeSolve< Field >, Grid::SchurRedBlackDiagOneSolve< Field >, Grid::SchurRedBlackDiagTwoSolve< Field >, and Grid::SchurRedBlackStaggeredSolve< Field >.

◆ RedBlackSolution() [2/2]

template<class Field>
virtual void Grid::SchurRedBlackBase< Field >::RedBlackSolution ( Matrix & _Matrix,
const Field & sol_o,
const Field & src_e,
Field & sol )
pure virtual

Implemented in Grid::NonHermitianSchurRedBlackDiagMooeeSolve< Field >, Grid::NonHermitianSchurRedBlackDiagTwoSolve< Field >, Grid::SchurRedBlackDiagMooeeSolve< Field >, Grid::SchurRedBlackDiagOneSolve< Field >, Grid::SchurRedBlackDiagTwoSolve< Field >, and Grid::SchurRedBlackStaggeredSolve< Field >.

◆ RedBlackSolve() [1/2]

template<class Field>
virtual void Grid::SchurRedBlackBase< Field >::RedBlackSolve ( Matrix & _Matrix,
const Field & src_o,
Field & sol_o )
pure virtual

Implemented in Grid::NonHermitianSchurRedBlackDiagMooeeSolve< Field >, Grid::NonHermitianSchurRedBlackDiagTwoSolve< Field >, Grid::SchurRedBlackDiagMooeeSolve< Field >, Grid::SchurRedBlackDiagOneSolve< Field >, Grid::SchurRedBlackDiagTwoSolve< Field >, and Grid::SchurRedBlackStaggeredSolve< Field >.

Referenced by operator()(), and operator()().

◆ RedBlackSolve() [2/2]

template<class Field>
virtual void Grid::SchurRedBlackBase< Field >::RedBlackSolve ( Matrix & _Matrix,
const std::vector< Field > & src_o,
std::vector< Field > & sol_o )
pure virtual

Implemented in Grid::NonHermitianSchurRedBlackDiagMooeeSolve< Field >, Grid::NonHermitianSchurRedBlackDiagTwoSolve< Field >, Grid::SchurRedBlackDiagMooeeSolve< Field >, Grid::SchurRedBlackDiagOneSolve< Field >, Grid::SchurRedBlackDiagTwoSolve< Field >, and Grid::SchurRedBlackStaggeredSolve< Field >.

Field Documentation

◆ _HermitianRBSolver

template<class Field>
OperatorFunction<Field>& Grid::SchurRedBlackBase< Field >::_HermitianRBSolver
protected

Definition at line 99 of file SchurRedBlack.h.

Referenced by Grid::NonHermitianSchurRedBlackDiagMooeeSolve< Field >::RedBlackSolve(), Grid::NonHermitianSchurRedBlackDiagMooeeSolve< Field >::RedBlackSolve(), Grid::NonHermitianSchurRedBlackDiagTwoSolve< Field >::RedBlackSolve(), Grid::NonHermitianSchurRedBlackDiagTwoSolve< Field >::RedBlackSolve(), Grid::SchurRedBlackDiagMooeeSolve< Field >::RedBlackSolve(), Grid::SchurRedBlackDiagMooeeSolve< Field >::RedBlackSolve(), Grid::SchurRedBlackDiagOneSolve< Field >::RedBlackSolve(), Grid::SchurRedBlackDiagOneSolve< Field >::RedBlackSolve(), Grid::SchurRedBlackDiagTwoSolve< Field >::RedBlackSolve(), Grid::SchurRedBlackDiagTwoSolve< Field >::RedBlackSolve(), Grid::SchurRedBlackStaggeredSolve< Field >::RedBlackSolve(), Grid::SchurRedBlackStaggeredSolve< Field >::RedBlackSolve(), and SchurRedBlackBase().

◆ CBfactorise

template<class Field>
int Grid::SchurRedBlackBase< Field >::CBfactorise
protected

Definition at line 100 of file SchurRedBlack.h.

Referenced by SchurRedBlackBase().

◆ subGuess

template<class Field>
bool Grid::SchurRedBlackBase< Field >::subGuess
protected

Definition at line 101 of file SchurRedBlack.h.

Referenced by isSubtractGuess(), operator()(), operator()(), and subtractGuess().

◆ useSolnAsInitGuess

template<class Field>
bool Grid::SchurRedBlackBase< Field >::useSolnAsInitGuess
protected

Definition at line 102 of file SchurRedBlack.h.

Referenced by operator()(), operator()(), and SchurRedBlackBase().

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