#include <Aggregates.h>

Public Types
typedef iVector< CComplex, nbasis >	siteVector
typedef Lattice< siteVector >	CoarseVector
typedef Lattice< iMatrix< CComplex, nbasis > >	CoarseMatrix
typedef Lattice< CComplex >	CoarseScalar
typedef Lattice< Fobj >	FineField

Public Member Functions
constexpr int	Nbasis (void)
int	Checkerboard (void)
	Aggregation (GridBase _CoarseGrid, GridBase _FineGrid, int _checkerboard)
void	Orthogonalise (void)
void	ProjectToSubspace (CoarseVector &CoarseVec, const FineField &FineVec)
void	PromoteFromSubspace (const CoarseVector &CoarseVec, FineField &FineVec)
virtual void	CreateSubspaceRandom (GridParallelRNG &RNG)
virtual void	CreateSubspace (GridParallelRNG &RNG, LinearOperatorBase< FineField > &hermop, int nn=nbasis)
virtual void	CreateSubspaceGCR (GridParallelRNG &RNG, LinearOperatorBase< FineField > &DiracOp, int nn=nbasis)
virtual void	CreateSubspaceChebyshev (GridParallelRNG &RNG, LinearOperatorBase< FineField > &hermop, int nn, double hi, double lo, int orderfilter, int ordermin, int orderstep, double filterlo)
virtual void	CreateSubspacePolyCheby (GridParallelRNG &RNG, LinearOperatorBase< FineField > &hermop, int nn, double hi, double lo1, int orderfilter, double lo2, int orderstep)
virtual void	CreateSubspaceChebyshev (GridParallelRNG &RNG, LinearOperatorBase< FineField > &hermop, int nn, double hi, double lo, int orderfilter)
virtual void	CreateSubspaceChebyshevPowerLaw (GridParallelRNG &RNG, LinearOperatorBase< FineField > &hermop, int nn, double hi, int orderfilter)
virtual void	CreateSubspaceChebyshevNew (GridParallelRNG &RNG, LinearOperatorBase< FineField > &hermop, double hi)
virtual void	CreateSubspaceMultishift (GridParallelRNG &RNG, LinearOperatorBase< FineField > &hermop, double Lo, double tol, int maxit)
virtual void	RefineSubspace (LinearOperatorBase< FineField > &hermop, double Lo, double tol, int maxit)
virtual void	RefineSubspaceHDCG (LinearOperatorBase< FineField > &hermop, TwoLevelADEF2mrhs< FineField, CoarseVector > &theHDCG, int nrhs)

Data Fields
GridBase *	CoarseGrid
GridBase *	FineGrid
std::vector< Lattice< Fobj > >	subspace
int	checkerboard

Detailed Description

template<class Fobj, class CComplex, int nbasis>
class Aggregation< Fobj, CComplex, nbasis >

Definition at line 45 of file Aggregates.h.

Member Typedef Documentation

◆ siteVector

template<class Fobj, class CComplex, int nbasis>

typedef iVector<CComplex,nbasis > Aggregation< Fobj, CComplex, nbasis >::siteVector

Definition at line 49 of file Aggregates.h.

◆ CoarseVector

template<class Fobj, class CComplex, int nbasis>

typedef Lattice<siteVector> Aggregation< Fobj, CComplex, nbasis >::CoarseVector

Definition at line 50 of file Aggregates.h.

◆ CoarseMatrix

template<class Fobj, class CComplex, int nbasis>

typedef Lattice<iMatrix<CComplex,nbasis > > Aggregation< Fobj, CComplex, nbasis >::CoarseMatrix

Definition at line 51 of file Aggregates.h.

◆ CoarseScalar

template<class Fobj, class CComplex, int nbasis>

typedef Lattice< CComplex > Aggregation< Fobj, CComplex, nbasis >::CoarseScalar

Definition at line 53 of file Aggregates.h.

◆ FineField

template<class Fobj, class CComplex, int nbasis>

typedef Lattice<Fobj > Aggregation< Fobj, CComplex, nbasis >::FineField

Definition at line 54 of file Aggregates.h.

Constructor & Destructor Documentation

◆ Aggregation()

template<class Fobj, class CComplex, int nbasis>

Aggregation< Fobj, CComplex, nbasis >::Aggregation	(	GridBase *	_CoarseGrid,
		GridBase *	_FineGrid,
		int	_checkerboard )

inline

Definition at line 61 of file Aggregates.h.

References checkerboard, CoarseGrid, FineGrid, and subspace.

Member Function Documentation

◆ Nbasis()

template<class Fobj, class CComplex, int nbasis>

int Aggregation< Fobj, CComplex, nbasis >::Nbasis ( void )

inlineconstexpr

Definition at line 47 of file Aggregates.h.

◆ Checkerboard()

template<class Fobj, class CComplex, int nbasis>

int Aggregation< Fobj, CComplex, nbasis >::Checkerboard ( void )

inline

Definition at line 60 of file Aggregates.h.

References checkerboard.

◆ Orthogonalise()

template<class Fobj, class CComplex, int nbasis>

void Aggregation< Fobj, CComplex, nbasis >::Orthogonalise ( void )

