CHROMA: Chroma::EigenConnectState Class Reference

CHROMA

Eigen-state holder. More...

#include <eigen_state.h>

Inheritance diagram for Chroma::EigenConnectState:

Public Types
typedef LatticeFermion	T

typedef multi1d< LatticeColorMatrix >	P

typedef multi1d< LatticeColorMatrix >	Q

Public Member Functions
	EigenConnectState (Handle< FermBC< T, P, Q > > fbc_, const multi1d< LatticeColorMatrix > &u_)
	Main constructor. More...

	EigenConnectState (Handle< FermBC< T, P, Q > > fbc_, const multi1d< LatticeColorMatrix > &u_, std::string eigen_info_id_)

	~EigenConnectState ()

const multi1d< LatticeColorMatrix > &	getLinks () const
	Return the coordinates (link fields) needed in constructing linear operators. More...

multi1d< Real > &	getEvalues ()
	Return the eigenvalues. More...

const multi1d< Real > &	getEvalues () const
	Return the eigenvalues. More...

multi1d< LatticeFermion > &	getEvectors ()

const multi1d< LatticeFermion > &	getEvectors () const

Real &	getLargest ()

const Real &	getLargest () const

int	getNEig () const

const FermBC< T, P, Q > &	getBC () const
	Return the ferm BC object for this state. More...

Handle< FermBC< T, P, Q > >	getFermBC () const
	Return the gauge BC object for this state. More...

Public Member Functions inherited from Chroma::FermState< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >
virtual	~FermState ()
	Virtual destructor to help with cleanup;. More...

Public Member Functions inherited from Chroma::ConnectState< P, Q >
virtual	~ConnectState ()
	Virtual destructor to help with cleanup;. More...

virtual void	deriv (P &F) const

Protected Member Functions
	EigenConnectState ()
	Hide default constructor. More...

void	operator= (const EigenConnectState &)

Private Attributes
Handle< FermBC< T, P, Q > >	fbc

multi1d< LatticeColorMatrix >	u

std::string	eigen_info_id

int	Neig

multi1d< LatticeFermion >	dummy_evecs

multi1d< Real >	dummy_evals

Detailed Description

Eigen-state holder.

Definition at line 20 of file eigen_state.h.

Member Typedef Documentation

◆ P

typedef multi1d<LatticeColorMatrix> Chroma::EigenConnectState::P

Definition at line 27 of file eigen_state.h.

◆ Q

typedef multi1d<LatticeColorMatrix> Chroma::EigenConnectState::Q

Definition at line 28 of file eigen_state.h.

◆ T

typedef LatticeFermion Chroma::EigenConnectState::T

Definition at line 26 of file eigen_state.h.

Constructor & Destructor Documentation

◆ EigenConnectState() [1/3]

Chroma::EigenConnectState::EigenConnectState	(	Handle< FermBC< T, P, Q > >	fbc_,
		const multi1d< LatticeColorMatrix > &	u_
	)

inline

Main constructor.

Definition at line 31 of file eigen_state.h.

References dummy_evals, dummy_evecs, eigen_info_id, fbc, Neig, and u.

◆ EigenConnectState() [2/3]

Chroma::EigenConnectState::EigenConnectState	(	Handle< FermBC< T, P, Q > >	fbc_,
		const multi1d< LatticeColorMatrix > &	u_,
		std::string	eigen_info_id_
	)

inline

Definition at line 43 of file eigen_state.h.

References dummy_evals, dummy_evecs, eigen_info_id, fbc, getEvalues(), Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), Neig, and u.

◆ ~EigenConnectState()

Chroma::EigenConnectState::~EigenConnectState ( )

inline

Definition at line 58 of file eigen_state.h.

◆ EigenConnectState() [3/3]

Chroma::EigenConnectState::EigenConnectState ( )

inlineprotected

Hide default constructor.

Definition at line 131 of file eigen_state.h.

Member Function Documentation

◆ getBC()

const FermBC<T,P,Q>& Chroma::EigenConnectState::getBC ( ) const

inlinevirtual

Return the ferm BC object for this state.

Implements Chroma::FermState< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >.

Definition at line 123 of file eigen_state.h.

References fbc.

