QUDA  v1.1.0
A library for QCD on GPUs
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
quda::DiracTwistedMass Class Reference

#include <dirac_quda.h>

+ Inheritance diagram for quda::DiracTwistedMass:

Public Member Functions

 DiracTwistedMass (const DiracTwistedMass &dirac)
 
 DiracTwistedMass (const DiracParam &param, const int nDim)
 
virtual ~DiracTwistedMass ()
 
DiracTwistedMassoperator= (const DiracTwistedMass &dirac)
 
void Twist (ColorSpinorField &out, const ColorSpinorField &in) const
 
virtual void M (ColorSpinorField &out, const ColorSpinorField &in) const
 Apply M for the dirac op. E.g. the Schur Complement operator. More...
 
virtual void MdagM (ColorSpinorField &out, const ColorSpinorField &in) const
 Apply MdagM operator which may be optimized. More...
 
virtual void prepare (ColorSpinorField *&src, ColorSpinorField *&sol, ColorSpinorField &x, ColorSpinorField &b, const QudaSolutionType) const
 
virtual void reconstruct (ColorSpinorField &x, const ColorSpinorField &b, const QudaSolutionType) const
 
virtual QudaDiracType getDiracType () const
 returns the Dirac type More...
 
double Mu () const
 accessor for twist parameter – overrride can return better value More...
 
void createCoarseOp (GaugeField &Y, GaugeField &X, const Transfer &T, double kappa, double mass, double mu, double mu_factor=0.) const
 Create the coarse twisted-mass operator. More...
 
- Public Member Functions inherited from quda::DiracWilson
 DiracWilson (const DiracParam &param)
 
 DiracWilson (const DiracWilson &dirac)
 
 DiracWilson (const DiracParam &param, const int nDims)
 
virtual ~DiracWilson ()
 
DiracWilsonoperator= (const DiracWilson &dirac)
 
- Public Member Functions inherited from quda::Dirac
 Dirac (const DiracParam &param)
 
 Dirac (const Dirac &dirac)
 
virtual ~Dirac ()
 
Diracoperator= (const Dirac &dirac)
 
void setCommDim (const int commDim_[QUDA_MAX_DIM]) const
 Enable / disable communications for the Dirac operator. More...
 
virtual bool isCoarse () const
 Whether the Dirac object is the DiracCoarse. More...
 
virtual void checkParitySpinor (const ColorSpinorField &, const ColorSpinorField &) const
 Check parity spinors are usable (check geometry ?) More...
 
virtual void checkFullSpinor (const ColorSpinorField &, const ColorSpinorField &) const
 check full spinors are compatible (check geometry ?) More...
 
void checkSpinorAlias (const ColorSpinorField &, const ColorSpinorField &) const
 check spinors do not alias More...
 
virtual bool hasDslash () const
 Whether or not the operator has a single-parity Dslash. More...
 
virtual void MdagMLocal (ColorSpinorField &out, const ColorSpinorField &in) const
 Apply the local MdagM operator: equivalent to applying zero Dirichlet boundary condition to MdagM on each rank. Depending on the number of stencil steps of the fermion type, this may require additional effort to include the terms that hop out of the boundary and then hop back. More...
 
virtual void Dslash4 (ColorSpinorField &out, const ColorSpinorField &in, const QudaParity parity) const
 Apply the local MdagM operator: equivalent to applying zero Dirichlet boundary condition to MdagM on each rank. Depending on the number of stencil steps of the fermion type, this may require additional effort to include the terms that hop out of the boundary and then hop back. More...
 