inline

Definition at line 70 of file Aggregates.h.

References blockOrthogonalise(), CoarseGrid, and subspace.

◆ ProjectToSubspace()

template<class Fobj, class CComplex, int nbasis>

void Aggregation< Fobj, CComplex, nbasis >::ProjectToSubspace	(	CoarseVector &	CoarseVec,
		const FineField &	FineVec )

inline

Definition at line 75 of file Aggregates.h.

References blockProject(), and subspace.

Referenced by TwoLevelADEF2< Field, CoarseField, Aggregation >::PcgM1(), and TwoLevelADEF2< Field, CoarseField, Aggregation >::Vstart().

◆ PromoteFromSubspace()

template<class Fobj, class CComplex, int nbasis>

void Aggregation< Fobj, CComplex, nbasis >::PromoteFromSubspace	(	const CoarseVector &	CoarseVec,
		FineField &	FineVec )

inline

Definition at line 78 of file Aggregates.h.

References blockPromote(), LatticeAccelerator< vobj >::Checkerboard(), and subspace.

Referenced by TwoLevelADEF2< Field, CoarseField, Aggregation >::PcgM1(), and TwoLevelADEF2< Field, CoarseField, Aggregation >::Vstart().

◆ CreateSubspaceRandom()

template<class Fobj, class CComplex, int nbasis>

virtual void Aggregation< Fobj, CComplex, nbasis >::CreateSubspaceRandom ( GridParallelRNG & RNG )

inlinevirtual

Definition at line 83 of file Aggregates.h.

References FineGrid, gaussian(), norm2(), and subspace.

◆ CreateSubspace()

template<class Fobj, class CComplex, int nbasis>

virtual void Aggregation< Fobj, CComplex, nbasis >::CreateSubspace	(	GridParallelRNG &	RNG,
		LinearOperatorBase< FineField > &	hermop,
		int	nn = nbasis )

inlinevirtual

Definition at line 95 of file Aggregates.h.

References FineGrid, gaussian(), GridLogMessage, norm2(), LinearOperatorBase< Field >::Op(), and subspace.

◆ CreateSubspaceGCR()

template<class Fobj, class CComplex, int nbasis>

virtual void Aggregation< Fobj, CComplex, nbasis >::CreateSubspaceGCR	(	GridParallelRNG &	RNG,
		LinearOperatorBase< FineField > &	DiracOp,
		int	nn = nbasis )

inlinevirtual

Definition at line 129 of file Aggregates.h.

References FineGrid, gaussian(), GridLogMessage, innerProduct(), norm2(), LinearOperatorBase< Field >::Op(), and subspace.

◆ CreateSubspaceChebyshev() [1/2]

template<class Fobj, class CComplex, int nbasis>

virtual void Aggregation< Fobj, CComplex, nbasis >::CreateSubspaceChebyshev	(	GridParallelRNG &	RNG,
		LinearOperatorBase< FineField > &	hermop,
		int	nn,
		double	hi,
		double	lo,
		int	orderfilter,
		int	ordermin,
		int	orderstep,
		double	filterlo )

inlinevirtual

Definition at line 181 of file Aggregates.h.

References accelerator_for, AcceleratorWrite, LinearOperatorBase< Field >::AdjOp(), autoView, FineGrid, gaussian(), GridLogMessage, LinearOperatorBase< Field >::HermOp(), innerProduct(), norm2(), LinearOperatorBase< Field >::Op(), subspace, T0, T1, and T2.

◆ CreateSubspacePolyCheby()

template<class Fobj, class CComplex, int nbasis>

virtual void Aggregation< Fobj, CComplex, nbasis >::CreateSubspacePolyCheby	(	GridParallelRNG &	RNG,
		LinearOperatorBase< FineField > &	hermop,
		int	nn,
		double	hi,
		double	lo1,
		int	orderfilter,
		double	lo2,
		int	orderstep )

inlinevirtual

Definition at line 299 of file Aggregates.h.

References FineGrid, gaussian(), GridLogMessage, innerProduct(), norm2(), LinearOperatorBase< Field >::Op(), and subspace.

◆ CreateSubspaceChebyshev() [2/2]

template<class Fobj, class CComplex, int nbasis>

virtual void Aggregation< Fobj, CComplex, nbasis >::CreateSubspaceChebyshev	(	GridParallelRNG &	RNG,
		LinearOperatorBase< FineField > &	hermop,
		int	nn,
		double	hi,
		double	lo,
		int	orderfilter )

inlinevirtual

Definition at line 361 of file Aggregates.h.

References AggregatePowerLaw(), FineGrid, gaussian(), GridLogMessage, norm2(), LinearOperatorBase< Field >::Op(), and subspace.

◆ CreateSubspaceChebyshevPowerLaw()

template<class Fobj, class CComplex, int nbasis>

virtual void Aggregation< Fobj, CComplex, nbasis >::CreateSubspaceChebyshevPowerLaw	(	GridParallelRNG &	RNG,
		LinearOperatorBase< FineField > &	hermop,
		int	nn,
		double	hi,
		int	orderfilter )

