CHROMA
Public Member Functions | Public Attributes | List of all members
Chroma::SysSolverQOPMGParams Struct Reference
Chroma Lattice Field Theory library » Support for gauge and fermion actions » Fermion action support » Inverters

Parameters for the external QDP multigrid inverter. More...

#include <syssolver_qop_mg_params.h>

Public Member Functions

 SysSolverQOPMGParams ()
 
 SysSolverQOPMGParams (XMLReader &in, const std::string &path)
 Default constructor. More...
 

Public Attributes

Real AnisoXi
 
Real AnisoNu
 
Real Kappa
 
Real KappaCrit
 
Real Mass
 
Real MassCrit
 
Real Clover
 
Real CloverT
 
Real Residual
 
int MaxIter
 
int RefreshThreshold
 
int NumGCRVecs
 
int Verbose
 
int Levels
 
multi1d< multi1d< int > > Blocking
 
multi1d< int > NumNullVecs
 
multi1d< int > NullMaxIter
 
multi1d< Real > NullResidual
 
multi1d< Real > NullConvergence
 
multi1d< int > NumExtraVecs
 
multi1d< Real > Underrelax
 
multi1d< int > NumPreHits
 
multi1d< int > NumPostHits
 
multi1d< int > CoarseNumGCRVecs
 
multi1d< int > CoarseMaxIter
 
multi1d< Real > CoarseResidual
 
bool ExternalSubspace
 
std::string SubspaceId
 
Real RsdToleranceFactor
 
bool TerminateOnFail
 

Detailed Description

Parameters for the external QDP multigrid inverter.

Definition at line 17 of file syssolver_qop_mg_params.h.

Constructor & Destructor Documentation

◆ SysSolverQOPMGParams() [1/2]

Chroma::SysSolverQOPMGParams::SysSolverQOPMGParams ( )
inline

Definition at line 19 of file syssolver_qop_mg_params.h.

◆ SysSolverQOPMGParams() [2/2]

Chroma::SysSolverQOPMGParams::SysSolverQOPMGParams ( XMLReader &  xml,
const std::string &  path 
)

Default constructor.

Read parameters

Definition at line 155 of file syssolver_qop_mg_params.cc.

References Chroma::read().

Member Data Documentation

◆ AnisoNu

Real Chroma::SysSolverQOPMGParams::AnisoNu

Lattice bare dispersion parameter (nu_s)

Definition at line 31 of file syssolver_qop_mg_params.h.

Referenced by Chroma::read().

◆ AnisoXi

Real Chroma::SysSolverQOPMGParams::AnisoXi

Lattice bare anisotropy (xi_0)

Definition at line 30 of file syssolver_qop_mg_params.h.

Referenced by Chroma::read().

◆ Blocking

multi1d< multi1d<int> > Chroma::SysSolverQOPMGParams::Blocking

Spacetime blocking of each multigrid level

Definition at line 52 of file syssolver_qop_mg_params.h.

Referenced by Chroma::read().

◆ Clover

Real Chroma::SysSolverQOPMGParams::Clover

Spatial clover parameter

Definition at line 36 of file syssolver_qop_mg_params.h.

Referenced by Chroma::read().

◆ CloverT

Real Chroma::SysSolverQOPMGParams::CloverT

Temporal clover parameter

Definition at line 37 of file syssolver_qop_mg_params.h.

◆ CoarseMaxIter

multi1d<int> Chroma::SysSolverQOPMGParams::CoarseMaxIter

Coarse-level maximum number of iterations

Definition at line 68 of file syssolver_qop_mg_params.h.

◆ CoarseNumGCRVecs

multi1d<int> Chroma::SysSolverQOPMGParams::CoarseNumGCRVecs

Number of GCR vectors in coarse solver

Definition at line 66 of file syssolver_qop_mg_params.h.

◆ CoarseResidual

multi1d<Real> Chroma::SysSolverQOPMGParams::CoarseResidual

Coarse-level relative stopping residual

Definition at line 69 of file syssolver_qop_mg_params.h.

◆ ExternalSubspace

bool Chroma::SysSolverQOPMGParams::ExternalSubspace

Load an MG Subspace from Named Object Store

Definition at line 72 of file syssolver_qop_mg_params.h.

Referenced by Chroma::read(), and Chroma::write().

◆ Kappa

Real Chroma::SysSolverQOPMGParams::Kappa

Hopping parameter to solve

Definition at line 32 of file syssolver_qop_mg_params.h.

Referenced by Chroma::read().

◆ KappaCrit

Real Chroma::SysSolverQOPMGParams::KappaCrit

Critical hopping parameter (for null vectors)

Definition at line 33 of file syssolver_qop_mg_params.h.

Referenced by Chroma::read().

◆ Levels

int Chroma::SysSolverQOPMGParams::Levels

