CHROMA
Public Member Functions | List of all members
Chroma::DilutionScheme< T > Class Template Referenceabstract

Abstract dilution scheme. More...

#include <dilution_scheme.h>

Public Member Functions

virtual ~DilutionScheme ()
 Virtual destructor to help with cleanup;. More...
 
virtual int getDecayDir () const =0
 The decay direction. More...
 
virtual const Seed & getSeed () const =0
 The seed identifies this quark. More...
 
virtual int getT0 (int t0) const =0
 
virtual int getDilSize (int t0) const =0
 
virtual int getNumTimeSlices () const =0
 
virtual Real getKappa () const =0
 
virtual std::string getCfgInfo () const =0
 
virtual std::string getPropHeader (int t0, int dil) const =0
 
virtual std::string getSourceHeader (int t0, int dil) const =0
 
virtual T dilutedSource (int t0, int dil) const =0
 Return the diluted source std::vector. More...
 
virtual T dilutedSolution (int t0, int dil) const =0
 Return the solution std::vector corresponding to the diluted source. More...
 

Detailed Description

template<typename T>
class Chroma::DilutionScheme< T >

Abstract dilution scheme.

Supports creation of (abstract) dilution schemes used in stochastic sources and solutions

Definition at line 20 of file dilution_scheme.h.

Constructor & Destructor Documentation

◆ ~DilutionScheme()

template<typename T >
virtual Chroma::DilutionScheme< T >::~DilutionScheme ( )
inlinevirtual

Virtual destructor to help with cleanup;.

Definition at line 24 of file dilution_scheme.h.

Member Function Documentation

◆ dilutedSolution()

template<typename T >
virtual T Chroma::DilutionScheme< T >::dilutedSolution ( int  t0,
int  dil 
) const
pure virtual

Return the solution std::vector corresponding to the diluted source.

MAYBE THIS SHOULD BE A CONST REFERENCE?? POSSIBLY YES

Implemented in Chroma::DilutionQuarkSourceConstEnv::ConstDilutionScheme.

◆ dilutedSource()

template<typename T >
virtual T Chroma::DilutionScheme< T >::dilutedSource ( int  t0,
int  dil 
) const
pure virtual

Return the diluted source std::vector.

MAYBE THIS SHOULD BE A CONST REFERENCE?? PROBABLY NO

Implemented in Chroma::DilutionQuarkSourceConstEnv::ConstDilutionScheme.

◆ getCfgInfo()

template<typename T >
virtual std::string Chroma::DilutionScheme< T >::getCfgInfo ( ) const
pure virtual

◆ getDecayDir()

template<typename T >
virtual int Chroma::DilutionScheme< T >::getDecayDir ( ) const
pure virtual

The decay direction.

Implemented in Chroma::DilutionQuarkSourceConstEnv::ConstDilutionScheme.

◆ getDilSize()

template<typename T >
virtual int Chroma::DilutionScheme< T >::getDilSize ( int  t0) const
pure virtual

◆ getKappa()

template<typename T >
virtual Real Chroma::DilutionScheme< T >::getKappa ( ) const
pure virtual

◆ getNumTimeSlices()

template<typename T >
virtual int Chroma::DilutionScheme< T >::getNumTimeSlices ( ) const
pure virtual

◆ getPropHeader()

template<typename T >
virtual std::string Chroma::DilutionScheme< T >::getPropHeader ( int  t0,
int  dil 
) const
pure virtual

◆ getSeed()

template<typename T >
virtual const Seed& Chroma::DilutionScheme< T >::getSeed ( ) const
pure virtual

The seed identifies this quark.

Implemented in Chroma::DilutionQuarkSourceConstEnv::ConstDilutionScheme.

◆ getSourceHeader()

template<typename T >
virtual std::string Chroma::DilutionScheme< T >::getSourceHeader ( int  t0,
int  dil 
) const
pure virtual

◆ getT0()

template<typename T >
virtual int Chroma::DilutionScheme< T >::getT0 ( int  t0) const
pure virtual

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