inlinevirtual

Definition at line 408 of file Aggregates.h.

References AggregatePowerLaw(), FineGrid, gaussian(), GridLogMessage, norm2(), LinearOperatorBase< Field >::Op(), and subspace.

◆ CreateSubspaceChebyshevNew()

template<class Fobj, class CComplex, int nbasis>

virtual void Aggregation< Fobj, CComplex, nbasis >::CreateSubspaceChebyshevNew	(	GridParallelRNG &	RNG,
		LinearOperatorBase< FineField > &	hermop,
		double	hi )

inlinevirtual

Definition at line 444 of file Aggregates.h.

References FineGrid, gaussian(), GridLogMessage, norm2(), LinearOperatorBase< Field >::Op(), and subspace.

◆ CreateSubspaceMultishift()

template<class Fobj, class CComplex, int nbasis>

virtual void Aggregation< Fobj, CComplex, nbasis >::CreateSubspaceMultishift	(	GridParallelRNG &	RNG,
		LinearOperatorBase< FineField > &	hermop,
		double	Lo,
		double	tol,
		int	maxit )

inlinevirtual

Definition at line 504 of file Aggregates.h.

References FineGrid, gaussian(), GridLogMessage, MultiShiftFunction::norm, norm2(), LinearOperatorBase< Field >::Op(), MultiShiftFunction::order, MultiShiftFunction::poles, MultiShiftFunction::residues, subspace, and MultiShiftFunction::tolerances.

◆ RefineSubspace()

template<class Fobj, class CComplex, int nbasis>

virtual void Aggregation< Fobj, CComplex, nbasis >::RefineSubspace	(	LinearOperatorBase< FineField > &	hermop,
		double	Lo,
		double	tol,
		int	maxit )

inlinevirtual

Definition at line 555 of file Aggregates.h.

References FineGrid, GridLogMessage, norm2(), LinearOperatorBase< Field >::Op(), and subspace.

◆ RefineSubspaceHDCG()

template<class Fobj, class CComplex, int nbasis>

virtual void Aggregation< Fobj, CComplex, nbasis >::RefineSubspaceHDCG	(	LinearOperatorBase< FineField > &	hermop,
		TwoLevelADEF2mrhs< FineField, CoarseVector > &	theHDCG,
		int	nrhs )

inlinevirtual

Definition at line 571 of file Aggregates.h.

References FineGrid, GridLogMessage, MIN, norm2(), LinearOperatorBase< Field >::Op(), and subspace.

Field Documentation

◆ CoarseGrid

template<class Fobj, class CComplex, int nbasis>

GridBase* Aggregation< Fobj, CComplex, nbasis >::CoarseGrid

Definition at line 56 of file Aggregates.h.

Referenced by Aggregation(), Orthogonalise(), and TwoLevelADEF2< Field, CoarseField, Aggregation >::TwoLevelADEF2().

◆ FineGrid

template<class Fobj, class CComplex, int nbasis>

GridBase* Aggregation< Fobj, CComplex, nbasis >::FineGrid

Definition at line 57 of file Aggregates.h.

Referenced by Aggregation(), MultiGeneralCoarsenedMatrix< Fobj, CComplex, nbasis >::CoarsenOperator(), CreateSubspace(), CreateSubspaceChebyshev(), CreateSubspaceChebyshev(), CreateSubspaceChebyshevNew(), CreateSubspaceChebyshevPowerLaw(), CreateSubspaceGCR(), CreateSubspaceMultishift(), CreateSubspacePolyCheby(), CreateSubspaceRandom(), RefineSubspace(), and RefineSubspaceHDCG().

◆ subspace

template<class Fobj, class CComplex, int nbasis>

std::vector<Lattice<Fobj> > Aggregation< Fobj, CComplex, nbasis >::subspace

◆ checkerboard

template<class Fobj, class CComplex, int nbasis>

int Aggregation< Fobj, CComplex, nbasis >::checkerboard

Definition at line 59 of file Aggregates.h.

Referenced by Aggregation(), and Checkerboard().

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

Grid/algorithms/multigrid/Aggregates.h

Public Types

Public Member Functions

Data Fields

Detailed Description

Member Typedef Documentation

◆ siteVector

◆ CoarseVector

◆ CoarseMatrix

◆ CoarseScalar

◆ FineField

Constructor & Destructor Documentation

◆ Aggregation()

Member Function Documentation

◆ Nbasis()

◆ Checkerboard()

◆ Orthogonalise()

◆ ProjectToSubspace()

◆ PromoteFromSubspace()

◆ CreateSubspaceRandom()

◆ CreateSubspace()

◆ CreateSubspaceGCR()

◆ CreateSubspaceChebyshev() [1/2]

◆ CreateSubspacePolyCheby()

◆ CreateSubspaceChebyshev() [2/2]

◆ CreateSubspaceChebyshevPowerLaw()

◆ CreateSubspaceChebyshevNew()

◆ CreateSubspaceMultishift()

◆ RefineSubspace()

◆ RefineSubspaceHDCG()

Field Documentation

◆ CoarseGrid

◆ FineGrid

◆ subspace

◆ checkerboard