Number of levels in multigrid If Levels is specified to be nonpositive, the same multigrid setup previously created will be reused by this inversion. If Levels is negative, the multigrid structure will be deleted following the inversion.

Definition at line 47 of file syssolver_qop_mg_params.h.

Referenced by Chroma::read(), and Chroma::write().

◆ Mass

Real Chroma::SysSolverQOPMGParams::Mass

Bare mass of fermion (sets kappa)

Definition at line 34 of file syssolver_qop_mg_params.h.

Referenced by Chroma::MdagMSysSolverQOPMG::operator()(), and Chroma::read().

◆ MassCrit

Real Chroma::SysSolverQOPMGParams::MassCrit

Bare critical mass (sets kappac)

Definition at line 35 of file syssolver_qop_mg_params.h.

Referenced by Chroma::read().

◆ MaxIter

int Chroma::SysSolverQOPMGParams::MaxIter

Maximum number of iterations to allow in solver

Definition at line 40 of file syssolver_qop_mg_params.h.

Referenced by Chroma::read(), and Chroma::MGMdagMInternal::remapParams().

◆ NullConvergence

multi1d<Real> Chroma::SysSolverQOPMGParams::NullConvergence

Convergence criterion This indicates the level at which a std::vector is considered to have converged. That is, if it changes less than this amount during the relaxation, a new random std::vector will be generated for further nullvecs.

Definition at line 57 of file syssolver_qop_mg_params.h.

◆ NullMaxIter

multi1d<int> Chroma::SysSolverQOPMGParams::NullMaxIter

Maximum iterations for setup on each std::vector

Definition at line 55 of file syssolver_qop_mg_params.h.

◆ NullResidual

multi1d<Real> Chroma::SysSolverQOPMGParams::NullResidual

Residual to converge each std::vector

Definition at line 56 of file syssolver_qop_mg_params.h.

◆ NumExtraVecs

multi1d<int> Chroma::SysSolverQOPMGParams::NumExtraVecs

Number of extra vectors to generate and discard

Definition at line 61 of file syssolver_qop_mg_params.h.

◆ NumGCRVecs

int Chroma::SysSolverQOPMGParams::NumGCRVecs

Number of GCR vectors at top level

Definition at line 43 of file syssolver_qop_mg_params.h.

◆ NumNullVecs

multi1d<int> Chroma::SysSolverQOPMGParams::NumNullVecs

Number of null vectors per multigrid level

Definition at line 53 of file syssolver_qop_mg_params.h.

◆ NumPostHits

multi1d<int> Chroma::SysSolverQOPMGParams::NumPostHits

Number of smoother post-hits per V-cycle

Definition at line 65 of file syssolver_qop_mg_params.h.

◆ NumPreHits

multi1d<int> Chroma::SysSolverQOPMGParams::NumPreHits

Number of smoother pre-hits per V-cycle

Definition at line 64 of file syssolver_qop_mg_params.h.

◆ RefreshThreshold

int Chroma::SysSolverQOPMGParams::RefreshThreshold

If this number of iterations is reached in an MdagM solver, the space will be refreshed

Definition at line 41 of file syssolver_qop_mg_params.h.

Referenced by Chroma::MdagMSysSolverQOPMG::operator()().

◆ Residual

Real Chroma::SysSolverQOPMGParams::Residual

Stopping residual for solver

Definition at line 39 of file syssolver_qop_mg_params.h.

Referenced by Chroma::MdagMSysSolverQOPMG::operator()().

◆ RsdToleranceFactor

Real Chroma::SysSolverQOPMGParams::RsdToleranceFactor

Slack in tolerance we are willing to accept – e.g. a factor of 10, or 20% or somesuch

Definition at line 74 of file syssolver_qop_mg_params.h.

Referenced by Chroma::MdagMSysSolverQOPMG::operator()().

◆ SubspaceId

std::string Chroma::SysSolverQOPMGParams::SubspaceId

The ID of the subspace to load/save

Definition at line 73 of file syssolver_qop_mg_params.h.

Referenced by Chroma::MdagMSysSolverQOPMG::operator()(), and Chroma::read().

◆ TerminateOnFail

bool Chroma::SysSolverQOPMGParams::TerminateOnFail

If true, the solver will terminate the program if MaxIters is reached and RsdTarget is not met

Definition at line 75 of file syssolver_qop_mg_params.h.

Referenced by Chroma::MdagMSysSolverQOPMG::operator()(), and Chroma::MGMdagMInternal::remapParams().

◆ Underrelax

multi1d<Real> Chroma::SysSolverQOPMGParams::Underrelax

Underrelaxation for each V-cycle

Definition at line 63 of file syssolver_qop_mg_params.h.

◆ Verbose

int Chroma::SysSolverQOPMGParams::Verbose

Level of diagnostic verbosity

Definition at line 45 of file syssolver_qop_mg_params.h.

The documentation for this struct was generated from the following files:
Generated by doxygen 1.9.1