void Mdag (ColorSpinorField &out, const ColorSpinorField &in) const
 Apply Mdag (daggered operator of M. More...
 
void MMdag (ColorSpinorField &out, const ColorSpinorField &in) const
 Apply Normal Operator. More...
 
virtual void prepareSpecialMG (ColorSpinorField *&src, ColorSpinorField *&sol, ColorSpinorField &x, ColorSpinorField &b, const QudaSolutionType solType) const
 
virtual void reconstructSpecialMG (ColorSpinorField &x, const ColorSpinorField &b, const QudaSolutionType solType) const
 
virtual bool hasSpecialMG () const
 specifies whether or not there's a specialized prepare/reconstruct used before/after transfering to/from the coarse level in MG More...
 
void setMass (double mass)
 
double Kappa () const
 accessor for Kappa (mass parameter) More...
 
virtual double Mass () const
 accessor for Mass (in case of a factor of 2 for staggered) More...
 
virtual double MuFactor () const
 accessor for mu factoo for MG/ – override can return a better value More...
 
unsigned long long Flops () const
 returns and then zeroes flopcount More...
 
QudaMatPCType getMatPCType () const
 returns preconditioning type More...
 
int getStencilSteps () const
 I have no idea what this does. More...
 
void Dagger (QudaDagType dag) const
 sets whether operator is daggered or not More...
 
void flipDagger () const
 Flips value of daggered. More...
 
virtual bool hermitian () const
 is operator hermitian More...
 
virtual void updateFields (cudaGaugeField *gauge_in, cudaGaugeField *fat_gauge_in, cudaGaugeField *long_gauge_in, cudaCloverField *clover_in)
 Update the internal gauge, fat gauge, long gauge, clover field pointer as appropriate. These are pointers as opposed to references to support passing in nullptr. More...
 
QudaPrecision HaloPrecision () const
 
void setHaloPrecision (QudaPrecision halo_precision_) const
 
virtual void prefetch (QudaFieldLocation mem_space, qudaStream_t stream=0) const
 If managed memory and prefetch is enabled, prefetch the gauge field and temporary spinors to the CPU or GPU as requested. Overloads may also grab a clover term. More...
 
- Public Member Functions inherited from quda::Object
 Object ()
 
virtual ~Object ()
 

Protected Member Functions

void twistedApply (ColorSpinorField &out, const ColorSpinorField &in, const QudaTwistGamma5Type twistType) const
 
virtual void Dslash (ColorSpinorField &out, const ColorSpinorField &in, QudaParity parity) const
 apply 'dslash' operator for the DiracOp. This may be e.g. AD More...
 
virtual void DslashXpay (ColorSpinorField &out, const ColorSpinorField &in, QudaParity parity, const ColorSpinorField &x, const double &k) const
 Xpay version of Dslash. More...
 
- Protected Member Functions inherited from quda::DiracWilson
void initConstants ()
 
- Protected Member Functions inherited from quda::Dirac
bool newTmp (ColorSpinorField **, const ColorSpinorField &) const
 
void deleteTmp (ColorSpinorField **, const bool &reset) const
 

Protected Attributes

double mu
 
double epsilon
 
- Protected Attributes inherited from quda::Dirac
cudaGaugeFieldgauge
 
double kappa
 
double mass
 
int laplace3D
 
QudaMatPCType matpcType
 
QudaDagType dagger
 
unsigned long long flops
 
ColorSpinorFieldtmp1
 
ColorSpinorFieldtmp2
 
QudaDiracType type
 
QudaPrecision halo_precision
 
int commDim [QUDA_MAX_DIM]
 
TimeProfile profile
 

Additional Inherited Members

- Static Public Member Functions inherited from quda::Dirac
static Diraccreate (const DiracParam &param)
 Creates a subclass from parameters. More...
 
- Static Public Member Functions inherited from quda::Object
static void * operator new (std::size_t size)
 
static void operator delete (void *p)
 
static void * operator new[] (std::size_t size)
 
static void operator delete[] (void *p)
 

Detailed Description

Definition at line 946 of file dirac_quda.h.

Constructor & Destructor Documentation

◆ DiracTwistedMass() [1/2]

quda::DiracTwistedMass::DiracTwistedMass ( const DiracTwistedMass dirac)

Definition at line 15 of file dirac_twisted_mass.cpp.

◆ DiracTwistedMass() [2/2]

quda::DiracTwistedMass::DiracTwistedMass ( const DiracParam param,
const int  nDim 
)

Definition at line 8 of file dirac_twisted_mass.cpp.

◆ ~DiracTwistedMass()

quda::DiracTwistedMass::~DiracTwistedMass ( )
virtual

Definition at line 22 of file dirac_twisted_mass.cpp.

Member Function Documentation

◆ createCoarseOp()

void quda::DiracTwistedMass::createCoarseOp ( GaugeField Y,
GaugeField X,
const Transfer T,
double  kappa,
double  mass,
double  mu,
double  mu_factor = 0. 
) const
virtual

Create the coarse twisted-mass operator.

Takes the multigrid transfer class, which knows about the coarse grid blocking, as well as having prolongate and restrict member functions, and returns color matrices Y[0..2*dim-1] corresponding to the coarse grid hopping terms and X corresponding to the coarse grid "clover" term.

Parameters
T[in]Transfer operator defining the coarse grid
Y[out]Coarse link field
X[out]Coarse clover field
kappaKappa parameter for the coarse operator
massMass parameter for the coarse operator (gets explicitly built into clover, hard coded to zero for non-staggered ops)
muTM mu parameter for the coarse operator
mu_factormultiplicative factor for the mu parameter

Reimplemented from quda::DiracWilson.

Reimplemented in quda::DiracTwistedMassPC.

Definition at line 126 of file dirac_twisted_mass.cpp.

◆ Dslash()

void quda::DiracTwistedMass::Dslash ( ColorSpinorField out,
const ColorSpinorField in,
QudaParity  parity 
) const
protectedvirtual

apply 'dslash' operator for the DiracOp. This may be e.g. AD

Reimplemented from quda::DiracWilson.

Reimplemented in quda::DiracTwistedMassPC.

Definition at line 47 of file dirac_twisted_mass.cpp.

◆ DslashXpay()

void quda::DiracTwistedMass::DslashXpay ( ColorSpinorField out,
const ColorSpinorField in,
QudaParity  parity,
const ColorSpinorField x,
const double &  k 
) const
protectedvirtual

Xpay version of Dslash.

Reimplemented from quda::DiracWilson.

Reimplemented in quda::DiracTwistedMassPC.

Definition at line 62 of file dirac_twisted_mass.cpp.

◆ getDiracType()

virtual QudaDiracType quda::DiracTwistedMass::getDiracType ( ) const
inlinevirtual

returns the Dirac type

Returns
Dirac type

Reimplemented from quda::DiracWilson.

Reimplemented in quda::DiracTwistedMassPC.

Definition at line 973 of file dirac_quda.h.

◆ M()

void quda::DiracTwistedMass::M ( ColorSpinorField out,
const ColorSpinorField in 
) const
virtual

Apply M for the dirac op. E.g. the Schur Complement operator.

Reimplemented from quda::DiracWilson.

Reimplemented in quda::DiracTwistedMassPC.

Definition at line 78 of file dirac_twisted_mass.cpp.

◆ MdagM()

void quda::DiracTwistedMass::MdagM ( ColorSpinorField out,
const ColorSpinorField in 
) const
virtual

Apply MdagM operator which may be optimized.

Reimplemented from quda::DiracWilson.

Reimplemented in quda::DiracTwistedMassPC.

Definition at line 98 of file dirac_twisted_mass.cpp.

◆ Mu()

double quda::DiracTwistedMass::Mu ( ) const
inlinevirtual

accessor for twist parameter – overrride can return better value

Reimplemented from quda::Dirac.

Definition at line 975 of file dirac_quda.h.

◆ operator=()

DiracTwistedMass & quda::DiracTwistedMass::operator= ( const DiracTwistedMass dirac)

Definition at line 24 of file dirac_twisted_mass.cpp.

◆ prepare()

void quda::DiracTwistedMass::prepare ( ColorSpinorField *&  src,
ColorSpinorField *&  sol,
ColorSpinorField x,
ColorSpinorField b,
const QudaSolutionType  solType 
) const
virtual

Reimplemented from quda::DiracWilson.

Reimplemented in quda::DiracTwistedMassPC.

Definition at line 109 of file dirac_twisted_mass.cpp.

◆ reconstruct()

void quda::DiracTwistedMass::reconstruct ( ColorSpinorField x,
const ColorSpinorField b,
const QudaSolutionType  solType 
) const
virtual

Reimplemented from quda::DiracWilson.

Reimplemented in quda::DiracTwistedMassPC.

Definition at line 120 of file dirac_twisted_mass.cpp.

◆ Twist()

void quda::DiracTwistedMass::Twist ( ColorSpinorField out,
const ColorSpinorField in 
) const

Definition at line 42 of file dirac_twisted_mass.cpp.

◆ twistedApply()

void quda::DiracTwistedMass::twistedApply ( ColorSpinorField out,
const ColorSpinorField in,
const QudaTwistGamma5Type  twistType 
) const
protected

Definition at line 33 of file dirac_twisted_mass.cpp.

Member Data Documentation

◆ epsilon

double quda::DiracTwistedMass::epsilon
mutableprotected

Definition at line 950 of file dirac_quda.h.

◆ mu

double quda::DiracTwistedMass::mu
mutableprotected

Definition at line 949 of file dirac_quda.h.


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