Chroma::QuarkSourceSink< T > Class Template Reference

Base class for quark source and sink smearing. More...

#include <quark_source_sink.h>

Inheritance diagram for Chroma::QuarkSourceSink< T >:

Public Member Functions
virtual	~QuarkSourceSink ()
	Virtual destructor to help with cleanup;. More...
virtual void	operator() (T &obj) const =0
	Smear the quark. More...

Protected Member Functions
virtual void	create (multi1d< LatticeColorMatrix > &u, const GroupXML_t &link_smearing)
	Potentially smear the gauge field. More...

Detailed Description

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

Base class for quark source and sink smearing.

Supports creation and application of smearing (with link smearing) on quarks, and potentially displacements. Basically the construction of a "source" or "sink" state on a pre-existing quark object

Definition at line 25 of file quark_source_sink.h.

Constructor & Destructor Documentation

~QuarkSourceSink()

template<typename T >

virtual Chroma::QuarkSourceSink< T >::~QuarkSourceSink ( )

inlinevirtual

Virtual destructor to help with cleanup;.

Definition at line 29 of file quark_source_sink.h.

Member Function Documentation

create()

template<typename T >

virtual void Chroma::QuarkSourceSink< T >::create ( multi1d< LatticeColorMatrix > &  u, const GroupXML_t &  link_smearing  )

inlineprotectedvirtual

Potentially smear the gauge field.

Parameters

u	Gauge field to smear ( Modify )
link_smearing	group holding XML of link smearing ( Read )

Definition at line 44 of file quark_source_sink.h.

References Chroma::GroupXML_t::id, Chroma::SingletonHolder< T, CreationPolicy, LifetimePolicy, ThreadingModel >::Instance(), Chroma::u, and Chroma::GroupXML_t::xml.

Referenced by Chroma::NormShellQuarkSinkSmearingEnv::SinkSmear< T >::SinkSmear(), Chroma::PointQuarkSinkSmearingEnv::SinkSmear< T >::SinkSmear(), Chroma::ShellQuarkSinkSmearingEnv::SinkSmear< T >::SinkSmear(), Chroma::PointQuarkSourceSmearingEnv::SourceSmear< T >::SourceSmear(), and Chroma::ShellQuarkSourceSmearingEnv::SourceSmearing< T >::SourceSmearing().

operator()()

template<typename T >

virtual void Chroma::QuarkSourceSink< T >::operator() ( T &  obj ) const

pure virtual

Smear the quark.

Parameters

obj	Object to source or sink smear ( Modify )

Implemented in Chroma::ShellQuarkSourceSmearingEnv::SourceSmearing< T >, Chroma::PointQuarkSourceSmearingEnv::SourceSmear< T >, Chroma::WallQuarkSinkSmearingEnv::SinkSmear< T >, Chroma::ShellQuarkSinkSmearingEnv::SinkSmear< T >, Chroma::PointQuarkSinkSmearingEnv::SinkSmear< T >, Chroma::NormShellQuarkSinkSmearingEnv::SinkSmear< T >, Chroma::ShellQuarkSourceSmearingEnv::SourceSmearing< T >, Chroma::PointQuarkSourceSmearingEnv::SourceSmear< T >, Chroma::WallQuarkSinkSmearingEnv::SinkSmear< T >, Chroma::ShellQuarkSinkSmearingEnv::SinkSmear< T >, Chroma::PointQuarkSinkSmearingEnv::SinkSmear< T >, and Chroma::NormShellQuarkSinkSmearingEnv::SinkSmear< T >.

---

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

• quark_source_sink.h