◆ getEvalues() [1/2]

multi1d<Real>& Chroma::EigenConnectState::getEvalues ( )

inline

Return the eigenvalues.

Definition at line 65 of file eigen_state.h.

References dummy_evals, eigen_info_id, Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), and Neig.

Referenced by Chroma::OvlapPartFrac4DFermAct::createState(), EigenConnectState(), and getEvalues().

◆ getEvalues() [2/2]

const multi1d<Real>& Chroma::EigenConnectState::getEvalues ( ) const

inline

Return the eigenvalues.

Definition at line 74 of file eigen_state.h.

References dummy_evals, eigen_info_id, getEvalues(), Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), and Neig.

◆ getEvectors() [1/2]

multi1d<LatticeFermion>& Chroma::EigenConnectState::getEvectors ( )

inline

Definition at line 82 of file eigen_state.h.

References dummy_evecs, eigen_info_id, Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), and Neig.

Referenced by Chroma::OvlapPartFrac4DFermAct::createState(), and getEvectors().

◆ getEvectors() [2/2]

const multi1d<LatticeFermion>& Chroma::EigenConnectState::getEvectors ( ) const

inline

Definition at line 91 of file eigen_state.h.

References dummy_evecs, eigen_info_id, getEvectors(), Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), and Neig.

◆ getFermBC()

Handle< FermBC<T,P,Q> > Chroma::EigenConnectState::getFermBC ( ) const

inlinevirtual

Return the gauge BC object for this state.

This is to help the optimized linops

Implements Chroma::FermState< LatticeFermion, multi1d< LatticeColorMatrix >, multi1d< LatticeColorMatrix > >.

Definition at line 127 of file eigen_state.h.

References fbc.

◆ getLargest() [1/2]

Real& Chroma::EigenConnectState::getLargest ( )

inline

Definition at line 100 of file eigen_state.h.

References eigen_info_id, Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), and Neig.

Referenced by getLargest().

◆ getLargest() [2/2]

const Real& Chroma::EigenConnectState::getLargest ( ) const

inline

Definition at line 109 of file eigen_state.h.

References eigen_info_id, getLargest(), Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), and Neig.

◆ getLinks()

const multi1d<LatticeColorMatrix>& Chroma::EigenConnectState::getLinks ( ) const

inlinevirtual

Return the coordinates (link fields) needed in constructing linear operators.

Implements Chroma::ConnectState< P, Q >.

Definition at line 60 of file eigen_state.h.

References u.

◆ getNEig()

int Chroma::EigenConnectState::getNEig ( ) const

inline

Definition at line 118 of file eigen_state.h.

References Neig.

Referenced by Chroma::OvlapPartFrac4DFermAct::createState().

◆ operator=()

void Chroma::EigenConnectState::operator= ( const EigenConnectState & )

inlineprotected

Definition at line 132 of file eigen_state.h.

Member Data Documentation

◆ dummy_evals

multi1d<Real> Chroma::EigenConnectState::dummy_evals

private

Definition at line 140 of file eigen_state.h.

Referenced by EigenConnectState(), and getEvalues().

◆ dummy_evecs

multi1d<LatticeFermion> Chroma::EigenConnectState::dummy_evecs

private

Definition at line 139 of file eigen_state.h.

Referenced by EigenConnectState(), and getEvectors().

◆ eigen_info_id

std::string Chroma::EigenConnectState::eigen_info_id

private

Definition at line 137 of file eigen_state.h.

Referenced by EigenConnectState(), getEvalues(), getEvectors(), and getLargest().

◆ fbc

Handle< FermBC<T,P,Q> > Chroma::EigenConnectState::fbc

private

Definition at line 135 of file eigen_state.h.

Referenced by EigenConnectState(), getBC(), and getFermBC().

◆ Neig

int Chroma::EigenConnectState::Neig

private

Definition at line 138 of file eigen_state.h.

Referenced by EigenConnectState(), getEvalues(), getEvectors(), getLargest(), and getNEig().

◆ u

multi1d<LatticeColorMatrix> Chroma::EigenConnectState::u

private

Definition at line 136 of file eigen_state.h.

Referenced by EigenConnectState(), and getLinks().

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

eigen_state.h